X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Floginctl.xml;h=38f099edcce81c791d285d5e2ec5b917d5bb0ae0;hp=33a369e0da2aaddb80a7de583db6c5198419c32c;hb=b67f562c9cac44bd78b24f5aae78a1797c5d4182;hpb=af3bccd6d87759f0b146bf5980bdd56144d70c7e diff --git a/man/loginctl.xml b/man/loginctl.xml index 33a369e0d..38f099edc 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,8 +73,8 @@ - + Prints a short help text and exits. @@ -84,46 +88,85 @@ - + + + Do not pipe output into a + pager. + + + + + + + Do not print the legend, + i.e. the column headers and + the footer. + + + + + + + Do not query the user + for authentication for privileged + operations. + + + + + + + Execute the 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. + + + + + + + Execute the operation on a + local container. Specify a container + name to connect to. + + + + 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,45 +179,27 @@ 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 - . - - - - - - - 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. + known signal specifiers, such as + SIGTERM, + SIGINT or + SIGSTOP. If + omitted, defaults to + SIGTERM. - - - - - Acquire privileges via - PolicyKit before executing the - operation. - The following commands are understood: @@ -187,7 +212,7 @@ - session-status [ID...] + session-status ID... Show terse runtime status information about one or more @@ -200,18 +225,18 @@ - 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,7 +248,7 @@ - activate [ID...] + activate ID... Activate one or more sessions. This brings one or more @@ -234,26 +259,37 @@ - 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. + + + + + lock-sessions + unlock-sessions + + 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 @@ -271,7 +307,7 @@ - user-status [USER...] + user-status USER... Show terse runtime status information about one or more @@ -279,25 +315,25 @@ 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 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 @@ -309,32 +345,32 @@ - 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. - 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 @@ -351,7 +387,7 @@ - seat-status [NAME...] + seat-status NAME... Show terse runtime status information about one or more @@ -364,18 +400,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 @@ -387,22 +423,24 @@ - 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 + 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, + attach at least one graphics card to a + 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. + @@ -411,19 +449,19 @@ 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. @@ -433,25 +471,11 @@ 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