X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Floginctl.xml;h=7a6cc156d365faeecccbf1b6d50175a9a0c9f303;hp=af1d631cf4d4e1e9ccb17e2931415d80ac7ae3ed;hb=17cd091332040b9a3658db9374440fce7805ca54;hpb=18b754d345ecb0b15e369978aaffa72e9814b86a diff --git a/man/loginctl.xml b/man/loginctl.xml index af1d631cf..7a6cc156d 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -8,20 +8,21 @@ Copyright 2010 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 . --> - + loginctl @@ -49,7 +50,10 @@ - loginctl OPTIONS COMMAND NAME + loginctl + OPTIONS + COMMAND + NAME @@ -59,7 +63,7 @@ loginctl may be used to introspect and control the state of the systemd1 - login manager. + login manager systemd-logind.service8. @@ -69,54 +73,58 @@ - - + - Prints a short help - text and exits. + + Do not print the legend, + i.e. the column headers and + the footer. + - + - 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. - + Do not ellipsize + process tree entries. + + @@ -128,50 +136,72 @@ 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 @@ -179,31 +209,32 @@ - 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 - show-session + sessions, followed by the most recent + log data from the journal. 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 @@ -215,7 +246,7 @@ - activate [ID...] + activate ID... Activate one or more sessions. This brings one or more @@ -226,26 +257,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. + - terminate-session [ID...] + lock-sessions + unlock-sessions - Terminates a - session. This kills all processes of - the session and deallocates all - resources attached to the - session. + Activates/deactivates + the screen lock on all current + sessions supporting 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...] + kill-session ID... Send a signal to one or more processes of the session. Use @@ -254,7 +296,9 @@ to select the signal to send. + + User Commands list-users @@ -263,33 +307,34 @@ - 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. 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 @@ -301,39 +346,41 @@ - 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 to select the signal to send. + + Seat Commands list-seats @@ -343,7 +390,7 @@ - seat-status [NAME...] + seat-status NAME... Show terse runtime status information about one or more @@ -356,18 +403,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 @@ -379,22 +426,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. + @@ -403,53 +452,40 @@ 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 systemd1, systemctl1, + systemd-logind.service8, logind.conf5