man: wording and grammar updates
This is a recurring submission and includes corrections to various issue spotted.
This commit is contained in:
parent
9ec9694ce3
commit
19aadacf92
|
@ -23,12 +23,12 @@ HOWTO:
|
||||||
|
|
||||||
CONTRIBUTING UPSTREAM:
|
CONTRIBUTING UPSTREAM:
|
||||||
|
|
||||||
We are generally do no longer accept distribution specific
|
We do generally no longer accept distribution-specific
|
||||||
patches to systemd upstream. If you have to make changes to
|
patches to systemd upstream. If you have to make changes to
|
||||||
systemd's source code to make it work on your distribution:
|
systemd's source code to make it work on your distribution:
|
||||||
unless your code is generic enough to be generally useful we
|
unless your code is generic enough to be generally useful, we
|
||||||
are unlikely to merge it. Please always consider adopting the
|
are unlikely to merge it. Please always consider adopting the
|
||||||
upstream defaults. If that's not possible please maintain the
|
upstream defaults. If that is not possible, please maintain
|
||||||
relevant patches downstream.
|
the relevant patches downstream.
|
||||||
|
|
||||||
Thank you for understanding.
|
Thank you for understanding.
|
||||||
|
|
34
README
34
README
|
@ -75,8 +75,8 @@ REQUIREMENTS:
|
||||||
CONFIG_TMPFS_XATTR
|
CONFIG_TMPFS_XATTR
|
||||||
CONFIG_SECCOMP
|
CONFIG_SECCOMP
|
||||||
|
|
||||||
For systemd-bootchart a kernel with procfs support and several
|
For systemd-bootchart, a kernel with procfs support and
|
||||||
proc output options enabled is required:
|
several proc output options enabled is required:
|
||||||
CONFIG_PROC_FS
|
CONFIG_PROC_FS
|
||||||
CONFIG_SCHEDSTATS
|
CONFIG_SCHEDSTATS
|
||||||
CONFIG_SCHED_DEBUG
|
CONFIG_SCHED_DEBUG
|
||||||
|
@ -87,7 +87,7 @@ REQUIREMENTS:
|
||||||
|
|
||||||
Note that kernel auditing is broken when used with systemd's
|
Note that kernel auditing is broken when used with systemd's
|
||||||
container code. When using systemd in conjunction with
|
container code. When using systemd in conjunction with
|
||||||
containers please make sure to either turn off auditing at
|
containers, please make sure to either turn off auditing at
|
||||||
runtime using the kernel command line option "audit=0", or
|
runtime using the kernel command line option "audit=0", or
|
||||||
turn it off at kernel compile time using:
|
turn it off at kernel compile time using:
|
||||||
CONFIG_AUDIT=n
|
CONFIG_AUDIT=n
|
||||||
|
@ -110,14 +110,16 @@ REQUIREMENTS:
|
||||||
libpython (optional)
|
libpython (optional)
|
||||||
make, gcc, and similar tools
|
make, gcc, and similar tools
|
||||||
|
|
||||||
During runtime you need the following additional dependencies:
|
During runtime, you need the following additional
|
||||||
|
dependencies:
|
||||||
|
|
||||||
util-linux >= v2.19 (requires fsck -l, agetty -s)
|
util-linux >= v2.19 (requires fsck -l, agetty -s)
|
||||||
sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended)
|
sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended)
|
||||||
dracut (optional)
|
dracut (optional)
|
||||||
PolicyKit (optional)
|
PolicyKit (optional)
|
||||||
|
|
||||||
When building from git you need the following additional dependencies:
|
When building from git, you need the following additional
|
||||||
|
dependencies:
|
||||||
|
|
||||||
docbook-xsl
|
docbook-xsl
|
||||||
xsltproc
|
xsltproc
|
||||||
|
@ -131,16 +133,16 @@ REQUIREMENTS:
|
||||||
sphinx (optional)
|
sphinx (optional)
|
||||||
python-lxml (entirely optional)
|
python-lxml (entirely optional)
|
||||||
|
|
||||||
When systemd-hostnamed is used it is strongly recommended to
|
When systemd-hostnamed is used, it is strongly recommended to
|
||||||
install nss-myhostname to ensure that in a world of
|
install nss-myhostname to ensure that, in a world of
|
||||||
dynamically changing hostnames the hostname stays resolvable
|
dynamically changing hostnames, the hostname stays resolvable
|
||||||
under all circumstances. In fact, systemd-hostnamed will warn
|
under all circumstances. In fact, systemd-hostnamed will warn
|
||||||
if nss-myhostname is not installed.
|
if nss-myhostname is not installed.
|
||||||
|
|
||||||
Note that D-Bus can link against libsystemd-login.so, which
|
Note that D-Bus can link against libsystemd-login.so, which
|
||||||
results in a cyclic build dependency. To accommodate for this
|
results in a cyclic build dependency. To accommodate for
|
||||||
please build D-Bus without systemd first, then build systemd,
|
this, please build D-Bus without systemd first, then build
|
||||||
then rebuild D-Bus with systemd support.
|
systemd, then rebuild D-Bus with systemd support.
|
||||||
|
|
||||||
To build HTML documentation for python-systemd using sphinx,
|
To build HTML documentation for python-systemd using sphinx,
|
||||||
please first install systemd (using 'make install'), and then
|
please first install systemd (using 'make install'), and then
|
||||||
|
@ -156,9 +158,9 @@ USERS AND GROUPS:
|
||||||
|
|
||||||
tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
|
tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
|
||||||
|
|
||||||
During runtime the journal daemon requires the
|
During runtime, the journal daemon requires the
|
||||||
"systemd-journal" system group to exist. New journal files will
|
"systemd-journal" system group to exist. New journal files will
|
||||||
be readable by this group (but not writable) which may be used
|
be readable by this group (but not writable), which may be used
|
||||||
to grant specific users read access.
|
to grant specific users read access.
|
||||||
|
|
||||||
It is also recommended to grant read access to all journal
|
It is also recommended to grant read access to all journal
|
||||||
|
@ -180,12 +182,12 @@ WARNINGS:
|
||||||
|
|
||||||
systemd will warn you during boot if /usr is on a different
|
systemd will warn you during boot if /usr is on a different
|
||||||
file system than /. While in systemd itself very little will
|
file system than /. While in systemd itself very little will
|
||||||
break if /usr is on a separate partition many of its
|
break if /usr is on a separate partition, many of its
|
||||||
dependencies very likely will break sooner or later in one
|
dependencies very likely will break sooner or later in one
|
||||||
form or another. For example udev rules tend to refer to
|
form or another. For example, udev rules tend to refer to
|
||||||
binaries in /usr, binaries that link to libraries in /usr or
|
binaries in /usr, binaries that link to libraries in /usr or
|
||||||
binaries that refer to data files in /usr. Since these
|
binaries that refer to data files in /usr. Since these
|
||||||
breakages are not always directly visible systemd will warn
|
breakages are not always directly visible, systemd will warn
|
||||||
about this, since this kind of file system setup is not really
|
about this, since this kind of file system setup is not really
|
||||||
supported anymore by the basic set of Linux OS components.
|
supported anymore by the basic set of Linux OS components.
|
||||||
|
|
||||||
|
|
22
TODO
22
TODO
|
@ -1,6 +1,6 @@
|
||||||
Bugfixes:
|
Bugfixes:
|
||||||
|
|
||||||
* enabling an instance unit creates pointless link, and
|
* enabling an instance unit creates a pointless link, and
|
||||||
the unit will be started with getty@getty.service:
|
the unit will be started with getty@getty.service:
|
||||||
$ systemctl enable getty@.service
|
$ systemctl enable getty@.service
|
||||||
ln -s '/usr/lib/systemd/system/getty@.service' '/etc/systemd/system/getty.target.wants/getty@.service'
|
ln -s '/usr/lib/systemd/system/getty@.service' '/etc/systemd/system/getty.target.wants/getty@.service'
|
||||||
|
@ -17,7 +17,7 @@ Bugfixes:
|
||||||
|
|
||||||
* properly handle .mount unit state tracking when two mount points are stacked one on top of another on the exact same mount point.
|
* properly handle .mount unit state tracking when two mount points are stacked one on top of another on the exact same mount point.
|
||||||
|
|
||||||
* When we detect invalid UTF-8, we cant't use it in an error message:
|
* When we detect invalid UTF-8, we cannot use it in an error message:
|
||||||
log...("Path is not UTF-8 clean, ignoring assignment: %s", rvalue);
|
log...("Path is not UTF-8 clean, ignoring assignment: %s", rvalue);
|
||||||
|
|
||||||
* shorten the message to sane length:
|
* shorten the message to sane length:
|
||||||
|
@ -62,7 +62,7 @@ Features:
|
||||||
|
|
||||||
* Add a new Distribute=$NUMBER key to socket units that makes use of SO_REUSEPORT to distribute network traffic on $NUMBER instances
|
* Add a new Distribute=$NUMBER key to socket units that makes use of SO_REUSEPORT to distribute network traffic on $NUMBER instances
|
||||||
|
|
||||||
* tmpfiles: when applying ownership to /run/log/journal also do this for the journal fails contained in it
|
* tmpfiles: when applying ownership to /run/log/journal, also do this for the journal fails contained in it
|
||||||
|
|
||||||
* we probably should replace the left-over uses of strv_append() and replace them by strv_push() or strv_extend()
|
* we probably should replace the left-over uses of strv_append() and replace them by strv_push() or strv_extend()
|
||||||
|
|
||||||
|
@ -72,11 +72,11 @@ Features:
|
||||||
|
|
||||||
* After coming back from hibernation reset hibernation swap partition using the /dev/snapshot ioctl APIs
|
* After coming back from hibernation reset hibernation swap partition using the /dev/snapshot ioctl APIs
|
||||||
|
|
||||||
* If we try to find a unit via a dangling symlink generate a clean
|
* If we try to find a unit via a dangling symlink, generate a clean
|
||||||
error. Currently we just ignore it and read the unit from the search
|
error. Currently, we just ignore it and read the unit from the search
|
||||||
path anyway.
|
path anyway.
|
||||||
|
|
||||||
* When a Type=forking service fails and needed another service that
|
* When a Type=forking service fails and needed another service, that
|
||||||
service is not cleaned up again when it has StopWhenUnneeded=yes
|
service is not cleaned up again when it has StopWhenUnneeded=yes
|
||||||
http://lists.freedesktop.org/archives/systemd-devel/2013-July/012141.html
|
http://lists.freedesktop.org/archives/systemd-devel/2013-July/012141.html
|
||||||
|
|
||||||
|
@ -98,7 +98,7 @@ Features:
|
||||||
|
|
||||||
* journalctl: instead --after-cursor= maybe have a --cursor=XYZ+1 syntax?
|
* journalctl: instead --after-cursor= maybe have a --cursor=XYZ+1 syntax?
|
||||||
|
|
||||||
* given that logind/machined now let PID 1 do all nasty work we can
|
* given that logind/machined now let PID 1 do all nasty work, we can
|
||||||
probably reduce the capability set they retain substantially.
|
probably reduce the capability set they retain substantially.
|
||||||
|
|
||||||
* btrfs raid assembly: some .device jobs stay stuck in the queue
|
* btrfs raid assembly: some .device jobs stay stuck in the queue
|
||||||
|
@ -111,9 +111,9 @@ Features:
|
||||||
|
|
||||||
* when parsing calendar timestamps support the UTC timezone (even if we won't support arbitrary timezone specs, support UTC itself certainly makes sense), also support syntaxes such as +0200
|
* when parsing calendar timestamps support the UTC timezone (even if we won't support arbitrary timezone specs, support UTC itself certainly makes sense), also support syntaxes such as +0200
|
||||||
|
|
||||||
* when a kernel driver logs in a tight loop we should ratelimit that too.
|
* when a kernel driver logs in a tight loop, we should ratelimit that too.
|
||||||
|
|
||||||
* "systemctl disable" of a unit instance removes all symlinks, should
|
* "systemctl disable" of a unit instance removes all symlinks, but should
|
||||||
only remove the instance symlink (systemctl disable of a template
|
only remove the instance symlink (systemctl disable of a template
|
||||||
unit however should remove them all).
|
unit however should remove them all).
|
||||||
|
|
||||||
|
@ -131,7 +131,7 @@ Features:
|
||||||
|
|
||||||
* add a fixed dbus path for "my own unit", "my own session", ... to PID1, logind, ...
|
* add a fixed dbus path for "my own unit", "my own session", ... to PID1, logind, ...
|
||||||
|
|
||||||
* service_coldplug() appears to reinstall the wrong stop timeout watch?
|
* service_coldplug() appears to reinstall the wrong stop timeout watch.
|
||||||
|
|
||||||
* transient units: allow creating auxiliary units with the same call
|
* transient units: allow creating auxiliary units with the same call
|
||||||
|
|
||||||
|
@ -154,7 +154,7 @@ Features:
|
||||||
|
|
||||||
* we should properly escape ssh hostnames we add into dbus server strings
|
* we should properly escape ssh hostnames we add into dbus server strings
|
||||||
|
|
||||||
* something pulls in pcre as so dep into our daemons such as hostnamed.
|
* something pulls in pcre as shared object dependency into our daemons such as hostnamed.
|
||||||
|
|
||||||
* document systemd-journal-flush.service properly
|
* document systemd-journal-flush.service properly
|
||||||
|
|
||||||
|
|
|
@ -101,7 +101,7 @@
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><varname>systemd.restore_state=</varname></term>
|
<term><varname>systemd.restore_state=</varname></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Parameter understood by
|
<para>This parameter is understood by
|
||||||
several system tools to control
|
several system tools to control
|
||||||
whether or not they should restore
|
whether or not they should restore
|
||||||
system state from the previous boot.
|
system state from the previous boot.
|
||||||
|
|
|
@ -62,7 +62,7 @@
|
||||||
as necessary.</para>
|
as necessary.</para>
|
||||||
|
|
||||||
<para>The <varname>passno</varname> field
|
<para>The <varname>passno</varname> field
|
||||||
is treated like a simlpe boolean, and the ordering information
|
is treated like a simple boolean, and the ordering information
|
||||||
is discarded. However, the root filesystem is checked
|
is discarded. However, the root filesystem is checked
|
||||||
before all the other filesystems.</para>
|
before all the other filesystems.</para>
|
||||||
|
|
||||||
|
|
|
@ -46,7 +46,7 @@
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
<command>systemd-socket-proxyd</command>
|
<command>systemd-socket-proxyd</command>
|
||||||
<arg choice="opt" rep="repeat">OPTIONS</arg>
|
<arg choice="opt" rep="repeat">OPTIONS</arg>
|
||||||
<arg choice="plain"><replaceable>HOSTNAME-OR-IP</replaceable></arg>
|
<arg choice="plain"><replaceable>HOSTNAME-OR-IPADDR</replaceable></arg>
|
||||||
<arg choice="plain"><replaceable>PORT-OR-SERVICE</replaceable></arg>
|
<arg choice="plain"><replaceable>PORT-OR-SERVICE</replaceable></arg>
|
||||||
</cmdsynopsis>
|
</cmdsynopsis>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
|
@ -67,7 +67,7 @@
|
||||||
for each client, and then bidirectionally forwards
|
for each client, and then bidirectionally forwards
|
||||||
data between the two.</para>
|
data between the two.</para>
|
||||||
<para>This utility's behavior is similar to
|
<para>This utility's behavior is similar to
|
||||||
<citerefentry><refentrytitle>socat</refentrytitle><manvolnum>1</manvolnum> </citerefentry>.
|
<citerefentry><refentrytitle>socat</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
|
||||||
The main differences for <command>systemd-socket-proxyd</command>
|
The main differences for <command>systemd-socket-proxyd</command>
|
||||||
are support for socket activation with
|
are support for socket activation with
|
||||||
<literal>Accept=false</literal> and an event-driven
|
<literal>Accept=false</literal> and an event-driven
|
||||||
|
@ -98,9 +98,9 @@
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Skips verification of
|
<para>Skips verification of
|
||||||
the expected PID and file
|
the expected PID and file
|
||||||
descriptor numbers. Use if
|
descriptor numbers. Use this if
|
||||||
invoked indirectly, for
|
invoked indirectly, for
|
||||||
example with a shell script
|
example, with a shell script
|
||||||
rather than with
|
rather than with
|
||||||
<option>ExecStart=/usr/lib/systemd/systemd-socket-proxyd</option>
|
<option>ExecStart=/usr/lib/systemd/systemd-socket-proxyd</option>
|
||||||
</para>
|
</para>
|
||||||
|
@ -110,7 +110,7 @@
|
||||||
</refsect1>
|
</refsect1>
|
||||||
<refsect1>
|
<refsect1>
|
||||||
<title>Exit status</title>
|
<title>Exit status</title>
|
||||||
<para>On success 0 is returned, a non-zero failure
|
<para>On success, 0 is returned, a non-zero failure
|
||||||
code otherwise.</para>
|
code otherwise.</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
<refsect1>
|
<refsect1>
|
||||||
|
|
Loading…
Reference in New Issue