From e0e2ecd5a81106a477c8d08e081b77ac7d3b5bdc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 13 Feb 2019 10:17:49 +0100 Subject: [PATCH 1/9] man: move entries to the right section in systemd.directives They were in "miscellaneuos" because of the missing class= assignment. Probably introduced when the split into sections was done. --- man/systemd.exec.xml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index eb476327aa..0248c3a8e0 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -393,7 +393,7 @@ CapabilityBoundingSet=~CAP_B CAP_C Mandatory Access Control - + SELinuxContext= @@ -436,7 +436,7 @@ CapabilityBoundingSet=~CAP_B CAP_C Process Properties - + LimitCPU= @@ -671,7 +671,7 @@ CapabilityBoundingSet=~CAP_B CAP_C Scheduling - + Nice= @@ -764,7 +764,7 @@ CapabilityBoundingSet=~CAP_B CAP_C (such as ProtectSystem=) are not available, as the underlying kernel functionality is only accessible to privileged processes. - + ProtectSystem= @@ -1388,7 +1388,7 @@ RestrictNamespaces=~cgroup net System Call Filtering - + SystemCallFilter= @@ -1627,7 +1627,7 @@ SystemCallErrorNumber=EPERM Environment - + Environment= @@ -1742,7 +1742,7 @@ SystemCallErrorNumber=EPERM Logging and Standard Input/Output - + StandardInput= @@ -2084,7 +2084,7 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy System V Compatibility - + UtmpIdentifier= From 6f520e74373a7f2cf7cb36ca8cf2d61fee88dc49 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 13 Feb 2019 10:22:18 +0100 Subject: [PATCH 2/9] man: fix markup and grammar for FOU{Source,Destination}Port= --- man/systemd.netdev.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index c568a7e7f6..74281f2d0b 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -899,15 +899,15 @@ FOUDestinationPort= - The FOUDestinationPort= specifies the UDP destination port for encapsulation. + This setting specifies the UDP destination port for encapsulation. This field is mandatory and is not set by default. FOUSourcePort= - The FOUSourcePort= specifies the UDP source port for encapsulation. Defaults to 0, - that is, the source port for packets is left to the network stack to decide. + This setting specifies the UDP source port for encapsulation. Defaults to 0 + — that is, the source port for packets is left to the network stack to decide. From 2691d65c5a7b6fbf5807e2e586f1979292d511bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 13 Feb 2019 10:24:40 +0100 Subject: [PATCH 3/9] man: use for pam configuration options It seems to fit the role better, and also the formatting in systemd.directives is fixes. --- man/pam_systemd.xml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index 3ce3b282bd..e5e14c12d7 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -82,7 +82,7 @@ - + class= Takes a string argument which sets the session class. The XDG_SESSION_CLASS environment variable (see below) takes precedence. One of user, greeter, @@ -92,7 +92,7 @@ - + type= Takes a string argument which sets the session type. The XDG_SESSION_TYPE environment variable (see below) takes precedence. One of unspecified, @@ -102,7 +102,7 @@ - + desktop= Takes a single, short identifier string for the desktop environment. The XDG_SESSION_DESKTOP environment variable (see below) takes precedence. This may be used to @@ -117,7 +117,7 @@ - + debug= Takes an optional boolean argument. If yes or without the argument, the module will log debugging information as it operates. @@ -186,21 +186,21 @@ $XDG_SESSION_TYPE - The session type. This may be used instead of on the module parameter + The session type. This may be used instead of session= on the module parameter line, and is usually preferred. $XDG_SESSION_CLASS - The session class. This may be used instead of on the module parameter + The session class. This may be used instead of class= on the module parameter line, and is usually preferred. $XDG_SESSION_DESKTOP - The desktop identifier. This may be used instead of on the module + The desktop identifier. This may be used instead of desktop= on the module parameter line, and is usually preferred. @@ -242,7 +242,7 @@ the context objects. - + systemd.memory_max From b678359235008e795d7da0ef12935e652c7109f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 13 Feb 2019 10:27:36 +0100 Subject: [PATCH 4/9] man: use for SD_BUS_ERROR_* and SD_BUS_NAME_* constants This moves them to the right section in systemd.directives. --- man/sd-bus-errors.xml | 62 ++++++++++++++++++------------------- man/sd_bus_request_name.xml | 14 ++++----- 2 files changed, 38 insertions(+), 38 deletions(-) diff --git a/man/sd-bus-errors.xml b/man/sd-bus-errors.xml index c896511541..a94022c025 100644 --- a/man/sd-bus-errors.xml +++ b/man/sd-bus-errors.xml @@ -112,7 +112,7 @@ - SD_BUS_ERROR_FAILED + SD_BUS_ERROR_FAILED A generic error indication. See the error message for further details. This error name should be avoided, in favor of a more expressive error @@ -120,134 +120,134 @@ - SD_BUS_ERROR_NO_MEMORY + SD_BUS_ERROR_NO_MEMORY A memory allocation failed, and the requested operation could not be completed. - SD_BUS_ERROR_SERVICE_UNKNOWN + SD_BUS_ERROR_SERVICE_UNKNOWN The contacted bus service is unknown and cannot be activated. - SD_BUS_ERROR_NAME_HAS_NO_OWNER + SD_BUS_ERROR_NAME_HAS_NO_OWNER The specified bus service name currently has no owner. - SD_BUS_ERROR_NO_REPLY + SD_BUS_ERROR_NO_REPLY A message did not receive a reply. This error is usually generated after a timeout. - SD_BUS_ERROR_IO_ERROR + SD_BUS_ERROR_IO_ERROR Generic input/output error, for example when accessing a socket or other I/O context. - SD_BUS_ERROR_BAD_ADDRESS + SD_BUS_ERROR_BAD_ADDRESS The specified D-Bus bus address string is malformed. - SD_BUS_ERROR_NOT_SUPPORTED + SD_BUS_ERROR_NOT_SUPPORTED The requested operation is not supported on the local system. - SD_BUS_ERROR_LIMITS_EXCEEDED + SD_BUS_ERROR_LIMITS_EXCEEDED Some limited resource has been exhausted. - SD_BUS_ERROR_ACCESS_DENIED + SD_BUS_ERROR_ACCESS_DENIED Access to a resource has been denied due to security restrictions. - SD_BUS_ERROR_AUTH_FAILED + SD_BUS_ERROR_AUTH_FAILED Authentication did not complete successfully. - SD_BUS_ERROR_NO_SERVER + SD_BUS_ERROR_NO_SERVER Unable to connect to the specified server. - SD_BUS_ERROR_TIMEOUT + SD_BUS_ERROR_TIMEOUT An operation timed out. Note that method calls which timeout generate a - SD_BUS_ERROR_NO_REPLY. + SD_BUS_ERROR_NO_REPLY. - SD_BUS_ERROR_NO_NETWORK + SD_BUS_ERROR_NO_NETWORK No network available to execute requested network operation on. - SD_BUS_ERROR_ADDRESS_IN_USE + SD_BUS_ERROR_ADDRESS_IN_USE The specified network address is already being listened on. - SD_BUS_ERROR_DISCONNECTED + SD_BUS_ERROR_DISCONNECTED The connection has been terminated. - SD_BUS_ERROR_INVALID_ARGS + SD_BUS_ERROR_INVALID_ARGS One or more invalid arguments have been passed. - SD_BUS_ERROR_FILE_NOT_FOUND + SD_BUS_ERROR_FILE_NOT_FOUND The requested file could not be found. - SD_BUS_ERROR_FILE_EXISTS + SD_BUS_ERROR_FILE_EXISTS The requested file already exists. - SD_BUS_ERROR_UNKNOWN_METHOD + SD_BUS_ERROR_UNKNOWN_METHOD The requested method does not exist in the selected interface. - SD_BUS_ERROR_UNKNOWN_OBJECT + SD_BUS_ERROR_UNKNOWN_OBJECT The requested object does not exist in the selected service. - SD_BUS_ERROR_UNKNOWN_INTERFACE + SD_BUS_ERROR_UNKNOWN_INTERFACE The requested interface does not exist on the selected object. - SD_BUS_ERROR_UNKNOWN_PROPERTY + SD_BUS_ERROR_UNKNOWN_PROPERTY The requested property does not exist in the selected interface. - SD_BUS_ERROR_PROPERTY_READ_ONLY + SD_BUS_ERROR_PROPERTY_READ_ONLY A write operation was requested on a read-only property. - SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN + SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN The requested PID is not known. - SD_BUS_ERROR_INVALID_SIGNATURE + SD_BUS_ERROR_INVALID_SIGNATURE The specified message signature is not valid. - SD_BUS_ERROR_INCONSISTENT_MESSAGE + SD_BUS_ERROR_INCONSISTENT_MESSAGE The passed message does not validate correctly. - SD_BUS_ERROR_MATCH_RULE_NOT_FOUND + SD_BUS_ERROR_MATCH_RULE_NOT_FOUND The specified match rule does not exist. - SD_BUS_ERROR_MATCH_RULE_INVALID + SD_BUS_ERROR_MATCH_RULE_INVALID The specified match rule is invalid. - SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED + SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED Access to the requested operation is not permitted. However, it might be available after interactive authentication. This is usually returned by method calls diff --git a/man/sd_bus_request_name.xml b/man/sd_bus_request_name.xml index 3c98b60c6a..cf0b552116 100644 --- a/man/sd_bus_request_name.xml +++ b/man/sd_bus_request_name.xml @@ -74,23 +74,23 @@ - SD_BUS_NAME_ALLOW_REPLACEMENT + SD_BUS_NAME_ALLOW_REPLACEMENT After acquiring the name successfully, permit other peers to take over the name when they try - to acquire it with the SD_BUS_NAME_REPLACE_EXISTING flag set. If - SD_BUS_NAME_ALLOW_REPLACEMENT is not set on the original request, such a request by other + to acquire it with the SD_BUS_NAME_REPLACE_EXISTING flag set. If + SD_BUS_NAME_ALLOW_REPLACEMENT is not set on the original request, such a request by other peers will be denied. - SD_BUS_NAME_REPLACE_EXISTING + SD_BUS_NAME_REPLACE_EXISTING Take over the name if it is already acquired by another peer, and that other peer has permitted - takeover by setting SD_BUS_NAME_ALLOW_REPLACEMENT while acquiring it. + takeover by setting SD_BUS_NAME_ALLOW_REPLACEMENT while acquiring it. - SD_BUS_NAME_QUEUE + SD_BUS_NAME_QUEUE Queue the acquisition of the name when the name is already taken. @@ -130,7 +130,7 @@ On success, these calls return 0 or a positive integer. On failure, these calls return a negative errno-style error code. - If SD_BUS_NAME_QUEUE is specified, sd_bus_request_name() will return + If SD_BUS_NAME_QUEUE is specified, sd_bus_request_name() will return 0 when the name is already taken by another peer and the client has been added to the queue for the name. In that case, the caller can subscribe to NameOwnerChanged signals to be notified when the name is successfully acquired. sd_bus_request_name() returns > 0 when the name has immediately From 833fc9802cb6a8cf588527bf821d57d76341ba36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 13 Feb 2019 10:36:26 +0100 Subject: [PATCH 5/9] man: move os-release, machine-info, vconsole.conf vars to envvar section Strictly speaking, those are not environment variables, but they are compatible and people think about them like this. Moving them makes them easier to find. --- man/machine-info.xml | 2 +- man/os-release.xml | 2 +- man/vconsole.conf.xml | 2 +- tools/make-directive-index.py | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/man/machine-info.xml b/man/machine-info.xml index 476996ce5f..5a268c9f36 100644 --- a/man/machine-info.xml +++ b/man/machine-info.xml @@ -58,7 +58,7 @@ The following machine metadata parameters may be set using /etc/machine-info: - + PRETTY_HOSTNAME= diff --git a/man/os-release.xml b/man/os-release.xml index ea71b36c1e..6de0cd7148 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -90,7 +90,7 @@ The following OS identifications parameters may be set using os-release: - + NAME= diff --git a/man/vconsole.conf.xml b/man/vconsole.conf.xml index fc8b2cb3ef..a0ca83507d 100644 --- a/man/vconsole.conf.xml +++ b/man/vconsole.conf.xml @@ -68,7 +68,7 @@ The following options are understood: - + KEYMAP= diff --git a/tools/make-directive-index.py b/tools/make-directive-index.py index 8703c8a37b..9e4fe66b75 100755 --- a/tools/make-directive-index.py +++ b/tools/make-directive-index.py @@ -46,8 +46,8 @@ TEMPLATE = '''\ Environment variables - Environment variables understood by the systemd - manager and other programs. + Environment variables understood by the systemd manager + and other programs and environment variable-compatible settings. From d2acdcc6463cde22fcb5c9cf472126b6b0cdac9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 13 Feb 2019 10:49:47 +0100 Subject: [PATCH 6/9] man: move all config file options to one section We had "SYSTEM MANAGER DIRECTIVES" which was a misnomer already, because it also listed user manager stuff. Let's make this a more general section and move the items for other services there too (from "MISCELANENOUS"). --- man/coredump.conf.xml | 2 +- man/journal-remote.conf.xml | 2 +- man/journal-upload.conf.xml | 2 +- man/journald.conf.xml | 2 +- man/logind.conf.xml | 2 +- man/systemd-sleep.conf.xml | 2 +- man/systemd-system.conf.xml | 2 +- man/udev.conf.xml | 2 +- tools/make-directive-index.py | 6 +++--- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/man/coredump.conf.xml b/man/coredump.conf.xml index ee3c1b6919..4ccc174bbc 100644 --- a/man/coredump.conf.xml +++ b/man/coredump.conf.xml @@ -54,7 +54,7 @@ All options are configured in the [Coredump] section: - + Storage= diff --git a/man/journal-remote.conf.xml b/man/journal-remote.conf.xml index acc1817cd8..8fa557c0ba 100644 --- a/man/journal-remote.conf.xml +++ b/man/journal-remote.conf.xml @@ -51,7 +51,7 @@ All options are configured in the [Remote] section: - + Seal= diff --git a/man/journal-upload.conf.xml b/man/journal-upload.conf.xml index c3bfa47950..3dda3019b5 100644 --- a/man/journal-upload.conf.xml +++ b/man/journal-upload.conf.xml @@ -48,7 +48,7 @@ All options are configured in the [Upload] section: - + URL= diff --git a/man/journald.conf.xml b/man/journald.conf.xml index a44b0e84ed..2791678a4f 100644 --- a/man/journald.conf.xml +++ b/man/journald.conf.xml @@ -50,7 +50,7 @@ All options are configured in the [Journal] section: - + Storage= diff --git a/man/logind.conf.xml b/man/logind.conf.xml index a407858957..ac8032ab4d 100644 --- a/man/logind.conf.xml +++ b/man/logind.conf.xml @@ -51,7 +51,7 @@ All options are configured in the [Login] section: - + NAutoVTs= diff --git a/man/systemd-sleep.conf.xml b/man/systemd-sleep.conf.xml index 96e6d5e452..af61947c5c 100644 --- a/man/systemd-sleep.conf.xml +++ b/man/systemd-sleep.conf.xml @@ -112,7 +112,7 @@ /etc/systemd/sleep.conf or a sleep.conf.d file: - + AllowSuspend= AllowHibernation= diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml index 73458fd5c7..27242b3a56 100644 --- a/man/systemd-system.conf.xml +++ b/man/systemd-system.conf.xml @@ -63,7 +63,7 @@ All options are configured in the [Manager] section: - + LogLevel= diff --git a/man/udev.conf.xml b/man/udev.conf.xml index 23a4595fa9..d1878f8c6f 100644 --- a/man/udev.conf.xml +++ b/man/udev.conf.xml @@ -40,7 +40,7 @@ ignored. The following variables can be set: - + udev_log= diff --git a/tools/make-directive-index.py b/tools/make-directive-index.py index 9e4fe66b75..3202d48e9a 100755 --- a/tools/make-directive-index.py +++ b/tools/make-directive-index.py @@ -98,12 +98,12 @@ TEMPLATE = '''\ - System manager directives + Program configuration options Directives for configuring the behaviour of the - systemd process. + systemd process and other tools through configuration files. - + From 37dac218b48be088ce0f82a6f9bc4e10c61d0ec2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 13 Feb 2019 10:57:49 +0100 Subject: [PATCH 7/9] man: add a new directives section for .nspawn They is quite a bit of those directives and they were in "MISCELLANEOUS" because they don't quite fit anywhere. When the OCI-compat stuff is merged, there'll be even more, so let's make a separate section for them. --- man/systemd.nspawn.xml | 6 +++--- tools/make-directive-index.py | 11 ++++++++++- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/man/systemd.nspawn.xml b/man/systemd.nspawn.xml index f978fef235..7924641df9 100644 --- a/man/systemd.nspawn.xml +++ b/man/systemd.nspawn.xml @@ -112,7 +112,7 @@ Settings files may include an [Exec] section, which carries various execution parameters: - + Boot= @@ -374,7 +374,7 @@ section, which carries various parameters configuring the file system of the container: - + ReadOnly= @@ -458,7 +458,7 @@ section, which carries various parameters configuring the network connectivity of the container: - + Private= diff --git a/tools/make-directive-index.py b/tools/make-directive-index.py index 3202d48e9a..51f1d514fc 100755 --- a/tools/make-directive-index.py +++ b/tools/make-directive-index.py @@ -97,6 +97,15 @@ TEMPLATE = '''\ + + <citerefentry><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry> + directives + + Directives for configuring systemd-nspawn containers. + + + + Program configuration options @@ -107,7 +116,7 @@ TEMPLATE = '''\ - command line options + Command line options Command-line options accepted by programs in the systemd suite. From bc61c2b1c7daa5469168fec783b1f83bffe4e02c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 13 Feb 2019 11:09:02 +0100 Subject: [PATCH 8/9] man: add a new section for EFI variables We should probably refer to them from other man pages for programs which use them, since right now all refs are in systemd-boot(7). But creating the section is a good step anyway. --- man/systemd-boot.xml | 2 +- tools/make-directive-index.py | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/man/systemd-boot.xml b/man/systemd-boot.xml index 44b0f61f22..4c914e6156 100644 --- a/man/systemd-boot.xml +++ b/man/systemd-boot.xml @@ -243,7 +243,7 @@ UUID 4a67b082-0a4c-41cf-b6c7-440b29bb8c4, for communication between the OS and the boot loader: - + LoaderBootCountPath If boot counting is enabled, contains the path to the file in whose name the boot counters are diff --git a/tools/make-directive-index.py b/tools/make-directive-index.py index 51f1d514fc..9d9448703f 100755 --- a/tools/make-directive-index.py +++ b/tools/make-directive-index.py @@ -52,6 +52,16 @@ TEMPLATE = '''\ + + EFI variables + + EFI variables understood by + systemd-boot7 + and other programs. + + + + UDEV directives From 6772ce6e11891af63908853ccf01e851a583b897 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 13 Feb 2019 11:11:30 +0100 Subject: [PATCH 9/9] man: move sd-login(5) udev tags to the udev section They are not udev systax exactly, but it seems better to keep them there. --- man/sd-login.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/sd-login.xml b/man/sd-login.xml index 83ef0b7307..374395726f 100644 --- a/man/sd-login.xml +++ b/man/sd-login.xml @@ -148,7 +148,7 @@ Assignment of hardware devices to seats is managed inside the udev database, via settings on the devices: - + Tag seat