{ "content": [ { "type": "text", "text": "# loginctl (man)\n\n## NAME\n\nloginctl - Control the systemd login manager\n\n## SYNOPSIS\n\nloginctl [OPTIONS...] {COMMAND} [NAME...]\n\n## DESCRIPTION\n\nloginctl may be used to introspect and control the state of the systemd(1) login manager\nsystemd-logind.service(8).\n\n## TLDR\n\n> Manage the systemd login manager.\n\n- Print all current sessions:\n `loginctl`\n- Print all properties of a specific session:\n `loginctl show-session {{session_id}} {{-a|--all}}`\n- Print all properties of a specific user:\n `loginctl show-user {{username}}`\n- Print a specific property of a user:\n `loginctl show-user {{username}} {{-p|--property}} {{property_name}}`\n- Execute a `loginctl` operation on a remote host:\n `loginctl list-users {{-H|--host}} {{hostname}}`\n- Log a user out on all of their sessions:\n `loginctl terminate-user {{username}}`\n- Display help:\n `loginctl {{-h|--help}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **COMMANDS** (7 subsections)\n- **OPTIONS** (15 subsections)\n- **EXIT STATUS**\n- **EXAMPLES** (1 subsections)\n- **ENVIRONMENT**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "loginctl", "section": "", "mode": "man", "summary": "loginctl - Control the systemd login manager", "synopsis": "loginctl [OPTIONS...] {COMMAND} [NAME...]", "tldr_summary": "Manage the systemd login manager.", "tldr_examples": [ { "description": "Print all current sessions", "command": "loginctl" }, { "description": "Print all properties of a specific session", "command": "loginctl show-session {{session_id}} {{-a|--all}}" }, { "description": "Print all properties of a specific user", "command": "loginctl show-user {{username}}" }, { "description": "Print a specific property of a user", "command": "loginctl show-user {{username}} {{-p|--property}} {{property_name}}" }, { "description": "Execute a `loginctl` operation on a remote host", "command": "loginctl list-users {{-H|--host}} {{hostname}}" }, { "description": "Log a user out on all of their sessions", "command": "loginctl terminate-user {{username}}" }, { "description": "Display help", "command": "loginctl {{-h|--help}}" } ], "tldr_source": "official", "flags": [ { "flag": "", "long": "--no-ask-password", "arg": null, "description": "Do not query the user for authentication for privileged operations." }, { "flag": "-p", "long": null, "arg": null, "description": "When showing session/user/seat properties, limit display to certain properties as specified as argument. If not specified, all set properties are shown. The argument should be a property name, such as \"Sessions\". If specified more than once, all properties with the specified names are shown." }, { "flag": "", "long": "--value", "arg": null, "description": "When showing session/user/seat properties, only print the value, and skip the property name and \"=\"." }, { "flag": "-a", "long": "--all", "arg": null, "description": "When showing session/user/seat properties, show all properties regardless of whether they are set or not." }, { "flag": "-l", "long": "--full", "arg": null, "description": "Do not ellipsize process tree entries." }, { "flag": "", "long": null, "arg": null, "description": "When used with kill-session, choose which processes to kill. Must be one of leader, or all to select whether to kill only the leader process of the session or all processes of the session. If omitted, defaults to all." }, { "flag": "-s", "long": null, "arg": null, "description": "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 SIGTERM. The special value \"help\" will list the known values and the program will exit immediately, and the special value \"list\" will list known values along with the numerical signal numbers and the program will exit immediately." }, { "flag": "-n", "long": null, "arg": null, "description": "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." }, { "flag": "-o", "long": null, "arg": null, "description": "When used with user-status and session-status, controls the formatting of the journal entries that are shown. For the available choices, see journalctl(1). Defaults to \"short\"." }, { "flag": "-H", "long": null, "arg": null, "description": "Execute the operation remotely. Specify a hostname, or a username and hostname separated by \"@\", to connect to. The hostname may optionally be suffixed by a port ssh is listening on, separated by \":\", and then a container name, separated by \"/\", which connects directly to a specific container on the specified host. This will use SSH to talk to the remote machine manager instance. Container names may be enumerated with machinectl -H HOST. Put IPv6 addresses in brackets." }, { "flag": "-M", "long": null, "arg": null, "description": "Execute operation on a local container. Specify a container name to connect to, optionally prefixed by a user name to connect as and a separating \"@\" character. If the special string \".host\" is used in place of the container name, a connection to the local system is made (which is useful to connect to a specific user's user bus: \"--user --machine=lennart@.host\"). If the \"@\" syntax is not used, the connection is made as root user. If the \"@\" syntax is used either the left hand side or the right hand side may be omitted (but not both) in which case the local user name and \".host\" are implied." }, { "flag": "", "long": "--no-pager", "arg": null, "description": "Do not pipe output into a pager." }, { "flag": "", "long": "--no-legend", "arg": null, "description": "Do not print the legend, i.e. column headers and the footer with hints." }, { "flag": "-h", "long": "--help", "arg": null, "description": "Print a short help text and exit." }, { "flag": "", "long": "--version", "arg": null, "description": "Print a short version string and exit." } ], "examples": [ "$ loginctl user-status", "fatima (1005)", "Since: Sat 2016-04-09 14:23:31 EDT; 54min ago", "State: active", "Sessions: 5 *3", "Unit: user-1005.slice", "├─user@1005.service", "...", "├─session-3.scope", "...", "└─session-5.scope", "├─3473 login -- fatima", "└─3515 -zsh", "Apr 09 14:40:30 laptop login[2325]: pamunix(login:session):", "session opened for user fatima by LOGIN(uid=0)", "Apr 09 14:40:30 laptop login[2325]: LOGIN ON tty3 BY fatima", "There are two sessions, 3 and 5. Session 3 is a graphical session, marked with a star. The", "tree of processing including the two corresponding scope units and the user manager unit are", "shown." ], "see_also": [ { "name": "systemd", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/systemd/1/json" }, { "name": "systemctl", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/systemctl/1/json" }, { "name": "systemd-logind.service", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/systemd-logind.service/8/json" }, { "name": "logind.conf", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/logind.conf/5/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 3, "subsections": [] }, { "name": "COMMANDS", "lines": 2, "subsections": [ { "name": "Session Commands", "lines": 1 }, { "name": "list-sessions", "lines": 40 }, { "name": "User Commands", "lines": 1 }, { "name": "list-users", "lines": 36 }, { "name": "Seat Commands", "lines": 1 }, { "name": "list-seats", "lines": 23 }, { "name": "flush-devices", "lines": 7 } ] }, { "name": "OPTIONS", "lines": 2, "subsections": [ { "name": "--no-ask-password", "lines": 2, "long": "--no-ask-password" }, { "name": "-p --property=", "lines": 5, "flag": "-p" }, { "name": "--value", "lines": 3, "long": "--value" }, { "name": "-a --all", "lines": 3, "flag": "-a", "long": "--all" }, { "name": "-l --full", "lines": 2, "flag": "-l", "long": "--full" }, { "name": "--kill-who=", "lines": 4 }, { "name": "-s --signal=", "lines": 8, "flag": "-s" }, { "name": "-n --lines=", "lines": 4, "flag": "-n" }, { "name": "-o --output=", "lines": 4, "flag": "-o" }, { "name": "-H --host=", "lines": 7, "flag": "-H" }, { "name": "-M --machine=", "lines": 8, "flag": "-M" }, { "name": "--no-pager", "lines": 2, "long": "--no-pager" }, { "name": "--no-legend", "lines": 2, "long": "--no-legend" }, { "name": "-h --help", "lines": 2, "flag": "-h", "long": "--help" }, { "name": "--version", "lines": 2, "long": "--version" } ] }, { "name": "EXIT STATUS", "lines": 2, "subsections": [] }, { "name": "EXAMPLES", "lines": 1, "subsections": [ { "name": "Example 1. Querying user status", "lines": 22 } ] }, { "name": "ENVIRONMENT", "lines": 105, "subsections": [] }, { "name": "SEE ALSO", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "loginctl - Control the systemd login manager\n", "subsections": [] }, "SYNOPSIS": { "content": "loginctl [OPTIONS...] {COMMAND} [NAME...]\n", "subsections": [] }, "DESCRIPTION": { "content": "loginctl may be used to introspect and control the state of the systemd(1) login manager\nsystemd-logind.service(8).\n", "subsections": [] }, "COMMANDS": { "content": "The following commands are understood:\n", "subsections": [ { "name": "Session Commands", "content": "" }, { "name": "list-sessions", "content": "List current sessions.\n\nsession-status [ID...]\nShow terse runtime status information about one or more sessions, followed by the most\nrecent log data from the journal. Takes one or more session identifiers as parameters. If\nno session identifiers are passed, the status of the caller's session is shown. This\nfunction is intended to generate human-readable output. If you are looking for\ncomputer-parsable output, use show-session instead.\n\nshow-session [ID...]\nShow properties of one or more sessions or the manager itself. If no argument is\nspecified, properties of the manager will be shown. If a session ID is specified,\nproperties of the session are shown. By default, empty properties are suppressed. Use\n--all to show those too. To select specific properties to show, use --property=. This\ncommand is intended to be used whenever computer-parsable output is required. Use\nsession-status if you are looking for formatted human-readable output.\n\nactivate [ID]\nActivate a session. This brings a session into the foreground if another session is\ncurrently in the foreground on the respective seat. Takes a session identifier as\nargument. If no argument is specified, the session of the caller is put into foreground.\n\nlock-session [ID...], unlock-session [ID...]\nActivates/deactivates the screen lock on one or more sessions, if the session supports\nit. Takes one or more session identifiers as arguments. If no argument is specified, the\nsession of the caller is locked/unlocked.\n\nlock-sessions, unlock-sessions\nActivates/deactivates the screen lock on all current sessions supporting it.\n\nterminate-session ID...\nTerminates a session. This kills all processes of the session and deallocates all\nresources attached to the session. If the argument is specified as empty string the\nsession invoking the command is terminated.\n\nkill-session ID...\nSend a signal to one or more processes of the session. Use --kill-who= to select which\nprocess to kill. Use --signal= to select the signal to send. If the argument is specified\nas empty string the signal is sent to the session invoking the command.\n" }, { "name": "User Commands", "content": "" }, { "name": "list-users", "content": "List currently logged in users.\n\nuser-status [USER...]\nShow terse runtime status information about one or more logged in users, followed by the\nmost recent log data from the journal. Takes one or more user names or numeric user IDs\nas parameters. If no parameters are passed, the status is shown for the user of the\nsession of the caller. This function is intended to generate human-readable output. If\nyou are looking for computer-parsable output, use show-user instead.\n\nshow-user [USER...]\nShow properties of one or more users or the manager itself. If no argument is specified,\nproperties of the manager will be shown. If a user is specified, properties of the user\nare shown. By default, empty properties are suppressed. Use --all to show those too. To\nselect specific properties to show, use --property=. This command is intended to be used\nwhenever computer-parsable output is required. Use user-status if you are looking for\nformatted human-readable output.\n\nenable-linger [USER...], disable-linger [USER...]\nEnable/disable user lingering for one or more users. If enabled for a specific user, a\nuser manager is spawned for the user at boot and kept around after logouts. This allows\nusers who are not logged in to run long-running services. Takes one or more user names or\nnumeric UIDs as argument. If no argument is specified, enables/disables lingering for the\nuser of the session of the caller.\n\nSee also KillUserProcesses= setting in logind.conf(5).\n\nterminate-user USER...\nTerminates all sessions of a user. This kills all processes of all sessions of the user\nand deallocates all runtime resources attached to the user. If the argument is specified\nas empty string the sessions of the user invoking the command are terminated.\n\nkill-user USER...\nSend a signal to all processes of a user. Use --signal= to select the signal to send. If\nthe argument is specified as empty string the signal is sent to the sessions of the user\ninvoking the command.\n" }, { "name": "Seat Commands", "content": "" }, { "name": "list-seats", "content": "List currently available seats on the local system.\n\nseat-status [NAME...]\nShow terse runtime status information about one or more seats. Takes one or more seat\nnames as parameters. If no seat names are passed the status of the caller's session's\nseat is shown. This function is intended to generate human-readable output. If you are\nlooking for computer-parsable output, use show-seat instead.\n\nshow-seat [NAME...]\nShow properties of one or more seats or the manager itself. If no argument is specified,\nproperties of the manager will be shown. If a seat is specified, properties of the seat\nare shown. By default, empty properties are suppressed. Use --all to show those too. To\nselect specific properties to show, use --property=. This command is intended to be used\nwhenever computer-parsable output is required. Use seat-status if you are looking for\nformatted human-readable output.\n\nattach NAME DEVICE...\nPersistently attach one or more devices to a seat. The devices should be specified via\ndevice paths in the /sys/ file system. To create a new seat, attach at least one graphics\ncard to a previously unused seat name. Seat names may consist only of a–z, A–Z, 0–9, \"-\"\nand \"\" and must be prefixed with \"seat\". To drop assignment of a device to a specific\nseat, just reassign it to a different seat, or use flush-devices.\n" }, { "name": "flush-devices", "content": "Removes all device assignments previously created with attach. After this call, only\nautomatically generated seats will remain, and all seat hardware is assigned to them.\n\nterminate-seat NAME...\nTerminates all sessions on a seat. This kills all processes of all sessions on the seat\nand deallocates all runtime resources attached to them.\n" } ] }, "OPTIONS": { "content": "The following options are understood:\n", "subsections": [ { "name": "--no-ask-password", "content": "Do not query the user for authentication for privileged operations.\n", "long": "--no-ask-password" }, { "name": "-p --property=", "content": "When showing session/user/seat properties, limit display to certain properties as\nspecified as argument. If not specified, all set properties are shown. The argument\nshould be a property name, such as \"Sessions\". If specified more than once, all\nproperties with the specified names are shown.\n", "flag": "-p" }, { "name": "--value", "content": "When showing session/user/seat properties, only print the value, and skip the property\nname and \"=\".\n", "long": "--value" }, { "name": "-a --all", "content": "When showing session/user/seat properties, show all properties regardless of whether they\nare set or not.\n", "flag": "-a", "long": "--all" }, { "name": "-l --full", "content": "Do not ellipsize process tree entries.\n", "flag": "-l", "long": "--full" }, { "name": "--kill-who=", "content": "When used with kill-session, choose which processes to kill. Must be one of leader, or\nall to select whether to kill only the leader process of the session or all processes of\nthe session. If omitted, defaults to all.\n" }, { "name": "-s --signal=", "content": "When used with kill-session or kill-user, choose which signal to send to selected\nprocesses. Must be one of the well known signal specifiers, such as SIGTERM, SIGINT or\nSIGSTOP. If omitted, defaults to SIGTERM.\n\nThe special value \"help\" will list the known values and the program will exit\nimmediately, and the special value \"list\" will list known values along with the numerical\nsignal numbers and the program will exit immediately.\n", "flag": "-s" }, { "name": "-n --lines=", "content": "When used with user-status and session-status, controls the number of journal lines to\nshow, counting from the most recent ones. Takes a positive integer argument. Defaults to\n10.\n", "flag": "-n" }, { "name": "-o --output=", "content": "When used with user-status and session-status, controls the formatting of the journal\nentries that are shown. For the available choices, see journalctl(1). Defaults to\n\"short\".\n", "flag": "-o" }, { "name": "-H --host=", "content": "Execute the operation remotely. Specify a hostname, or a username and hostname separated\nby \"@\", to connect to. The hostname may optionally be suffixed by a port ssh is listening\non, separated by \":\", and then a container name, separated by \"/\", which connects\ndirectly to a specific container on the specified host. This will use SSH to talk to the\nremote machine manager instance. Container names may be enumerated with machinectl -H\nHOST. Put IPv6 addresses in brackets.\n", "flag": "-H" }, { "name": "-M --machine=", "content": "Execute operation on a local container. Specify a container name to connect to,\noptionally prefixed by a user name to connect as and a separating \"@\" character. If the\nspecial string \".host\" is used in place of the container name, a connection to the local\nsystem is made (which is useful to connect to a specific user's user bus: \"--user\n--machine=lennart@.host\"). If the \"@\" syntax is not used, the connection is made as root\nuser. If the \"@\" syntax is used either the left hand side or the right hand side may be\nomitted (but not both) in which case the local user name and \".host\" are implied.\n", "flag": "-M" }, { "name": "--no-pager", "content": "Do not pipe output into a pager.\n", "long": "--no-pager" }, { "name": "--no-legend", "content": "Do not print the legend, i.e. column headers and the footer with hints.\n", "long": "--no-legend" }, { "name": "-h --help", "content": "Print a short help text and exit.\n", "flag": "-h", "long": "--help" }, { "name": "--version", "content": "Print a short version string and exit.\n", "long": "--version" } ] }, "EXIT STATUS": { "content": "On success, 0 is returned, a non-zero failure code otherwise.\n", "subsections": [] }, "EXAMPLES": { "content": "", "subsections": [ { "name": "Example 1. Querying user status", "content": "$ loginctl user-status\nfatima (1005)\nSince: Sat 2016-04-09 14:23:31 EDT; 54min ago\nState: active\nSessions: 5 *3\nUnit: user-1005.slice\n├─user@1005.service\n...\n├─session-3.scope\n...\n└─session-5.scope\n├─3473 login -- fatima\n└─3515 -zsh\n\nApr 09 14:40:30 laptop login[2325]: pamunix(login:session):\nsession opened for user fatima by LOGIN(uid=0)\nApr 09 14:40:30 laptop login[2325]: LOGIN ON tty3 BY fatima\n\nThere are two sessions, 3 and 5. Session 3 is a graphical session, marked with a star. The\ntree of processing including the two corresponding scope units and the user manager unit are\nshown.\n" } ] }, "ENVIRONMENT": { "content": "$SYSTEMDLOGLEVEL\nThe maximum log level of emitted messages (messages with a higher log level, i.e. less\nimportant ones, will be suppressed). Either one of (in order of decreasing importance)\nemerg, alert, crit, err, warning, notice, info, debug, or an integer in the range 0...7.\nSee syslog(3) for more information.\n\n$SYSTEMDLOGCOLOR\nA boolean. If true, messages written to the tty will be colored according to priority.\n\nThis setting is only useful when messages are written directly to the terminal, because\njournalctl(1) and other tools that display logs will color messages based on the log\nlevel on their own.\n\n$SYSTEMDLOGTIME\nA boolean. If true, console log messages will be prefixed with a timestamp.\n\nThis setting is only useful when messages are written directly to the terminal or a file,\nbecause journalctl(1) and other tools that display logs will attach timestamps based on\nthe entry metadata on their own.\n\n$SYSTEMDLOGLOCATION\nA boolean. If true, messages will be prefixed with a filename and line number in the\nsource code where the message originates.\n\nNote that the log location is often attached as metadata to journal entries anyway.\nIncluding it directly in the message text can nevertheless be convenient when debugging\nprograms.\n\n$SYSTEMDLOGTID\nA boolean. If true, messages will be prefixed with the current numerical thread ID (TID).\n\nNote that the this information is attached as metadata to journal entries anyway.\nIncluding it directly in the message text can nevertheless be convenient when debugging\nprograms.\n\n$SYSTEMDLOGTARGET\nThe destination for log messages. One of console (log to the attached tty),\nconsole-prefixed (log to the attached tty but with prefixes encoding the log level and\n\"facility\", see syslog(3), kmsg (log to the kernel circular log buffer), journal (log to\nthe journal), journal-or-kmsg (log to the journal if available, and to kmsg otherwise),\nauto (determine the appropriate log target automatically, the default), null (disable log\noutput).\n\n$SYSTEMDPAGER\nPager to use when --no-pager is not given; overrides $PAGER. If neither $SYSTEMDPAGER\nnor $PAGER are set, a set of well-known pager implementations are tried in turn,\nincluding less(1) and more(1), until one is found. If no pager implementation is\ndiscovered no pager is invoked. Setting this environment variable to an empty string or\nthe value \"cat\" is equivalent to passing --no-pager.\n\n$SYSTEMDLESS\nOverride the options passed to less (by default \"FRSXMK\").\n\nUsers might want to change two options in particular:\n\nK\nThis option instructs the pager to exit immediately when Ctrl+C is pressed. To allow\nless to handle Ctrl+C itself to switch back to the pager command prompt, unset this\noption.\n\nIf the value of $SYSTEMDLESS does not include \"K\", and the pager that is invoked is\nless, Ctrl+C will be ignored by the executable, and needs to be handled by the pager.\n\nX\nThis option instructs the pager to not send termcap initialization and\ndeinitialization strings to the terminal. It is set by default to allow command\noutput to remain visible in the terminal even after the pager exits. Nevertheless,\nthis prevents some pager functionality from working, in particular paged output\ncannot be scrolled with the mouse.\n\nSee less(1) for more discussion.\n\n$SYSTEMDLESSCHARSET\nOverride the charset passed to less (by default \"utf-8\", if the invoking terminal is\ndetermined to be UTF-8 compatible).\n\n$SYSTEMDPAGERSECURE\nTakes a boolean argument. When true, the \"secure\" mode of the pager is enabled; if false,\ndisabled. If $SYSTEMDPAGERSECURE is not set at all, secure mode is enabled if the\neffective UID is not the same as the owner of the login session, see geteuid(2) and\nsdpidgetowneruid(3). In secure mode, LESSSECURE=1 will be set when invoking the\npager, and the pager shall disable commands that open or create new files or start new\nsubprocesses. When $SYSTEMDPAGERSECURE is not set at all, pagers which are not known to\nimplement secure mode will not be used. (Currently only less(1) implements secure mode.)\n\nNote: when commands are invoked with elevated privileges, for example under sudo(8) or\npkexec(1), care must be taken to ensure that unintended interactive features are not\nenabled. \"Secure\" mode for the pager may be enabled automatically as describe above.\nSetting SYSTEMDPAGERSECURE=0 or not removing it from the inherited environment allows\nthe user to invoke arbitrary commands. Note that if the $SYSTEMDPAGER or $PAGER\nvariables are to be honoured, $SYSTEMDPAGERSECURE must be set too. It might be\nreasonable to completely disable the pager using --no-pager instead.\n\n$SYSTEMDCOLORS\nTakes a boolean argument. When true, systemd and related utilities will use colors in\ntheir output, otherwise the output will be monochrome. Additionally, the variable can\ntake one of the following special values: \"16\", \"256\" to restrict the use of colors to\nthe base 16 or 256 ANSI colors, respectively. This can be specified to override the\nautomatic decision based on $TERM and what the console is connected to.\n\n$SYSTEMDURLIFY\nThe value must be a boolean. Controls whether clickable links should be generated in the\noutput for terminal emulators supporting this. This can be specified to override the\ndecision that systemd makes based on $TERM and other conditions.\n", "subsections": [] }, "SEE ALSO": { "content": "systemd(1), systemctl(1), systemd-logind.service(8), logind.conf(5)\n\n\n\nsystemd 249 LOGINCTL(1)", "subsections": [] } } } }