From 169c4f65131fbc7bcb51e7d5487a715cdcd0e0eb Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 26 Mar 2012 20:58:47 +0200 Subject: journalctl,loginctl: drop systemd- prefix in binary names MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let's make things a bit easier to type, drop the systemd- prefix for journalctl and loginctl, but provide the old names for compat. All systemd binaries are hence now prefixed with "systemd-" with the exception of the three primary user interface binaries: systemctl loginctl journalctl For those three we do provide systemd-xyz names as well, via symlinks: systemd-systemctl → systemctl systemd-loginctl → loginctl systemd-journalctl → journalctl We do this only for the *primary* user tools, in order to avoid unnecessary namespace problems. That means tools like systemd-notify stay the way they are. --- man/journalctl.xml | 253 +++++++++++++++++++++++ man/loginctl.xml | 458 ++++++++++++++++++++++++++++++++++++++++++ man/systemctl.xml | 7 +- man/systemd-journalctl.xml | 252 ----------------------- man/systemd-journald.conf.xml | 2 +- man/systemd-loginctl.xml | 457 ----------------------------------------- man/systemd-logind.conf.xml | 2 +- man/systemd.exec.xml | 3 +- 8 files changed, 719 insertions(+), 715 deletions(-) create mode 100644 man/journalctl.xml create mode 100644 man/loginctl.xml delete mode 100644 man/systemd-journalctl.xml delete mode 100644 man/systemd-loginctl.xml (limited to 'man') diff --git a/man/journalctl.xml b/man/journalctl.xml new file mode 100644 index 0000000000..c4d2a7e0e8 --- /dev/null +++ b/man/journalctl.xml @@ -0,0 +1,253 @@ + + + + + + + + + journalctl + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + journalctl + 1 + + + + journalctl + systemd-journalctl + Query the systemd journal + + + + + journalctl OPTIONS MATCH + + + + + Description + + 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 + journal 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 journal 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/man/loginctl.xml b/man/loginctl.xml new file mode 100644 index 0000000000..be72cc331a --- /dev/null +++ b/man/loginctl.xml @@ -0,0 +1,458 @@ + + + + + + + + + loginctl + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + loginctl + 1 + + + + loginctl + systemd-loginctl + Control the systemd login manager + + + + + loginctl OPTIONS COMMAND NAME + + + + + Description + + loginctl may be used to + introspect and control the state of the + systemd1 + login manager. + + + + Options + + The following options are understood: + + + + + + + Prints a short help + text and exits. + + + + + + Prints a short version + string and exits. + + + + + + + When showing + session/user/ properties, limit + display to certain properties as + specified as argument. If not + specified all set properties are + shown. The argument should be a + property name, such as + Sessions. If + specified more than once all + properties with the specified names + are shown. + + + + + + + When showing + unit/job/manager properties, show all + properties regardless whether they are + set or not. + + + + + + + Do not pipe output into a + pager. + + + + + + When used with + kill-session, + choose which processes to kill. Must + be one of , or + to select whether + to kill only the leader process of the + session or all processes of the + session. If omitted defaults to + . + + + + + + + When used with + kill-session or + kill-user, choose + which signal to send to selected + processes. Must be one of the well + known signal specifiers such as + SIGTERM, SIGINT or SIGSTOP. If omitted + defaults to + . + + + + + + + Execute operation + remotely. Specify a hostname, or + username and hostname separated by @, + to connect to. This will use SSH to + talk to the remote login manager + instance. + + + + + + + Acquire privileges via + PolicyKit before executing the + operation. + + + + The following commands are understood: + + + + list-sessions + + List current sessions. + + + + session-status [ID...] + + Show terse runtime + status information about one or more + sessions. This function is intended to + generate human-readable output. If you + are looking for computer-parsable + output, use + show-session + instead. + + + + show-session [ID...] + + Show properties of one + or more sessions or the manager + itself. If no argument is specified + properties of the manager will be + shown. If a session ID is specified + properties of the session is shown. By + default, empty properties are + suppressed. Use + to show those too. To select specific + properties to show use + . This + command is intended to be used + whenever computer-parsable output is + required. Use + session-status if + you are looking for formatted + human-readable + output. + + + + activate [ID...] + + Activate one or more + sessions. This brings one or more + sessions into the foreground, if + another session is currently in the + foreground on the respective + seat. + + + + lock-session [ID...] + unlock-session [ID...] + + Activates/deactivates + the screen lock on one or more + sessions, if the session supports it. + + + + terminate-session [ID...] + + Terminates a + session. This kills all processes of + the session and deallocates all + resources attached to the + session. + + + + kill-session [ID...] + + Send a signal to one + or more processes of the session. Use + to select + which process to kill. Use + to select + the signal to send. + + + + list-users + + List currently logged + in users. + + + + user-status [USER...] + + Show terse runtime + status information about one or more + logged in users. This function is + intended to generate human-readable + output. If you are looking for + computer-parsable output, use + show-user + instead. Users may be specified by + their usernames or numeric user + IDs. + + + + show-user [USER...] + + Show properties of one + or more users or the manager + itself. If no argument is specified + properties of the manager will be + shown. If a user is specified + properties of the user is shown. By + default, empty properties are + suppressed. Use + to show those too. To select specific + properties to show use + . This + command is intended to be used + whenever computer-parsable output is + required. Use + user-status if + you are looking for formatted + human-readable + output. + + + + enable-linger [USER...] + disable-linger [USER...] + + Enable/disable user + lingering for one or more users. If + enabled for a specific user a user + manager is spawned for him/her at + boot, and kept around after + logouts. This allows users who aren't + logged in to run long-running + services. + + + + terminate-user [USER...] + + Terminates all + sessions of a user. This kills all + processes of all sessions of the user + and deallocates all runtime resources + attached to the + user. + + + + kill-user [USER...] + + Send a signal to all + processes of a user. Use + to select + the signal to send. + + + + list-seats + + List currently + available seats on the local + system. + + + + seat-status [NAME...] + + Show terse runtime + status information about one or more + seats. This function is + intended to generate human-readable + output. If you are looking for + computer-parsable output, use + show-seat + instead. + + + + show-seat [NAME...] + + Show properties of one + or more seats or the manager + itself. If no argument is specified + properties of the manager will be + shown. If a seat is specified + properties of the seat are shown. By + default, empty properties are + suppressed. Use + to show those too. To select specific + properties to show use + . This + command is intended to be used + whenever computer-parsable output is + required. Use + seat-status if you + are looking for formatted + human-readable + output. + + + + attach [NAME] [DEVICE...] + + Attach one or more + devices to a seat. The devices should + be specified via device paths in the + /sys file + system. To create a new seat attach at + least one graphics card to a + previously unused seat names. seat + names may consist only of a-z, A-Z, + 0-9, "-" and "_" and must be prefixed + with "seat". To drop assignment of a + device to a specific seat just + reassign it to a different seat, or + use + flush-devices. + + + + flush-devices + + Removes all device + assignments previously created with + attach. After this + call only automatically generated + seats will remain and all seat + hardware is assigned to + them. + + + + terminate-seat [NAME...] + + Terminates all + sessions on a seat. This kills all + processes of all sessions on a seat and + deallocates all runtime resources + attached to them. + + + + + + + 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-logind.conf5 + + + + diff --git a/man/systemctl.xml b/man/systemctl.xml index c467ed8bf7..ffe0164008 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -44,6 +44,7 @@ systemctl + systemd-systemctl Control the systemd system and service manager @@ -448,7 +449,7 @@ formatting of the journal entries that are shown. For the available choices see - systemd-journalctl1. Defaults + journalctl1. Defaults to short. @@ -1179,8 +1180,8 @@ systemd1, systemadm1, - systemd-journalctl1, - systemd-loginctl1, + journalctl1, + loginctl1, systemd.unit5, systemd.special7, wall1 diff --git a/man/systemd-journalctl.xml b/man/systemd-journalctl.xml deleted file mode 100644 index 1441ecaca1..0000000000 --- a/man/systemd-journalctl.xml +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - - - - 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 - journal 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 journal 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/man/systemd-journald.conf.xml b/man/systemd-journald.conf.xml index f3cd4db260..37dae68b36 100644 --- a/man/systemd-journald.conf.xml +++ b/man/systemd-journald.conf.xml @@ -246,7 +246,7 @@ See Also systemd1, - systemd-journalctl1, + journalctl1, systemd.conf5 diff --git a/man/systemd-loginctl.xml b/man/systemd-loginctl.xml deleted file mode 100644 index 6a282769a3..0000000000 --- a/man/systemd-loginctl.xml +++ /dev/null @@ -1,457 +0,0 @@ - - - - - - - - - systemd-loginctl - systemd - - - - Developer - Lennart - Poettering - lennart@poettering.net - - - - - - systemd-loginctl - 1 - - - - systemd-loginctl - Control the systemd login manager - - - - - systemd-loginctl OPTIONS COMMAND NAME - - - - - Description - - systemd-loginctl may be used to - introspect and control the state of the - systemd1 - login manager. - - - - Options - - The following options are understood: - - - - - - - Prints a short help - text and exits. - - - - - - Prints a short version - string and exits. - - - - - - - When showing - session/user/ properties, limit - display to certain properties as - specified as argument. If not - specified all set properties are - shown. The argument should be a - property name, such as - Sessions. If - specified more than once all - properties with the specified names - are shown. - - - - - - - When showing - unit/job/manager properties, show all - properties regardless whether they are - set or not. - - - - - - - Do not pipe output into a - pager. - - - - - - When used with - kill-session, - choose which processes to kill. Must - be one of , or - to select whether - to kill only the leader process of the - session or all processes of the - session. If omitted defaults to - . - - - - - - - When used with - kill-session or - kill-user, choose - which signal to send to selected - processes. Must be one of the well - known signal specifiers such as - SIGTERM, SIGINT or SIGSTOP. If omitted - defaults to - . - - - - - - - Execute operation - remotely. Specify a hostname, or - username and hostname separated by @, - to connect to. This will use SSH to - talk to the remote login manager - instance. - - - - - - - Acquire privileges via - PolicyKit before executing the - operation. - - - - The following commands are understood: - - - - list-sessions - - List current sessions. - - - - session-status [ID...] - - Show terse runtime - status information about one or more - sessions. This function is intended to - generate human-readable output. If you - are looking for computer-parsable - output, use - show-session - instead. - - - - show-session [ID...] - - Show properties of one - or more sessions or the manager - itself. If no argument is specified - properties of the manager will be - shown. If a session ID is specified - properties of the session is shown. By - default, empty properties are - suppressed. Use - to show those too. To select specific - properties to show use - . This - command is intended to be used - whenever computer-parsable output is - required. Use - session-status if - you are looking for formatted - human-readable - output. - - - - activate [ID...] - - Activate one or more - sessions. This brings one or more - sessions into the foreground, if - another session is currently in the - foreground on the respective - seat. - - - - lock-session [ID...] - unlock-session [ID...] - - Activates/deactivates - the screen lock on one or more - sessions, if the session supports it. - - - - terminate-session [ID...] - - Terminates a - session. This kills all processes of - the session and deallocates all - resources attached to the - session. - - - - kill-session [ID...] - - Send a signal to one - or more processes of the session. Use - to select - which process to kill. Use - to select - the signal to send. - - - - list-users - - List currently logged - in users. - - - - user-status [USER...] - - Show terse runtime - status information about one or more - logged in users. This function is - intended to generate human-readable - output. If you are looking for - computer-parsable output, use - show-user - instead. Users may be specified by - their usernames or numeric user - IDs. - - - - show-user [USER...] - - Show properties of one - or more users or the manager - itself. If no argument is specified - properties of the manager will be - shown. If a user is specified - properties of the user is shown. By - default, empty properties are - suppressed. Use - to show those too. To select specific - properties to show use - . This - command is intended to be used - whenever computer-parsable output is - required. Use - user-status if - you are looking for formatted - human-readable - output. - - - - enable-linger [USER...] - disable-linger [USER...] - - Enable/disable user - lingering for one or more users. If - enabled for a specific user a user - manager is spawned for him/her at - boot, and kept around after - logouts. This allows users who aren't - logged in to run long-running - services. - - - - terminate-user [USER...] - - Terminates all - sessions of a user. This kills all - processes of all sessions of the user - and deallocates all runtime resources - attached to the - user. - - - - kill-user [USER...] - - Send a signal to all - processes of a user. Use - to select - the signal to send. - - - - list-seats - - List currently - available seats on the local - system. - - - - seat-status [NAME...] - - Show terse runtime - status information about one or more - seats. This function is - intended to generate human-readable - output. If you are looking for - computer-parsable output, use - show-seat - instead. - - - - show-seat [NAME...] - - Show properties of one - or more seats or the manager - itself. If no argument is specified - properties of the manager will be - shown. If a seat is specified - properties of the seat are shown. By - default, empty properties are - suppressed. Use - to show those too. To select specific - properties to show use - . This - command is intended to be used - whenever computer-parsable output is - required. Use - seat-status if you - are looking for formatted - human-readable - output. - - - - attach [NAME] [DEVICE...] - - Attach one or more - devices to a seat. The devices should - be specified via device paths in the - /sys file - system. To create a new seat attach at - least one graphics card to a - previously unused seat names. seat - names may consist only of a-z, A-Z, - 0-9, "-" and "_" and must be prefixed - with "seat". To drop assignment of a - device to a specific seat just - reassign it to a different seat, or - use - flush-devices. - - - - flush-devices - - Removes all device - assignments previously created with - attach. After this - call only automatically generated - seats will remain and all seat - hardware is assigned to - them. - - - - terminate-seat [NAME...] - - Terminates all - sessions on a seat. This kills all - processes of all sessions on a seat and - deallocates all runtime resources - attached to them. - - - - - - - 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-logind.conf5 - - - - diff --git a/man/systemd-logind.conf.xml b/man/systemd-logind.conf.xml index 4b0281503e..27c11c2904 100644 --- a/man/systemd-logind.conf.xml +++ b/man/systemd-logind.conf.xml @@ -167,7 +167,7 @@ See Also systemd1, - systemd-loginctl1, + loginctl1, systemd.conf5 diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index ac0f89fb85..e6f49c9fd0 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -397,7 +397,7 @@ dmesg1. connects it with the journal which is accessible via - systemd-journalctl1 + journalctl1 (Note that everything that is written to syslog or kmsg is implicitly stored in the journal as well, those options @@ -1094,6 +1094,7 @@ systemd1, systemctl8, + journalctl8, systemd.unit5, systemd.service5, systemd.socket5, -- cgit v1.2.3-54-g00ecf