updated git doc
[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-sh-i18n.xml
blobe42858bc8553500e93e083f174c7537383645df9
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-sh-i18n(1)">\r
5 <articleinfo>\r
6     <title>git-sh-i18n(1)</title>\r
7 <indexterm>\r
8 <primary>git-sh-i18n(1)</primary>\r
9 </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-sh-i18n - Git's i18n setup code for shell scripts</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>. "$(git --exec-path)/git-sh-i18n"</emphasis></literallayout>\r
19 </blockquote>\r
20 </simplesect>\r
21 <simplesect id="_description">\r
22 <title>DESCRIPTION</title>\r
23 <simpara>This is not a command the end user would want to run.  Ever.\r
24 This documentation is meant for people who are studying the\r
25 Porcelain-ish scripts and/or are writing new ones.</simpara>\r
26 <simpara>The 'git sh-i18n scriptlet is designed to be sourced (using\r
27 <emphasis>.</emphasis>) by Git's porcelain programs implemented in shell\r
28 script. It provides wrappers for the GNU <emphasis>gettext</emphasis> and\r
29 <emphasis>eval_gettext</emphasis> functions accessible through the <emphasis>gettext.sh</emphasis>\r
30 script, and provides pass-through fallbacks on systems\r
31 without GNU gettext.</simpara>\r
32 </simplesect>\r
33 <simplesect id="_functions">\r
34 <title>FUNCTIONS</title>\r
35 <variablelist>\r
36 <varlistentry>\r
37 <term>\r
38 gettext\r
39 </term>\r
40 <listitem>\r
41 <simpara>\r
42         Currently a dummy fall-through function implemented as a wrapper\r
43         around <emphasis>printf(1)</emphasis>. Will be replaced by a real gettext\r
44         implementation in a later version.\r
45 </simpara>\r
46 </listitem>\r
47 </varlistentry>\r
48 <varlistentry>\r
49 <term>\r
50 eval_gettext\r
51 </term>\r
52 <listitem>\r
53 <simpara>\r
54         Currently a dummy fall-through function implemented as a wrapper\r
55         around <emphasis>printf(1)</emphasis> with variables expanded by the\r
56         <xref linkend="git-sh-i18n&#45;&#45;envsubst(1)" /> helper. Will be replaced by a\r
57         real gettext implementation in a later version.\r
58 </simpara>\r
59 </listitem>\r
60 </varlistentry>\r
61 </variablelist>\r
62 </simplesect>\r
63 <simplesect id="_git">\r
64 <title>GIT</title>\r
65 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
66 </simplesect>\r
67 </article>\r