X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Floginctl.xml;h=5dd64e743bb3ec48e5893a23d5d1fea97ba1da08;hb=352e209804c70b991feededc0a45762929840ace;hp=f10ca030c904897fd6410aa6e34f8d51feb29d38;hpb=e9dd9f9547350c7dc0473583b5c2228dc8f0ab76;p=elogind.git
diff --git a/man/loginctl.xml b/man/loginctl.xml
index f10ca030c..5dd64e743 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 OPTIONSCOMMANDNAME
+ loginctl
+ OPTIONS
+ COMMAND
+ NAME
@@ -69,18 +73,21 @@
-
-
+
- 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.
@@ -88,14 +95,14 @@
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.
@@ -105,8 +112,8 @@
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.
@@ -114,26 +121,11 @@
- Do not ellipsize cgroup
- members.
+ Do not ellipsize
+ process tree entries.
-
-
-
- Do not pipe output into a
- pager.
-
-
-
-
-
- Don't query the user
- for authentication for privileged
- operations.
-
-
@@ -158,36 +150,58 @@
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
- .
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+ CommandsThe following commands are understood:
-
+ Session Commands
+
list-sessions
@@ -195,31 +209,36 @@
- session-status [ID...]
+ session-statusID...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-sessionID...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
@@ -231,23 +250,31 @@
- 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.
+ activateID
+
+ 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-sessionID...
+ unlock-sessionID...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.
+
@@ -256,22 +283,22 @@
Activates/deactivates
the screen lock on all current
- sessions supporting
- it.
+ sessions supporting it.
+
- terminate-session [ID...]
+ terminate-sessionID...
- 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-sessionID...Send a signal to one
or more processes of the session. Use
@@ -280,7 +307,9 @@
to select
the signal to send.
+
+ User Commandslist-users
@@ -289,22 +318,27 @@
- user-status [USER...]
+ user-statusUSER...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-userUSER...Show properties of one
or more users or the manager
@@ -315,7 +349,7 @@
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
@@ -327,39 +361,45 @@
- enable-linger [USER...]
- disable-linger [USER...]
+ enable-lingerUSER...
+ disable-lingerUSER...Enable/disable user
lingering for one or more users. If
enabled for a specific user, a user
- manager is spawned for him/her at
+ manager is spawned for the user at
boot and kept around after
- logouts. This allows users who aren't
+ 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-userUSER...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-userUSER...Send a signal to all
processes of a user. Use
to select
the signal to send.
+
+ Seat Commandslist-seats
@@ -369,12 +409,15 @@
- seat-status [NAME...]
+ seat-statusNAME...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
@@ -382,7 +425,7 @@
- show-seat [NAME...]
+ show-seatNAME...Show properties of one
or more seats or the manager
@@ -405,7 +448,7 @@
- attach [NAME] [DEVICE...]
+ attachNAMEDEVICE...Persistently attach
one or more devices to a seat. The
@@ -415,12 +458,14 @@
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.
+
@@ -436,40 +481,26 @@
- terminate-seat [NAME...]
+ terminate-seatNAME...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