Debian Codegraph @

upstream/debian-unstable/man1/loginctl.1

raw
1 '\" t
2 .TH "LOGINCTL" "1" "" "systemd 261~rc3" "loginctl"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 loginctl \- Control the systemd login manager
24 .SH "SYNOPSIS"
25 .HP \w'\fBloginctl\fR\ 'u
26 \fBloginctl\fR [OPTIONS...] {COMMAND} [NAME...]
27 .SH "DESCRIPTION"
28 .PP
29 \fBloginctl\fR
30 may be used to introspect and control the state of the
31 \fBsystemd\fR(1)
32 login manager
33 \fBsystemd-logind.service\fR(8)\&.
34 .SH "COMMANDS"
35 .PP
36 The following commands are understood:
37 .SS "Session Commands"
38 .PP
39 \fBlist\-sessions\fR
40 .RS 4
41 List current sessions\&. The JSON format output can be toggled using
42 \fB\-\-json=\fR
43 or
44 \fB\-j\fR
45 option\&.
46 .RE
47 .PP
48 \fBsession\-status\fR [\fIID\fR\&...]
49 .RS 4
50 Show terse runtime status information about one or more 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\*(Aqs session is shown\&. This function is intended to generate human\-readable output\&. If you are looking for computer\-parsable output, use
51 \fBshow\-session\fR
52 instead\&.
53 .sp
54 Added in version 233\&.
55 .RE
56 .PP
57 \fBshow\-session\fR [\fIID\fR\&...]
58 .RS 4
59 Show properties of one or more sessions or the manager itself\&. If no argument is specified, properties of the manager will be shown\&. If a session ID is specified, properties of the session are shown\&. Specially, if the given ID is
60 "self", the session to which the
61 \fBloginctl\fR
62 process belongs is used\&. If
63 "auto", the current session is used as with
64 "self"
65 if exists, and falls back to the current user\*(Aqs graphical session\&. By default, empty properties are suppressed\&. Use
66 \fB\-\-all\fR
67 to show those too\&. To select specific properties to show, use
68 \fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use
69 \fBsession\-status\fR
70 if you are looking for formatted human\-readable output\&.
71 .sp
72 Added in version 233\&.
73 .RE
74 .PP
75 \fBactivate\fR [\fIID\fR]
76 .RS 4
77 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\&.
78 .sp
79 Added in version 219\&.
80 .RE
81 .PP
82 \fBlock\-session\fR [\fIID\fR\&...], \fBunlock\-session\fR [\fIID\fR\&...]
83 .RS 4
84 Activates/deactivates the screen lock on one or more 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\&.
85 .sp
86 Added in version 233\&.
87 .RE
88 .PP
89 \fBlock\-sessions\fR, \fBunlock\-sessions\fR
90 .RS 4
91 Activates/deactivates the screen lock on all current sessions supporting it\&.
92 .sp
93 Added in version 188\&.
94 .RE
95 .PP
96 \fBterminate\-session\fR \fIID\fR\&...
97 .RS 4
98 Terminates a session\&. This kills all processes of the session and deallocates all resources attached to the session\&. If the argument is specified as empty string the session invoking the command is terminated\&.
99 .sp
100 Added in version 233\&.
101 .RE
102 .PP
103 \fBkill\-session\fR \fIID\fR\&...
104 .RS 4
105 Send a signal to one or more processes of the session\&. Use
106 \fB\-\-kill\-whom=\fR
107 to select which process to kill\&. Use
108 \fB\-\-signal=\fR
109 to select the signal to send\&. If the argument is specified as empty string the signal is sent to the session invoking the command\&.
110 .sp
111 Added in version 233\&.
112 .RE
113 .SS "User Commands"
114 .PP
115 \fBlist\-users\fR
116 .RS 4
117 List currently logged in users\&. The JSON format output can be toggled using
118 \fB\-\-json=\fR
119 or
120 \fB\-j\fR
121 option\&.
122 .RE
123 .PP
124 \fBuser\-status\fR [\fIUSER\fR\&...]
125 .RS 4
126 Show terse runtime status information about one or more 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 is shown for the user of the session of the caller\&. This function is intended to generate human\-readable output\&. If you are looking for computer\-parsable output, use
127 \fBshow\-user\fR
128 instead\&.
129 .sp
130 Added in version 233\&.
131 .RE
132 .PP
133 \fBshow\-user\fR [\fIUSER\fR\&...]
134 .RS 4
135 Show properties of one or more users or the manager itself\&. If no argument is specified, properties of the manager will be shown\&. If a user is specified, properties of the user are shown\&. By default, empty properties are suppressed\&. Use
136 \fB\-\-all\fR
137 to show those too\&. To select specific properties to show, use
138 \fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use
139 \fBuser\-status\fR
140 if you are looking for formatted human\-readable output\&.
141 .sp
142 Added in version 233\&.
143 .RE
144 .PP
145 \fBenable\-linger\fR [\fIUSER\fR\&...], \fBdisable\-linger\fR [\fIUSER\fR\&...]
146 .RS 4
147 Enable/disable user lingering for one or more users\&. If 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\&. 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\&.
148 .sp
149 See also
150 \fIKillUserProcesses=\fR
151 setting in
152 \fBlogind.conf\fR(5)\&.
153 .sp
154 Added in version 233\&.
155 .RE
156 .PP
157 \fBterminate\-user\fR \fIUSER\fR\&...
158 .RS 4
159 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\&. If the argument is specified as empty string the sessions of the user invoking the command are terminated\&.
160 .sp
161 Added in version 233\&.
162 .RE
163 .PP
164 \fBkill\-user\fR \fIUSER\fR\&...
165 .RS 4
166 Send a signal to all processes of a user\&. Use
167 \fB\-\-signal=\fR
168 to select the signal to send\&. If the argument is specified as empty string the signal is sent to the sessions of the user invoking the command\&.
169 .sp
170 Added in version 233\&.
171 .RE
172 .SS "Seat Commands"
173 .PP
174 \fBlist\-seats\fR
175 .RS 4
176 List currently available seats on the local system\&. The JSON format output can be toggled using
177 \fB\-\-json=\fR
178 or
179 \fB\-j\fR
180 option\&.
181 .RE
182 .PP
183 \fBseat\-status\fR [\fINAME\fR\&...]
184 .RS 4
185 Show terse runtime status information about one or more seats\&. Takes one or more seat names as parameters\&. If no seat names are passed the status of the caller\*(Aqs session\*(Aqs seat is shown\&. This function is intended to generate human\-readable output\&. If you are looking for computer\-parsable output, use
186 \fBshow\-seat\fR
187 instead\&.
188 .sp
189 Added in version 233\&.
190 .RE
191 .PP
192 \fBshow\-seat\fR [\fINAME\fR\&...]
193 .RS 4
194 Show properties of one or more seats or the manager itself\&. If no argument is specified, properties of the manager will be shown\&. If a seat is specified, properties of the seat are shown\&. By default, empty properties are suppressed\&. Use
195 \fB\-\-all\fR
196 to show those too\&. To select specific properties to show, use
197 \fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use
198 \fBseat\-status\fR
199 if you are looking for formatted human\-readable output\&.
200 .sp
201 Added in version 233\&.
202 .RE
203 .PP
204 \fBattach\fR \fINAME\fR \fIDEVICE\fR\&...
205 .RS 4
206 Persistently attach one or more devices to a seat\&. The devices should be specified via device paths in the
207 /sys/
208 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\(enz, A\(enZ, 0\(en9,
209 "\-"
210 and
211 "_"
212 and must be prefixed with
213 "seat"\&. To drop assignment of a device to a specific seat, just reassign it to a different seat, or use
214 \fBflush\-devices\fR\&.
215 .sp
216 Added in version 233\&.
217 .RE
218 .PP
219 \fBflush\-devices\fR
220 .RS 4
221 Removes all device assignments previously created with
222 \fBattach\fR\&. After this call, only automatically generated seats will remain, and all seat hardware is assigned to them\&.
223 .RE
224 .PP
225 \fBterminate\-seat\fR \fINAME\fR\&...
226 .RS 4
227 Terminates all sessions on a seat\&. This kills all processes of all sessions on the seat and deallocates all runtime resources attached to them\&.
228 .sp
229 Added in version 233\&.
230 .RE
231 .SH "OPTIONS"
232 .PP
233 The following options are understood:
234 .PP
235 \fB\-p\fR, \fB\-\-property=\fR
236 .RS 4
237 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
238 "Sessions"\&. If specified more than once, all properties with the specified names are shown\&.
239 .RE
240 .PP
241 \fB\-\-value\fR
242 .RS 4
243 When showing session/user/seat properties, only print the value, and skip the property name and
244 "="\&.
245 .sp
246 Added in version 230\&.
247 .RE
248 .PP
249 \fB\-a\fR, \fB\-\-all\fR
250 .RS 4
251 When showing session/user/seat properties, show all properties regardless of whether they are set or not\&.
252 .RE
253 .PP
254 \fB\-l\fR, \fB\-\-full\fR
255 .RS 4
256 Do not ellipsize process tree entries\&.
257 .sp
258 Added in version 198\&.
259 .RE
260 .PP
261 \fB\-\-kill\-whom=\fR
262 .RS 4
263 When used with
264 \fBkill\-session\fR, choose which processes to kill\&. Takes one of
265 "leader"
266 or
267 "all", to select whether to kill only the leader process of the session or all processes of the session\&. If omitted, defaults to
268 \fBall\fR\&.
269 .sp
270 Added in version 252\&.
271 .RE
272 .PP
273 \fB\-s\fR, \fB\-\-signal=\fR
274 .RS 4
275 When used with
276 \fBkill\-session\fR
277 or
278 \fBkill\-user\fR, choose which signal to send to selected processes\&. Must be one of the well known signal specifiers, such as
279 \fBSIGTERM\fR,
280 \fBSIGINT\fR
281 or
282 \fBSIGSTOP\fR\&. If omitted, defaults to
283 \fBSIGTERM\fR\&.
284 .sp
285 The special value
286 "help"
287 will list the known values and the program will exit immediately, and the special value
288 "list"
289 will list known values along with the numerical signal numbers and the program will exit immediately\&.
290 .RE
291 .PP
292 \fB\-n\fR, \fB\-\-lines=\fR
293 .RS 4
294 When used with
295 \fBuser\-status\fR
296 and
297 \fBsession\-status\fR, controls the number of journal lines to show, counting from the most recent ones\&. Takes a positive integer argument\&. Defaults to 10\&.
298 .sp
299 Added in version 219\&.
300 .RE
301 .PP
302 \fB\-o\fR, \fB\-\-output=\fR
303 .RS 4
304 When used with
305 \fBuser\-status\fR
306 and
307 \fBsession\-status\fR, controls the formatting of the journal entries that are shown\&. For the available choices, see
308 \fBjournalctl\fR(1)\&. Defaults to
309 "short"\&.
310 .sp
311 Added in version 219\&.
312 .RE
313 .PP
314 \fB\-H\fR, \fB\-\-host=\fR
315 .RS 4
316 Execute the operation remotely\&. Specify a hostname, or a username and hostname separated by
317 "@", to connect to\&. The hostname may optionally be suffixed by a port ssh is listening on, separated by
318 ":", and then a container name, separated by
319 "/", 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
320 \fBmachinectl \-H \fR\fB\fIHOST\fR\fR\&. Put IPv6 addresses in brackets\&.
321 .RE
322 .PP
323 \fB\-M\fR, \fB\-\-machine=\fR
324 .RS 4
325 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
326 "@"
327 character\&. If the special string
328 "\&.host"
329 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\*(Aqs user bus:
330 "\-\-user \-\-machine=lennart@\&.host")\&. If the
331 "@"
332 syntax is not used, the connection is made as root user\&. If the
333 "@"
334 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
335 "\&.host"
336 are implied\&.
337 .RE
338 .PP
339 \fB\-\-no\-ask\-password\fR
340 .RS 4
341 Do not query the user for authentication for privileged operations\&.
342 .RE
343 .PP
344 \fB\-\-no\-pager\fR
345 .RS 4
346 Do not pipe output into a pager\&.
347 .RE
348 .PP
349 \fB\-\-no\-legend\fR
350 .RS 4
351 Do not print the legend, i\&.e\&. column headers and the footer with hints\&.
352 .RE
353 .PP
354 \fB\-\-json=\fR\fB\fIMODE\fR\fR
355 .RS 4
356 Shows output formatted as JSON\&. Expects one of
357 "short"
358 (for the shortest possible output without any redundant whitespace or line breaks),
359 "pretty"
360 (for a pretty version of the same, with indentation and line breaks) or
361 "off"
362 (to turn off JSON output, the default)\&.
363 .RE
364 .PP
365 \fB\-j\fR
366 .RS 4
367 Equivalent to
368 \fB\-\-json=pretty\fR
369 if running on a terminal, and
370 \fB\-\-json=short\fR
371 otherwise\&.
372 .RE
373 .PP
374 \fB\-h\fR, \fB\-\-help\fR
375 .RS 4
376 Print a short help text and exit\&.
377 .RE
378 .PP
379 \fB\-\-version\fR
380 .RS 4
381 Print a short version string and exit\&.
382 .RE
383 .SH "EXIT STATUS"
384 .PP
385 On success, 0 is returned, a non\-zero failure code otherwise\&.
386 .SH "EXAMPLES"
387 .PP
388 \fBExample\ \&1.\ \&Querying user status\fR
389 .sp
390 .if n \{\
391 .RS 4
392 .\}
393 .nf
394 $ loginctl user\-status
395 fatima (1005)
396 Since: Sat 2016\-04\-09 14:23:31 EDT; 54min ago
397 State: active
398 Sessions: 5 *3
399 Unit: user\-1005\&.slice
400 ├─user@1005\&.service
401 \&...
402 ├─session\-3\&.scope
403 \&...
404 └─session\-5\&.scope
405 ├─3473 login \-\- fatima
406 └─3515 \-zsh
407
408 Apr 09 14:40:30 laptop login[2325]: pam_unix(login:session):
409 session opened for user fatima by LOGIN(uid=0)
410 Apr 09 14:40:30 laptop login[2325]: LOGIN ON tty3 BY fatima
411 .fi
412 .if n \{\
413 .RE
414 .\}
415 .PP
416 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\&.
417 .SH "ENVIRONMENT"
418 .PP
419 \fI$SYSTEMD_LOG_LEVEL\fR
420 .RS 4
421 The maximum log level of emitted messages (messages with a higher log level, i\&.e\&. less important ones, will be suppressed)\&. Takes a comma\-separated list of values\&. A value may be either one of (in order of decreasing importance)
422 \fBemerg\fR,
423 \fBalert\fR,
424 \fBcrit\fR,
425 \fBerr\fR,
426 \fBwarning\fR,
427 \fBnotice\fR,
428 \fBinfo\fR,
429 \fBdebug\fR, or an integer in the range 0\&...7\&. See
430 \fBsyslog\fR(3)
431 for more information\&. Each value may optionally be prefixed with one of
432 \fBconsole\fR,
433 \fBsyslog\fR,
434 \fBkmsg\fR
435 or
436 \fBjournal\fR
437 followed by a colon to set the maximum log level for that specific log target (e\&.g\&.
438 \fBSYSTEMD_LOG_LEVEL=debug,console:info\fR
439 specifies to log at debug level except when logging to the console which should be at info level)\&. Note that the global maximum log level takes priority over any per target maximum log levels\&.
440 .RE
441 .PP
442 \fI$SYSTEMD_LOG_COLOR\fR
443 .RS 4
444 A boolean\&. If true, messages written to the tty will be colored according to priority\&.
445 .sp
446 This setting is only useful when messages are written directly to the terminal, because
447 \fBjournalctl\fR(1)
448 and other tools that display logs will color messages based on the log level on their own\&.
449 .RE
450 .PP
451 \fI$SYSTEMD_LOG_TIME\fR
452 .RS 4
453 A boolean\&. If true, console log messages will be prefixed with a timestamp\&.
454 .sp
455 This setting is only useful when messages are written directly to the terminal or a file, because
456 \fBjournalctl\fR(1)
457 and other tools that display logs will attach timestamps based on the entry metadata on their own\&.
458 .RE
459 .PP
460 \fI$SYSTEMD_LOG_LOCATION\fR
461 .RS 4
462 A boolean\&. If true, messages will be prefixed with a filename and line number in the source code where the message originates\&.
463 .sp
464 Note that the log location is often attached as metadata to journal entries anyway\&. Including it directly in the message text can nevertheless be convenient when debugging programs\&.
465 .RE
466 .PP
467 \fI$SYSTEMD_LOG_TID\fR
468 .RS 4
469 A boolean\&. If true, messages will be prefixed with the current numerical thread ID (TID)\&.
470 .sp
471 Note that the this information is attached as metadata to journal entries anyway\&. Including it directly in the message text can nevertheless be convenient when debugging programs\&.
472 .RE
473 .PP
474 \fI$SYSTEMD_LOG_TARGET\fR
475 .RS 4
476 The destination for log messages\&. One of
477 \fBconsole\fR
478 (log to the attached tty),
479 \fBconsole\-prefixed\fR
480 (log to the attached tty but with prefixes encoding the log level and "facility", see
481 \fBsyslog\fR(3),
482 \fBkmsg\fR
483 (log to the kernel circular log buffer),
484 \fBjournal\fR
485 (log to the journal),
486 \fBjournal\-or\-kmsg\fR
487 (log to the journal if available, and to kmsg otherwise),
488 \fBauto\fR
489 (determine the appropriate log target automatically, the default),
490 \fBnull\fR
491 (disable log output)\&.
492 .RE
493 .PP
494 \fI$SYSTEMD_LOG_RATELIMIT_KMSG\fR
495 .RS 4
496 Whether to ratelimit kmsg or not\&. Takes a boolean\&. Defaults to
497 "true"\&. If disabled, systemd will not ratelimit messages written to kmsg\&.
498 .RE
499 .PP
500 \fI$SYSTEMD_PAGER\fR, \fI$PAGER\fR
501 .RS 4
502 Pager to use when
503 \fB\-\-no\-pager\fR
504 is not given\&.
505 \fI$SYSTEMD_PAGER\fR
506 is used if set; otherwise
507 \fI$PAGER\fR
508 is used\&. If neither
509 \fI$SYSTEMD_PAGER\fR
510 nor
511 \fI$PAGER\fR
512 are set, a set of well\-known pager implementations is tried in turn, including
513 \fBless\fR(1)
514 and
515 \fBmore\fR(1), until one is found\&. If no pager implementation is discovered, no pager is invoked\&. Setting those environment variables to an empty string or the value
516 "cat"
517 is equivalent to passing
518 \fB\-\-no\-pager\fR\&.
519 .sp
520 Note: if
521 \fI$SYSTEMD_PAGERSECURE\fR
522 is not set,
523 \fI$SYSTEMD_PAGER\fR
524 and
525 \fI$PAGER\fR
526 can only be used to disable the pager (with
527 "cat"
528 or
529 ""), and are otherwise ignored\&.
530 .RE
531 .PP
532 \fI$SYSTEMD_LESS\fR
533 .RS 4
534 Override the options passed to
535 \fBless\fR
536 (by default
537 "FRSXMK")\&.
538 .sp
539 Users might want to change two options in particular:
540 .PP
541 \fBK\fR
542 .RS 4
543 This option instructs the pager to exit immediately when
544 Ctrl+C
545 is pressed\&. To allow
546 \fBless\fR
547 to handle
548 Ctrl+C
549 itself to switch back to the pager command prompt, unset this option\&.
550 .sp
551 If the value of
552 \fI$SYSTEMD_LESS\fR
553 does not include
554 "K", and the pager that is invoked is
555 \fBless\fR,
556 Ctrl+C
557 will be ignored by the executable, and needs to be handled by the pager\&.
558 .RE
559 .PP
560 \fBX\fR
561 .RS 4
562 This option instructs the pager to not send termcap initialization and deinitialization strings to the terminal\&. It is set by default to allow command output to remain visible in the terminal even after the pager exits\&. Nevertheless, this prevents some pager functionality from working, in particular paged output cannot be scrolled with the mouse\&.
563 .RE
564 .sp
565 Note that setting the regular
566 \fI$LESS\fR
567 environment variable has no effect for
568 \fBless\fR
569 invocations by systemd tools\&.
570 .sp
571 See
572 \fBless\fR(1)
573 for more discussion\&.
574 .RE
575 .PP
576 \fI$SYSTEMD_LESSCHARSET\fR
577 .RS 4
578 Override the charset passed to
579 \fBless\fR
580 (by default
581 "utf\-8", if the invoking terminal is determined to be UTF\-8 compatible)\&.
582 .sp
583 Note that setting the regular
584 \fI$LESSCHARSET\fR
585 environment variable has no effect for
586 \fBless\fR
587 invocations by systemd tools\&.
588 .RE
589 .PP
590 \fI$SYSTEMD_PAGERSECURE\fR
591 .RS 4
592 Common pager commands like
593 \fBless\fR(1), in addition to "paging", i\&.e\&. scrolling through the output, support opening of or writing to other files and running arbitrary shell commands\&. When commands are invoked with elevated privileges, for example under
594 \fBsudo\fR(8)
595 or
596 \fBpkexec\fR(1), the pager becomes a security boundary\&. Care must be taken that only programs with strictly limited functionality are used as pagers, and unintended interactive features like opening or creation of new files or starting of subprocesses are not allowed\&. "Secure mode" for the pager may be enabled as described below,
597 \fIif the pager supports that\fR
598 (most pagers are not written in a way that takes this into consideration)\&. It is recommended to either explicitly enable "secure mode" or to completely disable the pager using
599 \fB\-\-no\-pager\fR
600 or
601 \fIPAGER=cat\fR
602 when allowing untrusted users to execute commands with elevated privileges\&.
603 .sp
604 This option takes a boolean argument\&. When set to true, the "secure mode" of the pager is enabled\&. In "secure mode",
605 \fBLESSSECURE=1\fR
606 will be set when invoking the pager, which instructs the pager to disable commands that open or create new files or start new subprocesses\&. Currently only
607 \fBless\fR(1)
608 is known to understand this variable and implement "secure mode"\&.
609 .sp
610 When set to false, no limitation is placed on the pager\&. Setting
611 \fISYSTEMD_PAGERSECURE=0\fR
612 or not removing it from the inherited environment may allow the user to invoke arbitrary commands\&.
613 .sp
614 When
615 \fI$SYSTEMD_PAGERSECURE\fR
616 is not set, systemd tools attempt to automatically figure out if "secure mode" should be enabled and whether the pager supports it\&. "Secure mode" is enabled if the effective UID is not the same as the owner of the login session, see
617 \fBgeteuid\fR(2)
618 and
619 \fBsd_pid_get_owner_uid\fR(3), or when running under
620 \fBsudo\fR(8)
621 or similar tools (\fI$SUDO_UID\fR
622 is set
623 \&\s-2\u[1]\d\s+2)\&. In those cases,
624 \fISYSTEMD_PAGERSECURE=1\fR
625 will be set and pagers which are not known to implement "secure mode" will not be used at all\&. Note that this autodetection only covers the most common mechanisms to elevate privileges and is intended as convenience\&. It is recommended to explicitly set
626 \fI$SYSTEMD_PAGERSECURE\fR
627 or disable the pager\&.
628 .sp
629 Note that if the
630 \fI$SYSTEMD_PAGER\fR
631 or
632 \fI$PAGER\fR
633 variables are to be honoured, other than to disable the pager,
634 \fI$SYSTEMD_PAGERSECURE\fR
635 must be set too\&.
636 .RE
637 .PP
638 \fI$SYSTEMD_COLORS\fR
639 .RS 4
640 Takes a boolean argument, or a special value\&. By default (unset),
641 \fBsystemd\fR
642 and related utilities will use colors in their output if possible\&. If
643 \fI$COLORTERM\fR
644 is set to
645 "truecolor"
646 or
647 "24bit", 24\-bit colors will be enabled, 256 colors otherwise, unless
648 \fI$NO_COLOR\fR
649 or
650 \fI$TERM\fR
651 indicates colors are disabled\&.
652 .PP
653 \fBtrue\fR
654 .RS 4
655 Same as unset, except that
656 \fI$NO_COLOR\fR
657 is ignored\&.
658 .RE
659 .PP
660 \fBfalse\fR
661 .RS 4
662 The output will be monochrome\&.
663 .RE
664 .PP
665 "16", "256", "24bit"
666 .RS 4
667 Always use the base 16 ANSI colors, 256 colors, or 24 bit color, respectively\&.
668 .RE
669 .PP
670 "auto\-16", "auto\-256", "auto\-24bit"
671 .RS 4
672 Use the given quantity of colours, subject to
673 \fI$TERM\fR, and what the console is connected to\&.
674 .RE
675 .RE
676 .PP
677 \fI$SYSTEMD_URLIFY\fR
678 .RS 4
679 The value must be a boolean\&. Controls whether clickable links should be generated in the output for terminal emulators supporting this\&. This can be specified to override the decision that
680 \fBsystemd\fR
681 makes based on
682 \fI$TERM\fR
683 and other conditions\&.
684 .RE
685 .SH "SEE ALSO"
686 .PP
687 \fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd-logind.service\fR(8), \fBlogind.conf\fR(5)
688 .SH "NOTES"
689 .IP " 1." 4
690 It is recommended for other tools to set and check
691 \fI$SUDO_UID\fR
692 as appropriate, treating it is a common interface.
693