From 2af777ba966fcaefb02e87524583917726a470a1 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 16 Mar 2012 00:50:52 +0100 Subject: [PATCH] man: document systemd-journalctl(1) --- Makefile.am | 3 +- man/systemd-journalctl.xml | 252 +++++++++++++++++++++++++++++++++++++ src/journal/journalctl.c | 2 +- 3 files changed, 255 insertions(+), 2 deletions(-) create mode 100644 man/systemd-journalctl.xml diff --git a/Makefile.am b/Makefile.am index 0b2660ae..ea342bc8 100644 --- a/Makefile.am +++ b/Makefile.am @@ -694,7 +694,8 @@ MANPAGES = \ man/systemd-ask-password.1 \ man/systemd-cat.1 \ man/systemd-machine-id-setup.1 \ - man/systemd-journald.conf.5 + man/systemd-journald.conf.5 \ + man/systemd-journalctl.1 MANPAGES_ALIAS = \ man/reboot.8 \ diff --git a/man/systemd-journalctl.xml b/man/systemd-journalctl.xml new file mode 100644 index 00000000..ff3bb3d0 --- /dev/null +++ b/man/systemd-journalctl.xml @@ -0,0 +1,252 @@ + + + + + + + + + systemd-journalctl + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-journalctl + 1 + + + + systemd-journalctl + Query the systemd journal + + + + + systemd-journalctl OPTIONS MATCH + + + + + Description + + systemd-journalctl may be + used to query the contents of the + systemd1 + journal. + + If called without parameter will show the full + contents of the journal, starting with the oldest + entry collected. + + If a match argument is passed the output is + filtered accordingly. A match is in the format + FIELD=VALUE, + e.g. _SYSTEMD_UNIT=httpd.service. + + Output is interleaved from all accessible + journal files, whether they are rotated or currently + being written, and regardless whether they belong to the + system itself or are accessible user journals. + + All users are granted access to their private + per-user journals. However, by default only root and + users who are members of the adm + group get access to the system journal and the + journals of other users. + + + + Options + + The following options are understood: + + + + + + + Prints a short help + text and exits. + + + + + + Prints a short version + string and exits. + + + + + + Do not pipe output into a + pager. + + + + + + + Show all fields in + full, even if they include unprintable + characters or are very + long. + + + + + + + Show only most recent + entries, and continously print new + entries as they are appended to the + journal. + + + + + + + Controls the number of + journal lines to show, counting from + the most recent ones. Takes a positive + integer argument. In follow mode + defaults to 10, otherwise is unset + thus not limiting how many lines are + shown. + + + + + + Show all stored output + lines, even in follow mode. Undoes the + effect of + . + + + + + + + Controls the + formatting of the entries that are + shown. Takes one of + short, + short-monotonic, + verbose, + export, + json, + cat. short + is the default and generates an output + that is mostly identical to the + formatting of classic syslog log + files, showing one line per journal + entry. short-monotonic + is very similar but shows monotonic + timestamps instead of wallclock + timestamps. verbose + shows the full structered entry items + with all + fiels. export + serializes the journal into a binary + (but mostly text-based) stream + suitable for backups and network + transfer. json + formats entries as JSON data + structures. cat + generates a very terse output only + showing the actual message of each + journal entry with no meta data, not + even a timestamp. + + + + + + + Suppresses any warning + message regarding inaccessable system + journals when run as normal + user. + + + + + + Instead of showing + journal contents generate a new 128 + bit ID suitable for identifying + messages. This is intended for usage + by developers who need a new + identifier for a new message they + introduce and want to make + recognizable. Will print the new ID in + three different formats which can be + copied into source code or + similar. + + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + Environment + + + + $SYSTEMD_PAGER + Pager to use when + is not given; + overrides $PAGER. Setting + this to an empty string or the value + cat is equivalent to passing + . + + + + + + See Also + + systemd1, + systemctl1, + systemd-journald.conf5 + + + + diff --git a/src/journal/journalctl.c b/src/journal/journalctl.c index d5560723..f90b2dda 100644 --- a/src/journal/journalctl.c +++ b/src/journal/journalctl.c @@ -54,7 +54,7 @@ static int help(void) { " -h --help Show this help\n" " --version Show package version\n" " --no-pager Do not pipe output into a pager\n" - " -a --all Show all properties, including long and unprintable\n" + " -a --all Show all fields, including long and unprintable\n" " -f --follow Follow journal\n" " -n --lines=INTEGER Journal entries to show\n" " --no-tail Show all lines, even in follow mode\n" -- 2.39.5