From b514d6c9dcc7c0d7353f975ecfb94f2197c73cf1 Mon Sep 17 00:00:00 2001 From: Sven Eden Date: Thu, 19 Jan 2017 13:04:18 +0100 Subject: Fix man page building to be less systemd and more elogind. --- man/elogind.conf.xml | 305 -------------------------------------------- man/loginctl.xml | 6 +- man/logind.conf.xml | 305 ++++++++++++++++++++++++++++++++++++++++++++ man/logind.xml | 18 +-- man/pam_elogind.xml | 10 +- man/sd_is_fifo.xml | 2 +- man/sd_notify.xml | 8 +- man/sd_watchdog_enabled.xml | 4 +- 8 files changed, 329 insertions(+), 329 deletions(-) delete mode 100644 man/elogind.conf.xml create mode 100644 man/logind.conf.xml (limited to 'man') diff --git a/man/elogind.conf.xml b/man/elogind.conf.xml deleted file mode 100644 index ddb01ec4a..000000000 --- a/man/elogind.conf.xml +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - - - elogind.conf - elogind - - - - Developer - Lennart - Poettering - lennart@poettering.net - - - - - - elogind.conf - 5 - - - - elogind.conf - Login manager configuration files - - - - /etc/elogind/elogind.conf - - - - Description - - These files configure various parameters of the elogind - login manager, - elogind-logind.service8. - - - - - - - Options - - All options are configured in the - [Login] section: - - - - - NAutoVTs= - - Takes a positive integer. Configures how many - virtual terminals (VTs) to allocate by default that, when - switched to and are previously unused, - autovt services are automatically spawned - on. These services are instantiated from the template unit - autovt@.service for the respective VT TTY - name, for example, autovt@tty4.service. - By default, autovt@.service is linked to - getty@.service. In other words, login - prompts are started dynamically as the user switches to unused - virtual terminals. Hence, this parameter controls how many - login gettys are available on the VTs. If a - VT is already used by some other subsystem (for example, a - graphical login), this kind of activation will not be - attempted. Note that the VT configured in - ReserveVT= is always subject to this kind - of activation, even if it is not one of the VTs configured - with the NAutoVTs= directive. Defaults to - 6. When set to 0, automatic spawning of - autovt services is - disabled. - - - - ReserveVT= - - Takes a positive integer. Identifies one - virtual terminal that shall unconditionally be reserved for - autovt@.service activation (see above). - The VT selected with this option will be marked busy - unconditionally, so that no other subsystem will allocate it. - This functionality is useful to ensure that, regardless of how - many VTs are allocated by other subsystems, one login - getty is always available. Defaults to 6 - (in other words, there will always be a - getty available on Alt-F6.). When set to 0, - VT reservation is disabled. - - - - KillUserProcesses= - - Takes a boolean argument. Configures whether - the processes of a user should be killed when the user - completely logs out (i.e. after the user's last session - ended). Defaults to no. - - Note that setting KillUserProcesses=1 - will break tools like - screen1. - - - - KillOnlyUsers= - KillExcludeUsers= - - These settings take space-separated lists of - usernames that influence the effect of - KillUserProcesses=. If not empty, only - processes of users listed in KillOnlyUsers= - will be killed when they log out entirely. Processes of users - listed in KillExcludeUsers= are excluded - from being killed. KillExcludeUsers= - defaults to root and takes precedence over - KillOnlyUsers=, which defaults to the empty - list. - - - - IdleAction= - - Configures the action to take when the system - is idle. Takes one of - ignore, - poweroff, - reboot, - halt, - kexec, - suspend, - hibernate, - hybrid-sleep, and - lock. - Defaults to ignore. - - Note that this requires that user sessions correctly - report the idle status to the system. The system will execute - the action after all sessions report that they are idle, no - idle inhibitor lock is active, and subsequently, the time - configured with IdleActionSec= (see below) - has expired. - - - - - IdleActionSec= - - Configures the delay after which the action - configured in IdleAction= (see above) is - taken after the system is idle. - - - - InhibitDelayMaxSec= - - Specifies the maximum time a system shutdown - or sleep request is delayed due to an inhibitor lock of type - delay being active before the inhibitor is - ignored and the operation executes anyway. Defaults to - 5. - - - - HandlePowerKey= - HandleSuspendKey= - HandleHibernateKey= - HandleLidSwitch= - HandleLidSwitchDocked= - - Controls whether logind shall handle the - system power and sleep keys and the lid switch to trigger - actions such as system power-off or suspend. Can be one of - ignore, - poweroff, - reboot, - halt, - kexec, - suspend, - hibernate, - hybrid-sleep, and - lock. - If ignore, logind will never handle these - keys. If lock, all running sessions will be - screen-locked; otherwise, the specified action will be taken - in the respective event. Only input devices with the - power-switch udev tag will be watched for - key/lid switch events. HandlePowerKey= - defaults to poweroff. - HandleSuspendKey= and - HandleLidSwitch= default to - suspend. - HandleLidSwitchDocked= defaults to - ignore. - HandleHibernateKey= defaults to - hibernate. If the system is inserted in a - docking station, or if more than one display is connected, the - action specified by HandleLidSwitchDocked= - occurs; otherwise the HandleLidSwitch= - action occurs. - - - - PowerKeyIgnoreInhibited= - SuspendKeyIgnoreInhibited= - HibernateKeyIgnoreInhibited= - LidSwitchIgnoreInhibited= - - Controls whether actions triggered by the - power and sleep keys and the lid switch are subject to - inhibitor locks. These settings take boolean arguments. If - no, the inhibitor locks taken by - applications in order to block the requested operation are - respected. If yes, the requested operation - is executed in any case. - PowerKeyIgnoreInhibited=, - SuspendKeyIgnoreInhibited= and - HibernateKeyIgnoreInhibited= default to - no. - LidSwitchIgnoreInhibited= defaults to - yes. This means that the lid switch does - not respect suspend blockers by default, but the power and - sleep keys do. - - - - HoldoffTimeoutSec= - - Specifies the timeout after system startup or - system resume in which elogind will hold off on reacting to - LID events. This is required for the system to properly - detect any hotplugged devices so elogind can ignore LID events - if external monitors, or docks, are connected. If set to 0, - elogind will always react immediately, possibly before the - kernel fully probed all hotplugged devices. This is safe, as - long as you do not care for elogind to account for devices - that have been plugged or unplugged while the system was off. - Defaults to 30s. - - - - RuntimeDirectorySize= - - Sets the size limit on the - $XDG_RUNTIME_DIR runtime directory for each - user who logs in. Takes a size in bytes, optionally suffixed - with the usual K, G, M, and T suffixes, to the base 1024 - (IEC). Alternatively, a numerical percentage suffixed by - % may be specified, which sets the size - limit relative to the amount of physical RAM. Defaults to 10%. - Note that this size is a safety limit only. As each runtime - directory is a tmpfs file system, it will only consume as much - memory as is needed. - - - - RemoveIPC= - - Controls whether System V and POSIX IPC - objects belonging to the user shall be removed when the user - fully logs out. Takes a boolean argument. If enabled, the user - may not consume IPC resources after the last of the user's - sessions terminated. This covers System V semaphores, shared - memory and message queues, as well as POSIX shared memory and - message queues. Note that IPC objects of the root user are - excluded from the effect of this setting. Defaults to - yes. - - - - - - - See Also - - elogind1, - elogind-logind.service8, - loginctl1, - elogind-system.conf5 - - - - diff --git a/man/loginctl.xml b/man/loginctl.xml index 8a1ddb618..45b0cf312 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -63,7 +63,7 @@ control the state of the elogind1 login manager - elogind-logind.service8. + logind.service8. @@ -406,8 +406,8 @@ elogind1, systemctl1, - elogind-logind.service8, - elogind.conf5 + logind.service8, + logind.conf5 diff --git a/man/logind.conf.xml b/man/logind.conf.xml new file mode 100644 index 000000000..1f7cfc996 --- /dev/null +++ b/man/logind.conf.xml @@ -0,0 +1,305 @@ + + + + + + + + logind.conf + elogind + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + logind.conf + 5 + + + + logind.conf + Login manager configuration files + + + + /etc/elogind/logind.conf + + + + Description + + These files configure various parameters of the elogind + login manager, + logind.service8. + + + + + + + Options + + All options are configured in the + [Login] section: + + + + + NAutoVTs= + + Takes a positive integer. Configures how many + virtual terminals (VTs) to allocate by default that, when + switched to and are previously unused, + autovt services are automatically spawned + on. These services are instantiated from the template unit + autovt@.service for the respective VT TTY + name, for example, autovt@tty4.service. + By default, autovt@.service is linked to + getty@.service. In other words, login + prompts are started dynamically as the user switches to unused + virtual terminals. Hence, this parameter controls how many + login gettys are available on the VTs. If a + VT is already used by some other subsystem (for example, a + graphical login), this kind of activation will not be + attempted. Note that the VT configured in + ReserveVT= is always subject to this kind + of activation, even if it is not one of the VTs configured + with the NAutoVTs= directive. Defaults to + 6. When set to 0, automatic spawning of + autovt services is + disabled. + + + + ReserveVT= + + Takes a positive integer. Identifies one + virtual terminal that shall unconditionally be reserved for + autovt@.service activation (see above). + The VT selected with this option will be marked busy + unconditionally, so that no other subsystem will allocate it. + This functionality is useful to ensure that, regardless of how + many VTs are allocated by other subsystems, one login + getty is always available. Defaults to 6 + (in other words, there will always be a + getty available on Alt-F6.). When set to 0, + VT reservation is disabled. + + + + KillUserProcesses= + + Takes a boolean argument. Configures whether + the processes of a user should be killed when the user + completely logs out (i.e. after the user's last session + ended). Defaults to no. + + Note that setting KillUserProcesses=1 + will break tools like + screen1. + + + + KillOnlyUsers= + KillExcludeUsers= + + These settings take space-separated lists of + usernames that influence the effect of + KillUserProcesses=. If not empty, only + processes of users listed in KillOnlyUsers= + will be killed when they log out entirely. Processes of users + listed in KillExcludeUsers= are excluded + from being killed. KillExcludeUsers= + defaults to root and takes precedence over + KillOnlyUsers=, which defaults to the empty + list. + + + + IdleAction= + + Configures the action to take when the system + is idle. Takes one of + ignore, + poweroff, + reboot, + halt, + kexec, + suspend, + hibernate, + hybrid-sleep, and + lock. + Defaults to ignore. + + Note that this requires that user sessions correctly + report the idle status to the system. The system will execute + the action after all sessions report that they are idle, no + idle inhibitor lock is active, and subsequently, the time + configured with IdleActionSec= (see below) + has expired. + + + + + IdleActionSec= + + Configures the delay after which the action + configured in IdleAction= (see above) is + taken after the system is idle. + + + + InhibitDelayMaxSec= + + Specifies the maximum time a system shutdown + or sleep request is delayed due to an inhibitor lock of type + delay being active before the inhibitor is + ignored and the operation executes anyway. Defaults to + 5. + + + + HandlePowerKey= + HandleSuspendKey= + HandleHibernateKey= + HandleLidSwitch= + HandleLidSwitchDocked= + + Controls whether logind shall handle the + system power and sleep keys and the lid switch to trigger + actions such as system power-off or suspend. Can be one of + ignore, + poweroff, + reboot, + halt, + kexec, + suspend, + hibernate, + hybrid-sleep, and + lock. + If ignore, logind will never handle these + keys. If lock, all running sessions will be + screen-locked; otherwise, the specified action will be taken + in the respective event. Only input devices with the + power-switch udev tag will be watched for + key/lid switch events. HandlePowerKey= + defaults to poweroff. + HandleSuspendKey= and + HandleLidSwitch= default to + suspend. + HandleLidSwitchDocked= defaults to + ignore. + HandleHibernateKey= defaults to + hibernate. If the system is inserted in a + docking station, or if more than one display is connected, the + action specified by HandleLidSwitchDocked= + occurs; otherwise the HandleLidSwitch= + action occurs. + + + + PowerKeyIgnoreInhibited= + SuspendKeyIgnoreInhibited= + HibernateKeyIgnoreInhibited= + LidSwitchIgnoreInhibited= + + Controls whether actions triggered by the + power and sleep keys and the lid switch are subject to + inhibitor locks. These settings take boolean arguments. If + no, the inhibitor locks taken by + applications in order to block the requested operation are + respected. If yes, the requested operation + is executed in any case. + PowerKeyIgnoreInhibited=, + SuspendKeyIgnoreInhibited= and + HibernateKeyIgnoreInhibited= default to + no. + LidSwitchIgnoreInhibited= defaults to + yes. This means that the lid switch does + not respect suspend blockers by default, but the power and + sleep keys do. + + + + HoldoffTimeoutSec= + + Specifies the timeout after system startup or + system resume in which elogind will hold off on reacting to + LID events. This is required for the system to properly + detect any hotplugged devices so elogind can ignore LID events + if external monitors, or docks, are connected. If set to 0, + elogind will always react immediately, possibly before the + kernel fully probed all hotplugged devices. This is safe, as + long as you do not care for elogind to account for devices + that have been plugged or unplugged while the system was off. + Defaults to 30s. + + + + RuntimeDirectorySize= + + Sets the size limit on the + $XDG_RUNTIME_DIR runtime directory for each + user who logs in. Takes a size in bytes, optionally suffixed + with the usual K, G, M, and T suffixes, to the base 1024 + (IEC). Alternatively, a numerical percentage suffixed by + % may be specified, which sets the size + limit relative to the amount of physical RAM. Defaults to 10%. + Note that this size is a safety limit only. As each runtime + directory is a tmpfs file system, it will only consume as much + memory as is needed. + + + + RemoveIPC= + + Controls whether System V and POSIX IPC + objects belonging to the user shall be removed when the user + fully logs out. Takes a boolean argument. If enabled, the user + may not consume IPC resources after the last of the user's + sessions terminated. This covers System V semaphores, shared + memory and message queues, as well as POSIX shared memory and + message queues. Note that IPC objects of the root user are + excluded from the effect of this setting. Defaults to + yes. + + + + + + + See Also + + elogind1, + logind.service8, + loginctl1, + elogind-system.conf5 + + + + diff --git a/man/logind.xml b/man/logind.xml index 5733e42cd..7afacbf34 100644 --- a/man/logind.xml +++ b/man/logind.xml @@ -21,10 +21,10 @@ along with systemd; If not, see . --> - + - systemd-logind.service + logind.service systemd @@ -38,25 +38,25 @@ - systemd-logind.service + logind.service 8 - systemd-logind.service - systemd-logind + logind.service + logind Login manager - systemd-logind.service - /usr/lib/systemd/systemd-logind + logind.service + /usr/lib/systemd/logind Description - systemd-logind is a system service that + logind is a system service that manages user logins. It is responsible for: @@ -100,7 +100,7 @@ See the logind D-Bus API Documentation for information about the - APIs systemd-logind provides. + APIs logind provides. For more information on the inhibition logic see the Inhibitor diff --git a/man/pam_elogind.xml b/man/pam_elogind.xml index 700f0cc88..02c11a1e3 100644 --- a/man/pam_elogind.xml +++ b/man/pam_elogind.xml @@ -56,7 +56,7 @@ pam_elogind registers user sessions with the elogind login manager - elogind-logind.service8, + logind.service8, and hence the elogind control group hierarchy. On login, this module ensures the following: @@ -88,7 +88,7 @@ If enabled in - elogind.conf + logind.conf 5, all processes of the session are terminated. If the last concurrent session of a user ends, the user's elogind instance will be terminated too, and so @@ -280,8 +280,8 @@ session required pam_elogind.so See Also elogind1, - elogind-logind.service8, - elogind.conf5, + logind.service8, + logind.conf5, loginctl1, pam.conf5, pam.d5, @@ -289,7 +289,7 @@ session required pam_elogind.so pam_loginuid8, elogind.scope5, elogind.slice5, - elogind.service5 + logind.service5 diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 64f23cb6f..83c204d0c 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -192,7 +192,7 @@ elogind1, sd-daemon3, sd_listen_fds3, - elogind.service5, + logind.service5, elogind.socket5 diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 41c3f3fa7..c52ef533b 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -194,7 +194,7 @@ watchdog timestamp. This is the keep-alive ping that services need to issue in regular intervals if WatchdogSec= is enabled for it. See - elogind.service5 + logind.service5 for information how to enable this functionality and sd_watchdog_enabled3 for the details of how the service can check whether the @@ -219,7 +219,7 @@ manager will accept messages for a service only if FileDescriptorStoreMax= is set to non-zero for it (defaults to zero). See - elogind.service5 + logind.service5 for details. Multiple arrays of file descriptors may be sent in separate messages, in which case the arrays are combined. Note that the service manager removes duplicate file @@ -238,7 +238,7 @@ Note that elogind will accept status data sent from a service only if the NotifyAccess= option is correctly set in the service definition file. See - elogind.service5 + logind.service5 for details. sd_notifyf() is similar to @@ -368,7 +368,7 @@ elogind1, sd-daemon3, daemon7, - elogind.service5, + logind.service5, sd_watchdog_enabled3 diff --git a/man/sd_watchdog_enabled.xml b/man/sd_watchdog_enabled.xml index e588b0401..efa8fbf3f 100644 --- a/man/sd_watchdog_enabled.xml +++ b/man/sd_watchdog_enabled.xml @@ -96,7 +96,7 @@ To enable service supervision with the watchdog logic, use WatchdogSec= in service files. See - elogind.service5 + logind.service5 for details. @@ -167,7 +167,7 @@ elogind1, sd-daemon3, daemon7, - elogind.service5, + logind.service5, sd_notify3 -- cgit v1.2.3