X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Floginctl.xml;h=13105d4dcda716c10312db886c01f07dde6d865b;hb=49e6fdbf14b35d8840c3b263fd15259624b07818;hp=ba0352cf6100fee0939f26738b73144e97e44125;hpb=56ba3c78ae35065064c4289a0c8e22a81256af20;p=elogind.git
diff --git a/man/loginctl.xml b/man/loginctl.xml
index ba0352cf6..13105d4dc 100644
--- a/man/loginctl.xml
+++ b/man/loginctl.xml
@@ -21,7 +21,7 @@
along with systemd; If not, see .
-->
-
+loginctl
@@ -49,7 +49,10 @@
- loginctl OPTIONSCOMMANDNAME
+ loginctl
+ OPTIONS
+ COMMAND
+ NAME
@@ -69,8 +72,8 @@
-
+ Prints a short help
text and exits.
@@ -84,55 +87,87 @@
-
+
+
+ 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 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.
-
-
@@ -143,45 +178,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
- .
+ 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.
-
-
-
-
-
-
- Acquire privileges via
- PolicyKit before executing the
- operation.
- The following commands are understood:
@@ -194,7 +211,7 @@
- session-status [ID...]
+ session-statusID...Show terse runtime
status information about one or more
@@ -207,18 +224,18 @@
- 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
@@ -230,7 +247,7 @@
- activate [ID...]
+ activateID...Activate one or more
sessions. This brings one or more
@@ -241,12 +258,13 @@
- 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.
+
@@ -255,22 +273,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
@@ -288,7 +306,7 @@
- user-status [USER...]
+ user-statusUSER...Show terse runtime
status information about one or more
@@ -296,25 +314,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-userUSER...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
@@ -326,32 +344,32 @@
- 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
- 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-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
@@ -368,7 +386,7 @@
- seat-status [NAME...]
+ seat-statusNAME...Show terse runtime
status information about one or more
@@ -381,18 +399,18 @@
- show-seat [NAME...]
+ show-seatNAME...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
@@ -404,22 +422,24 @@
- attach [NAME] [DEVICE...]
+ attachNAMEDEVICE...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
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.
+
@@ -428,19 +448,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-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.
@@ -450,7 +470,7 @@
Exit status
- On success 0 is returned, a non-zero failure
+ On success, 0 is returned, a non-zero failure
code otherwise.