X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fjournalctl.xml;h=8883da278c82293050f009345a29364b950ff713;hp=4728d36e1c5ca197ce89528d5f7eb8bb55cf5450;hb=8cb17a6dc88cecfcee3189765031e9e8a1f4106b;hpb=ffa16db02673ffa155ffb2649e72a935a1ff70f5 diff --git a/man/journalctl.xml b/man/journalctl.xml index 4728d36e1..8883da278 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -8,16 +8,16 @@ Copyright 2012 Lennart Poettering systemd is free software; you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. systemd is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Lesser General Public License for more details. - You should have received a copy of the GNU General Public License + You should have received a copy of the GNU Lesser General Public License along with systemd; If not, see . --> @@ -49,28 +49,51 @@ - journalctl OPTIONS MATCH + journalctl OPTIONS MATCHES Description - journalctl may be - used to query the contents of the + journalctl may be used to + query the contents of the systemd1 - journal. + journal as written by + systemd-journald.service8. - If called without parameter will show the full + If called without parameter it 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. See + 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, + referring to the components of a structured journal + entry. See systemd.journal-fields7 - for a list of well-known fields. + for a list of well-known fields. If multiple matches + 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 + field, then they are automatically matched as + 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 + 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. Similar, 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 @@ -91,8 +114,8 @@ - + Prints a short help text and exits. @@ -108,13 +131,20 @@ - Do not pipe output into a - pager. - + Do not pipe output into a + pager. + + + + + + Show all (printable) fields in + full. + - + Show all fields in full, even if they include unprintable @@ -123,26 +153,44 @@ - + - Show only most recent - journal entries, and continously print + 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 won't 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. @@ -155,17 +203,27 @@ - + + + + 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 @@ -175,15 +233,32 @@ is very similar but shows monotonic timestamps instead of wallclock timestamps. verbose - shows the full structered entry items + shows the full structured entry items with all - fiels. export + fields. export 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 @@ -191,21 +266,183 @@ - + + + + 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 inaccessable system + message regarding inaccessible system journals when run as normal user. - - + + + + Show entries + interleaved from all available + journals, including remote + ones. + + + + + + + Show data only from + current boot. This will add a match + for _BOOT_ID= for + the current boot ID of the + 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. + + + + + + + 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. + + + + + + + + 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. + + + + + - Show only locally - generated messages. + 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. + + + + + + + Takes a + directory path as argument. If + specified journalctl will operate on the + specified journal directory instead of + the default runtime and system journal + paths. @@ -224,6 +461,93 @@ 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. + + + + + + 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. + + + + + + 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. + + @@ -237,7 +561,7 @@ Environment - + $SYSTEMD_PAGER Pager to use when @@ -250,10 +574,50 @@ + + Examples + + Without arguments all collected logs are shown + unfiltered: + + journalctl + + 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: + + journalctl _SYSTEMD_UNIT=avahi-daemon.service _PID=28097 + + 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 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 + processes): + + 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 + + + See Also systemd1, + systemd-journald.service8, systemctl1, systemd.journal-fields7, journald.conf5