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