X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Floginctl.xml;h=11ed0ee46049cc98c106cb8fa1b7d1f037b8f61c;hp=7d9d8a1e2c7473136c9159cb6dabe615b6664ff7;hb=df99a9ef5bb7a89b92ccfb103b2f3e7046c62ef5;hpb=57ccf9073531e09890257d70d3176fec43da29a7 diff --git a/man/loginctl.xml b/man/loginctl.xml index 7d9d8a1e2..11ed0ee46 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -21,7 +21,8 @@ along with systemd; If not, see . --> - + loginctl @@ -49,7 +50,10 @@ - loginctl OPTIONS COMMAND NAME + loginctl + OPTIONS + COMMAND + NAME @@ -69,61 +73,47 @@ - - - - Prints a short help - text and exits. - - - - + - Prints a short version - string and exits. + Do not query the user + for authentication for privileged + operations. - + When showing - session/user properties, limit + session/user/seat properties, limit display to certain properties as specified as argument. If not - specified all set properties are + specified, all set properties are shown. The argument should be a property name, such as Sessions. If - specified more than once all + 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 + session/user/seat properties, show all + properties regardless of whether they are set or not. - - - - - Do not pipe output into a - pager. - - - + + - Don't query the user - for authentication for privileged - operations. + Do not ellipsize + process tree entries. + @@ -136,50 +126,73 @@ to select whether to kill only the leader process of the session or all processes of the - session. If omitted defaults to + 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 - . + known signal specifiers, such as + SIGTERM, + SIGINT or + SIGSTOP. If + omitted, defaults to + SIGTERM. - - - - 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. + + + + When used with + user-status and + session-status, + controls the number of journal lines + to show, counting from the most recent + ones. Takes a positive integer + argument. Defaults to 10. + - - + + - Acquire privileges via - PolicyKit before executing the - operation. + When used with + user-status and + session-status, + controls the formatting of the journal + entries that are shown. For the + available choices, see + journalctl1. + Defaults to + short. + + + + + + + + + + + + Commands The following commands are understood: - + Session Commands + list-sessions @@ -187,31 +200,36 @@ - session-status [ID...] + 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 + sessions, followed by the most recent + log data from the journal. Takes one + or more session identifiers as + parameters. If no session identifiers + are passed the status of the caller's + session is shown. 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-session ID... Show properties of one or more sessions or the manager - itself. If no argument is specified + 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 + shown. If a session ID is specified, + properties of the session are shown. By default, empty properties are suppressed. Use to show those too. To select specific - properties to show use + properties to show, use . This command is intended to be used whenever computer-parsable output is @@ -223,45 +241,55 @@ - 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. + activate ID + + Activate a + session. This brings a session into + the foreground, if another session is + currently in the foreground on the + respective seat. Takes a session + identifier as argument. If no argument + is specified the session of the caller + is put into + foreground. - lock-session [ID...] - unlock-session [ID...] + lock-session ID... + unlock-session ID... Activates/deactivates the screen lock on one or more - sessions, if the session supports it. + sessions, if the session supports + it. Takes one or more session + identifiers as arguments. If no + argument is specified the session of + the caller is locked/unlocked. + lock-sessions + unlock-sessions - Activate the screen - lock on all current sessions - supporting it. + Activates/deactivates + the screen lock on all current + sessions supporting it. + - terminate-session [ID...] + terminate-session ID... - Terminates a - session. This kills all processes of - the session and deallocates all - resources attached to the - session. + Terminates a session. + This kills all processes of the + session and deallocates all resources + attached to the session. + - kill-session [ID...] + kill-session ID... Send a signal to one or more processes of the session. Use @@ -270,7 +298,9 @@ to select the signal to send. + + User Commands list-users @@ -279,33 +309,38 @@ - user-status [USER...] + 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. + logged in users, followed by the most + recent log data from the + journal. Takes one or more user names + or numeric user IDs as parameters. If + no parameters are passed the status of + the caller's user is shown. 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-user USER... Show properties of one or more users or the manager - itself. If no argument is specified + 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 + shown. If a user is specified, + properties of the user are shown. By default, empty properties are suppressed. Use to show those too. To select specific - properties to show use + properties to show, use . This command is intended to be used whenever computer-parsable output is @@ -317,39 +352,45 @@ - enable-linger [USER...] - disable-linger [USER...] + 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 + enabled for a specific user, a user + manager is spawned for the user at + boot and kept around after + logouts. This allows users who are not logged in to run long-running - services. + services. Takes one or more user names + or numeric UIDs as argument. If no + argument is specified enables/disables + lingering for the user of the session + of the caller. - terminate-user [USER...] + 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. + attached to the user. + - kill-user [USER...] + kill-user USER... Send a signal to all processes of a user. Use to select the signal to send. + + Seat Commands list-seats @@ -359,12 +400,15 @@ - seat-status [NAME...] + seat-status NAME... Show terse runtime status information about one or more - seats. This function is - intended to generate human-readable + seats. Takes one or more seat names as + parameters. If no seat names are + passed the status of the caller's + session's seat is shown. This function + is intended to generate human-readable output. If you are looking for computer-parsable output, use show-seat @@ -372,18 +416,18 @@ - show-seat [NAME...] + show-seat NAME... Show properties of one or more seats or the manager - itself. If no argument is specified + itself. If no argument is specified, properties of the manager will be - shown. If a seat is specified + 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 + properties to show, use . This command is intended to be used whenever computer-parsable output is @@ -395,22 +439,24 @@ - attach [NAME] [DEVICE...] + attach NAME DEVICE... Persistently 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 + file system. To create a new seat, attach at least one graphics card to a - previously unused seat name. seat + previously unused seat name. 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. + 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. + @@ -419,47 +465,33 @@ Removes all device assignments previously created with attach. After this - call only automatically generated - seats will remain and all seat + call, only automatically generated + seats will remain, and all seat hardware is assigned to them. - terminate-seat [NAME...] + terminate-seat NAME... Terminates all sessions on a seat. This kills all - processes of all sessions on a seat and - deallocates all runtime resources + processes of all sessions on the seat + and deallocates all runtime resources attached to them. - + 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 - is not given; - overrides $PAGER. Setting - this to an empty string or the value - cat is equivalent to passing - . - - - + See Also