diff options
| author | Lennart Poettering <lennart@poettering.net> | 2012-11-15 23:03:31 +0100 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2012-11-15 23:09:07 +0100 |
| commit | d4205751d4643c272059a3728045929dd0e5e800 (patch) | |
| tree | c9931806e99d42789fc5ce3fc03e17285b9bb208 /man | |
| parent | 59f432ea6d6d441d0af7c76c37e80730c8df473a (diff) | |
journal: implement message catalog
The message catalog can be used to attach short help texts to log lines,
keyed by their MESSAGE_ID= fields. This is useful to help the
administrator understand the context and cause of a message, find
possible solutions and find further related documentation.
Since this is keyed off MESSAGE_ID= this will only work for native
journal messages.
The message catalog supports i18n, and is useful to augment english
language system messages with explanations in the local language.
This commit only includes short explanatory messages for a few example
message IDs, we'll add more complete documentation for the relevant
systemd messages later on.
Diffstat (limited to 'man')
| -rw-r--r-- | man/journalctl.xml | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/man/journalctl.xml b/man/journalctl.xml index 026bb22940..e7fff0c9dc 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -233,6 +233,25 @@ </varlistentry> <varlistentry> + <term><option>--catalog</option></term> + <term><option>-x</option></term> + + <listitem><para>Augment log lines with + explanation texts from the message + catalog. This will add explanatory + help texts to log messages in the + output where this is available. These + short help texts will explain the + context of an error or log event, + possible solutions, as well as + pointers to support forums, developer + documentation and any other relevant + manuals. Note that help texts are not + available for all messages but only + for selected ones.</para></listitem> + </varlistentry> + + <varlistentry> <term><option>--quiet</option></term> <term><option>-q</option></term> @@ -405,6 +424,26 @@ </varlistentry> <varlistentry> + <term><option>--list-catalog</option></term> + + <listitem><para>List the contents of + the message catalog, as table of + message IDs plus their short + description strings.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--update-catalog</option></term> + + <listitem><para>Update the message + catalog index. This command needs to + be executed each time new catalog + files are installed, removed or + updated to rebuild the binary catalog + index.</para></listitem> + </varlistentry> + + <varlistentry> <term><option>--setup-keys</option></term> <listitem><para>Instead of showing |