Merge branch 'jc/conf-var-doc'
[git] / Documentation / git-sh-i18n.txt
1 git-sh-i18n(1)
2 ==============
3
4 NAME
5 ----
6 git-sh-i18n - Git's i18n setup code for shell scripts
7
8 SYNOPSIS
9 --------
10 [verse]
11 '. "$(git --exec-path)/git-sh-i18n"'
12
13 DESCRIPTION
14 -----------
15
16 This is not a command the end user would want to run.  Ever.
17 This documentation is meant for people who are studying the
18 Porcelain-ish scripts and/or are writing new ones.
19
20 The 'git sh-i18n scriptlet is designed to be sourced (using
21 `.`) by Git's porcelain programs implemented in shell
22 script. It provides wrappers for the GNU `gettext` and
23 `eval_gettext` functions accessible through the `gettext.sh`
24 script, and provides pass-through fallbacks on systems
25 without GNU gettext.
26
27 FUNCTIONS
28 ---------
29
30 gettext::
31         Currently a dummy fall-through function implemented as a wrapper
32         around `printf(1)`. Will be replaced by a real gettext
33         implementation in a later version.
34
35 eval_gettext::
36         Currently a dummy fall-through function implemented as a wrapper
37         around `printf(1)` with variables expanded by the
38         linkgit:git-sh-i18n{litdd}envsubst[1] helper. Will be replaced by a
39         real gettext implementation in a later version.
40
41 GIT
42 ---
43 Part of the linkgit:git[1] suite