git/Documentation/git-sh-i18n--envsubst.txt
Jonathan Nieder 27269fc5f2 Documentation/i18n: quote double-dash for AsciiDoc
As explained in v1.7.3-rc0~13^2 (Work around em-dash handling in newer
AsciiDoc, 2010-08-23), if double dashes in names of commands are not
escaped, AsciiDoc renders them as em dashes.

While fixing that, spell the command name as "git sh-i18n--envsubst"
(2 words) instead of emphasizing the name of the binary (one
hyphenated name) and format it in italics.

The double-dash in the title should be escaped, too, to avoid spurious
em dashes in the header:

  .TH "GIT\-SH\-I18N\(emENVSUB" "1" "06/26/2011" "Git 1\&.7\&.6" "Git Manual"

AsciiDoc 8.6.4 with DocBook XSL 1.76.0-RC1 copes fine and writes
"GIT\-SH\-I18N\-\-ENVSUB" even without this change, which is why it
was missed before.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Acked-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-06-29 14:38:51 -07:00

37 lines
932 B
Plaintext

git-sh-i18n{litdd}envsubst(1)
=============================
NAME
----
git-sh-i18n--envsubst - Git's own envsubst(1) for i18n fallbacks
SYNOPSIS
--------
[verse]
eval_gettext () {
printf "%s" "$1" | (
export PATH $('git sh-i18n{litdd}envsubst' --variables "$1");
'git sh-i18n{litdd}envsubst' "$1"
)
}
DESCRIPTION
-----------
This is not a command the end user would want to run. Ever.
This documentation is meant for people who are studying the
plumbing scripts and/or are writing new ones.
'git sh-i18n{litdd}envsubst' is Git's stripped-down copy of the GNU
`envsubst(1)` program that comes with the GNU gettext package. It's
used internally by linkgit:git-sh-i18n[1] to interpolate the variables
passed to the the `eval_gettext` function.
No promises are made about the interface, or that this
program won't disappear without warning in the next version
of Git. Don't use it.
GIT
---
Part of the linkgit:git[1] suite