summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuke Shumaker <LukeShu@sbcglobal.net>2013-11-04 11:31:08 -0500
committerLuke Shumaker <LukeShu@sbcglobal.net>2013-11-04 11:31:08 -0500
commit33715e2d293ebb16b388167085b15647f90b720a (patch)
treebb6226b050d61838473ffc6b394679d6dccd1d4c
parent6a395c595a1aff501f5edc6b726e929476331b56 (diff)
libremessages(1): clarify when gettext is used.
-rw-r--r--src/lib/libremessages.1.ronn8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/lib/libremessages.1.ronn b/src/lib/libremessages.1.ronn
index 970b950..b91a958 100644
--- a/src/lib/libremessages.1.ronn
+++ b/src/lib/libremessages.1.ronn
@@ -51,6 +51,8 @@ the command `help printf` from a Bash shell for more information.
### GENERAL ROUTINES
+Unless otherwise noted, these do not implicitly call `gettext`.
+
* `_` <MESSAGE>:
If `gettext` is available, calls `gettext`, otherwise just prints
the arguments given.
@@ -61,7 +63,7 @@ the command `help printf` from a Bash shell for more information.
* `panic`:
For the times when you can't reasonably continue, similar to
- "assert" in some languages.
+ "assert" in some programming languages.
* `term_title` <MESSAGE>...:
Joins all arguments with whitespace, and sets the terminal title
@@ -72,6 +74,8 @@ the command `help printf` from a Bash shell for more information.
These routines print to standard output, ande are useful for printing
word-wrapped prose.
+For each of these, <MESSAGE> is fed through `gettext` automatically.
+
* `print` <MESSAGE> [<ARGS>...]:
Like `printf`(1), but `gettext`-aware, and automatically prints a
trailing newline.
@@ -102,6 +106,8 @@ These routines print to standard error, and all take arguments in the
same format as `printf`(1), except for `stat_done`, which doesn't take
any arguments.
+For each of these, <MESSAGE> is fed through `gettext` automatically.
+
* `plain` <MESSAGE> [<ARGS>...]:
Prints "plain" message in bold, indented with 4 spaces.