man: always document both the ipv4 and the ipv6 sockopt
This commit is contained in:
Lennart Poettering
parent
5d0fe4233b
commit
c6a7924513
|
|
@ -448,37 +448,27 @@
|
||||||
<refsect2>
|
<refsect2>
|
||||||
<title>Other Forms of Activation</title>
|
<title>Other Forms of Activation</title>
|
||||||
|
|
||||||
<para>Other forms of activation have been suggested and
|
<para>Other forms of activation have been suggested and implemented in some systems. However, there are
|
||||||
implemented in some systems. However, there are often simpler or
|
often simpler or better alternatives, or they can be put together of combinations of the schemes
|
||||||
better alternatives, or they can be put together of combinations
|
above. Example: Sometimes, it appears useful to start daemons or <filename>.socket</filename> units
|
||||||
of the schemes above. Example: Sometimes, it appears useful to
|
when a specific IP address is configured on a network interface, because network sockets shall be bound
|
||||||
start daemons or <filename>.socket</filename> units when a
|
to the address. However, an alternative to implement this is by utilizing the Linux
|
||||||
specific IP address is configured on a network interface,
|
<constant>IP_FREEBIND</constant>/<constant>IPV6_FREEBIND</constant> socket option, as accessible via
|
||||||
because network sockets shall be bound to the address. However,
|
<varname>FreeBind=yes</varname> in systemd socket files (see
|
||||||
an alternative to implement this is by utilizing the Linux
|
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
|
||||||
<constant>IP_FREEBIND</constant> socket option, as accessible
|
details). This option, when enabled, allows sockets to be bound to a non-local, not configured IP
|
||||||
via <varname>FreeBind=yes</varname> in systemd socket files (see
|
address, and hence allows bindings to a particular IP address before it actually becomes available,
|
||||||
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
making such an explicit dependency to the configured address redundant. Another often suggested trigger
|
||||||
for details). This option, when enabled, allows sockets to be
|
for service activation is low system load. However, here too, a more convincing approach might be to
|
||||||
bound to a non-local, not configured IP address, and hence
|
make proper use of features of the operating system, in particular, the CPU or I/O scheduler of
|
||||||
allows bindings to a particular IP address before it actually
|
Linux. Instead of scheduling jobs from userspace based on monitoring the OS scheduler, it is advisable
|
||||||
becomes available, making such an explicit dependency to the
|
to leave the scheduling of processes to the OS scheduler itself. systemd provides fine-grained access
|
||||||
configured address redundant. Another often suggested trigger
|
to the CPU and I/O schedulers. If a process executed by the init system shall not negatively impact the
|
||||||
for service activation is low system load. However, here too, a
|
amount of CPU or I/O bandwidth available to other processes, it should be configured with
|
||||||
more convincing approach might be to make proper use of features
|
|
||||||
of the operating system, in particular, the CPU or I/O scheduler
|
|
||||||
of Linux. Instead of scheduling jobs from userspace based on
|
|
||||||
monitoring the OS scheduler, it is advisable to leave the
|
|
||||||
scheduling of processes to the OS scheduler itself. systemd
|
|
||||||
provides fine-grained access to the CPU and I/O schedulers. If a
|
|
||||||
process executed by the init system shall not negatively impact
|
|
||||||
the amount of CPU or I/O bandwidth available to other processes,
|
|
||||||
it should be configured with
|
|
||||||
<varname>CPUSchedulingPolicy=idle</varname> and/or
|
<varname>CPUSchedulingPolicy=idle</varname> and/or
|
||||||
<varname>IOSchedulingClass=idle</varname>. Optionally, this may
|
<varname>IOSchedulingClass=idle</varname>. Optionally, this may be combined with timer-based activation
|
||||||
be combined with timer-based activation to schedule background
|
to schedule background jobs during runtime and with minimal impact on the system, and remove it from
|
||||||
jobs during runtime and with minimal impact on the system, and
|
the boot phase itself.</para>
|
||||||
remove it from the boot phase itself.</para>
|
|
||||||
</refsect2>
|
</refsect2>
|
||||||
|
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
|
|
||||||
|
|
@ -568,26 +568,23 @@
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><varname>IPTOS=</varname></term>
|
<term><varname>IPTOS=</varname></term>
|
||||||
<listitem><para>Takes an integer argument controlling the IP
|
<listitem><para>Takes an integer argument controlling the IP Type-Of-Service field for packets
|
||||||
Type-Of-Service field for packets generated from this socket.
|
generated from this socket. This controls the <constant>IP_TOS</constant> socket option (see
|
||||||
This controls the IP_TOS socket option (see
|
<citerefentry
|
||||||
<citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
|
||||||
for details.). Either a numeric string or one of
|
details.). Either a numeric string or one of <option>low-delay</option>, <option>throughput</option>,
|
||||||
<option>low-delay</option>, <option>throughput</option>,
|
<option>reliability</option> or <option>low-cost</option> may be specified.</para></listitem>
|
||||||
<option>reliability</option> or <option>low-cost</option> may
|
|
||||||
be specified.</para></listitem>
|
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><varname>IPTTL=</varname></term>
|
<term><varname>IPTTL=</varname></term>
|
||||||
<listitem><para>Takes an integer argument controlling the IPv4
|
<listitem><para>Takes an integer argument controlling the IPv4 Time-To-Live/IPv6 Hop-Count field for
|
||||||
Time-To-Live/IPv6 Hop-Count field for packets generated from
|
packets generated from this socket. This sets the
|
||||||
this socket. This sets the IP_TTL/IPV6_UNICAST_HOPS socket
|
<constant>IP_TTL</constant>/<constant>IPV6_UNICAST_HOPS</constant> socket options (see <citerefentry
|
||||||
options (see
|
project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>7</manvolnum></citerefentry> and
|
||||||
<citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
<citerefentry
|
||||||
and
|
project='die-net'><refentrytitle>ipv6</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
|
||||||
<citerefentry project='die-net'><refentrytitle>ipv6</refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
details.)</para></listitem>
|
||||||
for details.)</para></listitem>
|
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
|
|
@ -662,20 +659,18 @@
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><varname>FreeBind=</varname></term>
|
<term><varname>FreeBind=</varname></term>
|
||||||
<listitem><para>Takes a boolean value. Controls whether the
|
<listitem><para>Takes a boolean value. Controls whether the socket can be bound to non-local IP
|
||||||
socket can be bound to non-local IP addresses. This is useful
|
addresses. This is useful to configure sockets listening on specific IP addresses before those IP
|
||||||
to configure sockets listening on specific IP addresses before
|
addresses are successfully configured on a network interface. This sets the
|
||||||
those IP addresses are successfully configured on a network
|
<constant>IP_FREEBIND</constant>/<constant>IPV6_FREEBIND</constant> socket option. For robustness
|
||||||
interface. This sets the IP_FREEBIND socket option. For
|
reasons it is recommended to use this option whenever you bind a socket to a specific IP
|
||||||
robustness reasons it is recommended to use this option
|
address. Defaults to <option>false</option>.</para></listitem>
|
||||||
whenever you bind a socket to a specific IP address. Defaults
|
|
||||||
to <option>false</option>.</para></listitem>
|
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><varname>Transparent=</varname></term>
|
<term><varname>Transparent=</varname></term>
|
||||||
<listitem><para>Takes a boolean value. Controls the
|
<listitem><para>Takes a boolean value. Controls the
|
||||||
IP_TRANSPARENT socket option. Defaults to
|
<constant>IP_TRANSPARENT</constant>/<constant>IPV6_TRANSPARENT</constant> socket option. Defaults to
|
||||||
<option>false</option>.</para></listitem>
|
<option>false</option>.</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue