X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fjournalctl.xml;h=0e779b952c0813538ce47af48320eccd5339d858;hp=05c8703d28cea1547695d436a7528c0b559bebf0;hb=a331b5e6d4724365bad9edeb9420c7e26e7f50da;hpb=49f43d5f91a99b23f745726aa351d8f159774357 diff --git a/man/journalctl.xml b/man/journalctl.xml index 05c8703d2..0e779b952 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -49,7 +49,9 @@ - journalctl OPTIONS MATCHES + journalctl + OPTIONS + MATCHES @@ -62,11 +64,11 @@ journal as written by systemd-journald.service8. - If called without parameter will show the full + If called without parameters, it will show the full contents of the journal, starting with the oldest entry collected. - If one or more match arguments are passed the + If one or more match arguments are passed, the output is filtered accordingly. A match is in the format FIELD=VALUE, e.g. _SYSTEMD_UNIT=httpd.service, @@ -74,7 +76,7 @@ entry. See systemd.journal-fields7 for a list of well-known fields. If multiple matches - are specified matching different fields the log + are specified matching different fields, the log entries are filtered by both, i.e. the resulting output will show only entries matching all the specified matches of this kind. If two matches apply to the same @@ -82,20 +84,43 @@ alternatives, i.e. the resulting output will show entries matching any of the specified matches for the same field. Finally, if the character - "+" appears as separate word on the - command line all matches before and after are combined + + appears as separate word on the + command line, all matches before and after are combined in a disjunction (i.e. logical OR). + As shortcuts for a few types of field/value + matches, file paths may be specified. If a file path + refers to an executable file, this is equivalent to an + _EXE= match for the canonicalized + binary path. Similarly, if a path refers to a device + node, this is equivalent to a + _KERNEL_DEVICE= match for the + device. + Output is interleaved from all accessible journal files, whether they are rotated or currently - being written, and regardless whether they belong to the + being written, and regardless of 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 + 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. + + The output is paged through + less by default, and long lines are + "truncated" to screen width. The hidden part can be + viewed by using the left-arrow and right-arrow + keys. Paging can be disabled, see + and section Environment + below. + + When outputing to a tty, lines are colored + according to priority: lines of level ERROR and higher + are colored red, lines of level NOTICE and higher are + highlighted, and other lines are displayed normally. + @@ -105,8 +130,8 @@ - + Prints a short help text and exits. @@ -127,8 +152,16 @@ - + + + + Show all (printable) fields in + full. + + + + Show all fields in full, even if they include unprintable @@ -137,26 +170,44 @@ - + - Show only most recent + Show only the most recent journal entries, and continuously print new entries as they are appended to the journal. - + + + + Immediately jump to + the end of the journal inside the + implied pager tool. This implies + to guarantee + that the pager will not buffer logs of + unbounded size. This may be overridden + with an explicit + with some other numeric value on the + command line. Note that this option is + only supported for the + less1 + pager. + + + + - 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 the most recent + journal events and limit the number of + events shown. If + is used, + this option is implied. The argument, + a positive integer, is optional, and + defaults to 10. @@ -169,21 +220,31 @@ - + + + + Reverse output, so the newest + entries are displayed first. + + + + Controls the - formatting of the journal entries that are - shown. Takes one of + formatting of the journal entries that + are shown. Takes one of short, short-monotonic, verbose, export, json, + json-pretty, + json-sse, cat. short is the default and generates an output that is mostly identical to the - formatting of classic syslog log + formatting of classic syslog files, showing one line per journal entry. short-monotonic is very similar but shows monotonic @@ -195,9 +256,26 @@ serializes the journal into a binary (but mostly text-based) stream suitable for backups and network - transfer. json + transfer (see Journal + Export Format for more + information). json formats entries as JSON data - structures. cat + structures, one per + line (see Journal + JSON Format for more + information). json-pretty + also formats entries as JSON data + structures, but formats them in + multiple lines in order to make them + more readable for + humans. json-sse + also formats entries as JSON data + structures, but wraps them in a format + suitable for Server-Sent + Events. cat generates a very terse output only showing the actual message of each journal entry with no meta data, not @@ -205,8 +283,32 @@ - + + + + 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. For more + information on the message catalog, + please refer to the Message + Catalog Developer + Documentation. + + + + Suppresses any warning message regarding inaccessible system @@ -215,63 +317,389 @@ - - + + + + Show entries + interleaved from all available + journals, including remote + ones. + - Show only locally - generated messages. + + + + + Show messages from the specified + boot ID or from + current boot if no ID + is given. This will add a match for + _BOOT_ID=. + + The argument is a 128 bit ID given in + short or UUID form and optionally followed by + :n which identifies the nth + boot relative to the boot ID given to the left + of :. Supplying a negative + value for n will look for a past boot and a + positive value for a future boot. The boot IDs + are searched for in chronological order. If no + number is provided after :, + -1 is assumed. A value of 0 + is valid and equivalent to omitting + :0. + + Alternatively, the argument may constist + only of :n. In this case, a + positive value will look up the nth boot + starting from the beginning of the jouranl, a + negative value will look up a previous boot + relative to the current boot. :0 + will look for the current boot ID. Thus, + :1 is the first boot found in + the journal, :2 the second + and so on; while :-1 is the + previous boot, :-2 the boot + before that and so on. Omitting a value after + : will look for the previous + boot. - - + + - Show data only from - current boot. + Show only kernel messages. This + implies and adds the match + _TRANSPORT=kernel. + - - + + + + Show messages for the + specified systemd unit. This will add + a match for messages from the unit + (_SYSTEMD_UNIT=) + and additional matches for messages + from systemd and messages about + coredumps for the specified unit. + This parameter can be specified multiple times. + + - Takes an absolute - directory path as argument. If - specified will operate on the - specified journal directory instead of - the default runtime and system journal - paths. + + + + Show messages for the + specified user session unit. This will + add a match for messages from the unit + (_SYSTEMD_USER_UNIT= + and _UID=) and + additional matches for messages from + session systemd and messages about + coredumps for the specified unit. + This parameter can be specified multiple times. + + + + + + + + Filter output by + message priorities or priority + ranges. Takes either a single numeric + or textual log level (i.e. between + 0/emerg and + 7/debug), or a + range of numeric/text log levels in + the form FROM..TO. The log levels are + the usual syslog log levels as + documented in + syslog3, + i.e. emerg (0), + alert (1), + crit (2), + err (3), + warning (4), + notice (5), + info (6), + debug (7). If a + single log level is specified, all + messages with this log level or a + lower (hence more important) log level + are shown. If a range is specified, all + messages within the range are shown, + including both the start and the end + value of the range. This will add + PRIORITY= matches + for the specified + priorities. + + + + + + + Start showing entries + from the location in the journal + specified by the passed + cursor. + + + + + + + Start showing entries + on or newer than the specified date, + or on or older than the specified + date, respectively. Date specifications + should be of the format + 2012-10-30 18:17:16. + If the time part is omitted, + 00:00:00 is assumed. + If only the seconds component is omitted, + :00 is assumed. If the + date component is omitted, the current + day is assumed. Alternatively the strings + yesterday, + today, + tomorrow are + understood, which refer to 00:00:00 of + the day before the current day, the + current day, or the day after the + current day, respectively. now + refers to the current time. Finally, + relative times may be specified, + prefixed with - or + +, referring to + times before or after the current + time, respectively. + + + + + + + Print all possible + data values the specified field can + take in all entries of the + journal. + + + + + + + Show messages from + system services and the kernel (with + ). Show + messages from service of current user + (with ). + If neither is specified, show all + messages that the user can see. + + + + + + + + Takes a directory path + as argument. If specified, journalctl + will operate on the specified journal + directory + DIR instead + of the default runtime and system + journal paths. + + + + + + Takes a file glob as + argument. If specified, journalctl will + operate on the specified journal files + matching GLOB + instead of the default runtime and + system journal paths. May be specified + multiple times, in which case files will + be suitably interleaved. + + + + + + Takes a directory path + as argument. If specified, journalctl + will operate on catalog file hierarchy + underneath the specified directory + instead of the root directory + (e.g. + will create + ROOT/var/lib/systemd/catalog/database). + Instead of showing - journal contents generate a new 128 + 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 + recognizable. This will print the new ID in three different formats which can be copied into source code or similar. + + + + Instead of showing + journal contents, show internal header + information of the journal fields + accessed. + + + + + + Shows the current disk + usage of all + journal files. + + + + + + List the contents of + the message catalog, as table of + message IDs plus their short + description strings. + + If any + ID128s are + specified, only those entries are shown. + + + + + + + + Show the contents of + the message catalog, with entries + separated by a line consisting of two + dashes and the id (the format is the + same as .catalog + files. + + If any + ID128s are + specified, only those entries are shown. + + + + + + + + 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. + + + + + + Instead of showing + journal contents, generate a new key + pair for Forward Secure Sealing + (FSS). This will generate a sealing + key and a verification key. The + sealing key is stored in the journal + data directory and shall remain on the + host. The verification key should be + stored externally. Also see the + option in + journald.conf5 + for details. + + + + + + When --setup-keys is passed and + Forward Secure Sealing has already been set up, + recreate FSS keys. + + + + + + Specifies the change + interval for the sealing key when + generating an FSS key pair with + . Shorter + intervals increase CPU consumption but + shorten the time range of + undetectable journal + alterations. Defaults to + 15min. + + + + + + Check the journal file + for internal consistency. If the + file has been generated with FSS + enabled and the FSS verification key + has been specified with + , + authenticity of the journal file is + verified. + + + + + + Specifies the FSS + verification key to use for the + + operation. + + Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. Environment - + $SYSTEMD_PAGER Pager to use when @@ -287,25 +715,25 @@ Examples - Without arguments all collected logs are shown + Without arguments, all collected logs are shown unfiltered: journalctl - With one match specified all entries with a field matching the expression are shown: + With one match specified, all entries with a field matching the expression are shown: journalctl _SYSTEMD_UNIT=avahi-daemon.service - If two different fields are matched only entries matching both expressions at the same time are shown: + If two different fields are matched, only entries matching both expressions at the same time are shown: journalctl _SYSTEMD_UNIT=avahi-daemon.service _PID=28097 - If two matches refer to the same field all entries matching either expression are shown: + If two matches refer to the same field, all entries matching either expression are shown: journalctl _SYSTEMD_UNIT=avahi-daemon.service _SYSTEMD_UNIT=dbus.service - If the separator "+" is used - two expression may be combined in a logical OR. The + If the separator + is used, + two expressions may be combined in a logical OR. The following will show all messages from the Avahi service process with the PID 28097 plus all messages from the D-Bus service (from any of its @@ -313,6 +741,18 @@ journalctl _SYSTEMD_UNIT=avahi-daemon.service _PID=28097 + _SYSTEMD_UNIT=dbus.service + Show all logs generated by the D-Bus executable: + + journalctl /usr/bin/dbus-daemon + + Show all logs of the kernel device node /dev/sda: + + journalctl /dev/sda + + Show all kernel logs from last boot: + + journalctl -k -b : +