summaryrefslogtreecommitdiffstats
path: root/git-sh-i18n.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junio@kernel.org>2011-05-23 23:06:31 +0000
committerJunio C Hamano <junio@kernel.org>2011-05-23 23:06:31 +0000
commit2a294cdddac356b905bb00d260fbd221d91af595 (patch)
tree7d2d0b207286927bba4e983e2c699cd69217fe3f /git-sh-i18n.txt
parent300d43650761892e5a570d8b4d83433de5052ea8 (diff)
downloadgit-htmldocs-2a294cdddac356b905bb00d260fbd221d91af595.tar.gz
Autogenerated HTML docs for v1.7.5.2-353-g5df3e
Diffstat (limited to 'git-sh-i18n.txt')
-rw-r--r--git-sh-i18n.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/git-sh-i18n.txt b/git-sh-i18n.txt
new file mode 100644
index 000000000..3b1f7ac7b
--- /dev/null
+++ b/git-sh-i18n.txt
@@ -0,0 +1,42 @@
+git-sh-i18n(1)
+==============
+
+NAME
+----
+git-sh-i18n - Git's i18n setup code for shell scripts
+
+SYNOPSIS
+--------
+'. "$(git --exec-path)/git-sh-i18n"'
+
+DESCRIPTION
+-----------
+
+This is not a command the end user would want to run. Ever.
+This documentation is meant for people who are studying the
+Porcelain-ish scripts and/or are writing new ones.
+
+The 'git sh-i18n scriptlet is designed to be sourced (using
+`.`) by Git's porcelain programs implemented in shell
+script. It provides wrappers for the GNU `gettext` and
+`eval_gettext` functions accessible through the `gettext.sh`
+script, and provides pass-through fallbacks on systems
+without GNU gettext.
+
+FUNCTIONS
+---------
+
+gettext::
+ Currently a dummy fall-through function implemented as a wrapper
+ around `printf(1)`. Will be replaced by a real gettext
+ implementation in a later version.
+
+eval_gettext::
+ Currently a dummy fall-through function implemented as a wrapper
+ around `printf(1)` with variables expanded by the
+ linkgit:git-sh-i18n--envsubst[1] helper. Will be replaced by a
+ real gettext implementation in a later version.
+
+GIT
+---
+Part of the linkgit:git[1] suite