summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuke T. Shumaker <lukeshu@parabola.nu>2024-02-20 23:12:45 -0700
committerLuke T. Shumaker <lukeshu@parabola.nu>2024-02-28 00:11:20 -0700
commitd272c8a258bf287747e05311c1c7eb0aa661163e (patch)
treed63cc2aab0ffad3a30404213c9a699ea1511168c
parent39b9e172c9bcd36d4a4017952d386be8e4465545 (diff)
docs: libremessages: Update for changes in makepkg/devtools-parlukeshu/wip
-rw-r--r--src/lib/libremessages.1.ronn29
1 files changed, 22 insertions, 7 deletions
diff --git a/src/lib/libremessages.1.ronn b/src/lib/libremessages.1.ronn
index 9c9377e..6587768 100644
--- a/src/lib/libremessages.1.ronn
+++ b/src/lib/libremessages.1.ronn
@@ -142,6 +142,9 @@ plain `xgettext`(1) will work if given correct flags, but you'll find
it easier to use `librexgettext`(1), which will handle each of these
without any extra flags.
+Informational notifications (these may be silenced by setting `QUIET`
+to a non-zero integer):
+
* `plain` <MESSAGE> [<ARGS>...]:
Prints a "plain" message in bold, indented with 4 spaces.
@@ -151,25 +154,37 @@ without any extra flags.
* `msg2` <MESSAGE> [<ARGS>...]:
Prints a secondary notification.
- * `warning` <MESSAGE> [<ARGS>...]:
- Prints a warning.
-
- * `error` <MESSAGE> [<ARGS>...]:
- Prints an error message.
-
* `stat_busy` <MESSAGE> [<ARGS>...]:
Prints a "working..." type message without a trailing newline.
* `stat_done`:
Prints a "done" type message to terminate `stat_busy`.
+Essential notifications (are *not* silenced by `QUIET`):
+
+ * `ask <MESSAGE> [<ARGS>...]:`
+ Prints a prompt to show to the user. Is *not* silenced by
+ `QUIET`.
+
* `print` <MESSAGE> [<ARGS>...]:
Like `printf`(1), but `gettext`-aware, and automatically prints a
- trailing newline.
+ trailing newline. Is *not* silenced by `QUIET`.
* `term_title` <MESSAGE> [<ARGS>...]:
Sets the terminal title to the specified message.
+Error notifications (are *not* silenced by `QUIET`):
+
+ * `warning` <MESSAGE> [<ARGS>...]:
+ Prints a warning.
+
+ * `error` <MESSAGE> [<ARGS>...]:
+ Prints an error message.
+
+ * `plainerr` <MESSAGE> [<ARGS>...]:
+ Prints continuation of a warning or error message; formatted
+ similarly to `plain`.
+
### TEMPORARY DIRECTORY MANAGEMENT
These are used by devtools, and not used within the rest of