From: Zbigniew Jędrzejewski-Szmek Date: Sun, 28 Feb 2021 11:18:25 +0000 (+0100) Subject: man: rename less-variables→common-variables X-Git-Tag: v248-rc3~92^2~14 X-Git-Url: http://git-history.diyao.me/?a=commitdiff_plain;h=4ef3ca3447d134cdcbe050a820e0b8fe918288cf;p=systemd%2F.git man: rename less-variables→common-variables Some are not about less, e.g. $SYSTEMD_URLIFY. --- diff --git a/man/common-variables.xml b/man/common-variables.xml new file mode 100644 index 0000000000..809a9084a2 --- /dev/null +++ b/man/common-variables.xml @@ -0,0 +1,125 @@ + + + + + + Environment + + + + $SYSTEMD_PAGER + + Pager to use when is not given; overrides + $PAGER. If neither $SYSTEMD_PAGER nor $PAGER are set, a + set of well-known pager implementations are tried in turn, including + less1 and + more1, until one is found. If + no pager implementation is discovered no pager is invoked. Setting this environment variable to an empty string + or the value cat is equivalent to passing . + + + + $SYSTEMD_LESS + + Override the options passed to less (by default + FRSXMK). + + Users might want to change two options in particular: + + + + + + This option instructs the pager to exit immediately when + CtrlC is pressed. To allow + less to handle CtrlC + itself to switch back to the pager command prompt, unset this option. + + If the value of $SYSTEMD_LESS does not include K, + and the pager that is invoked is less, + CtrlC will be ignored by the + executable, and needs to be handled by the pager. + + + + + + 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. + + + + See + less1 + for more discussion. + + + + $SYSTEMD_LESSCHARSET + + Override the charset passed to less (by default utf-8, if + the invoking terminal is determined to be UTF-8 compatible). + + + + $SYSTEMD_PAGERSECURE + + Takes a boolean argument. When true, the "secure" mode of the pager is enabled; if + false, disabled. If $SYSTEMD_PAGERSECURE is not set at all, secure mode is enabled + if the effective UID is not the same as the owner of the login session, see + geteuid2 + and sd_pid_get_owner_uid3. + In secure mode, will be set when invoking the pager, and the pager shall + disable commands that open or create new files or start new subprocesses. When + $SYSTEMD_PAGERSECURE is not set at all, pagers which are not known to implement + secure mode will not be used. (Currently only + less1 + implements secure mode.) + + Note: when commands are invoked with elevated privileges, for example under sudo8 or + pkexec1, care + must be taken to ensure that unintended interactive features are not enabled. "Secure" mode for the + pager may be enabled automatically as describe above. Setting SYSTEMD_PAGERSECURE=0 + or not removing it from the inherited environment allows the user to invoke arbitrary commands. Note + that if the $SYSTEMD_PAGER or $PAGER variables are to be + honoured, $SYSTEMD_PAGERSECURE must be set too. It might be reasonable to completely + disable the pager using instead. + + + + $SYSTEMD_COLORS + + Takes a boolean argument. When true, systemd and related utilities + will use colors in their output, otherwise the output will be monochrome. Additionally, the variable can + take one of the following special values: 16, 256 to restrict the use + of colors to the base 16 or 256 ANSI colors, respectively. This can be specified to override the automatic + decision based on $TERM and what the console is connected to. + + + + + + $SYSTEMD_URLIFY + + 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 + systemd makes based on $TERM and other conditions. + + + + + diff --git a/man/homectl.xml b/man/homectl.xml index 5e8866771e..184bdcf6fd 100644 --- a/man/homectl.xml +++ b/man/homectl.xml @@ -848,7 +848,7 @@ On success, 0 is returned, a non-zero failure code otherwise. - + Examples diff --git a/man/journalctl.xml b/man/journalctl.xml index 379344170d..4be2ed3476 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -992,7 +992,7 @@ code is returned. - + Examples diff --git a/man/less-variables.xml b/man/less-variables.xml deleted file mode 100644 index 809a9084a2..0000000000 --- a/man/less-variables.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Environment - - - - $SYSTEMD_PAGER - - Pager to use when is not given; overrides - $PAGER. If neither $SYSTEMD_PAGER nor $PAGER are set, a - set of well-known pager implementations are tried in turn, including - less1 and - more1, until one is found. If - no pager implementation is discovered no pager is invoked. Setting this environment variable to an empty string - or the value cat is equivalent to passing . - - - - $SYSTEMD_LESS - - Override the options passed to less (by default - FRSXMK). - - Users might want to change two options in particular: - - - - - - This option instructs the pager to exit immediately when - CtrlC is pressed. To allow - less to handle CtrlC - itself to switch back to the pager command prompt, unset this option. - - If the value of $SYSTEMD_LESS does not include K, - and the pager that is invoked is less, - CtrlC will be ignored by the - executable, and needs to be handled by the pager. - - - - - - 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. - - - - See - less1 - for more discussion. - - - - $SYSTEMD_LESSCHARSET - - Override the charset passed to less (by default utf-8, if - the invoking terminal is determined to be UTF-8 compatible). - - - - $SYSTEMD_PAGERSECURE - - Takes a boolean argument. When true, the "secure" mode of the pager is enabled; if - false, disabled. If $SYSTEMD_PAGERSECURE is not set at all, secure mode is enabled - if the effective UID is not the same as the owner of the login session, see - geteuid2 - and sd_pid_get_owner_uid3. - In secure mode, will be set when invoking the pager, and the pager shall - disable commands that open or create new files or start new subprocesses. When - $SYSTEMD_PAGERSECURE is not set at all, pagers which are not known to implement - secure mode will not be used. (Currently only - less1 - implements secure mode.) - - Note: when commands are invoked with elevated privileges, for example under sudo8 or - pkexec1, care - must be taken to ensure that unintended interactive features are not enabled. "Secure" mode for the - pager may be enabled automatically as describe above. Setting SYSTEMD_PAGERSECURE=0 - or not removing it from the inherited environment allows the user to invoke arbitrary commands. Note - that if the $SYSTEMD_PAGER or $PAGER variables are to be - honoured, $SYSTEMD_PAGERSECURE must be set too. It might be reasonable to completely - disable the pager using instead. - - - - $SYSTEMD_COLORS - - Takes a boolean argument. When true, systemd and related utilities - will use colors in their output, otherwise the output will be monochrome. Additionally, the variable can - take one of the following special values: 16, 256 to restrict the use - of colors to the base 16 or 256 ANSI colors, respectively. This can be specified to override the automatic - decision based on $TERM and what the console is connected to. - - - - - - $SYSTEMD_URLIFY - - 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 - systemd makes based on $TERM and other conditions. - - - - - diff --git a/man/localectl.xml b/man/localectl.xml index 7f7e5775c0..9fa34854ed 100644 --- a/man/localectl.xml +++ b/man/localectl.xml @@ -185,7 +185,7 @@ otherwise. - + See Also diff --git a/man/loginctl.xml b/man/loginctl.xml index 33683144fa..56a86e56ef 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -415,7 +415,7 @@ Apr 09 14:40:30 laptop login[2325]: LOGIN ON tty3 BY fatima - + See Also diff --git a/man/machinectl.xml b/man/machinectl.xml index 556fe309dc..ad47b6102e 100644 --- a/man/machinectl.xml +++ b/man/machinectl.xml @@ -980,7 +980,7 @@ otherwise. - + See Also diff --git a/man/portablectl.xml b/man/portablectl.xml index 3f37ad1164..2dae537a40 100644 --- a/man/portablectl.xml +++ b/man/portablectl.xml @@ -428,7 +428,7 @@ On success, 0 is returned, a non-zero failure code otherwise. - + See Also diff --git a/man/systemctl.xml b/man/systemctl.xml index 73ca3a6be0..62bc7fe832 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -2407,12 +2407,12 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err - - - - - - + + + + + + diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml index 16143d4d0f..4da066e05c 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -782,7 +782,7 @@ Service b@0.service not loaded, b.socket cannot be started. otherwise. - + See Also diff --git a/man/systemd-inhibit.xml b/man/systemd-inhibit.xml index 2fee0ede84..f6595f1e26 100644 --- a/man/systemd-inhibit.xml +++ b/man/systemd-inhibit.xml @@ -141,7 +141,7 @@ doing so. - + See Also diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index d282238146..187baceec2 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -1486,7 +1486,7 @@ - + Examples diff --git a/man/systemd.xml b/man/systemd.xml index 893f113431..b0b6c7236e 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -706,12 +706,12 @@ script runlevel link farms. - - - - - - + + + + + + $LISTEN_PID diff --git a/man/timedatectl.xml b/man/timedatectl.xml index e7db4870c0..ce14152370 100644 --- a/man/timedatectl.xml +++ b/man/timedatectl.xml @@ -253,7 +253,7 @@ On success, 0 is returned, a non-zero failure code otherwise. - + Examples diff --git a/man/userdbctl.xml b/man/userdbctl.xml index 15e9a72373..896ad22256 100644 --- a/man/userdbctl.xml +++ b/man/userdbctl.xml @@ -256,7 +256,7 @@ AuthorizedKeysCommandUser root On success, 0 is returned, a non-zero failure code otherwise. - + See Also