docs/92819: [patch] inetd handbook section: use rc.d script in SigHUP example and remove unnecessary manual page duplicates
Daniel Gerzo
danger at rulez.sk
Sat Feb 4 20:40:08 UTC 2006
>Number: 92819
>Category: docs
>Synopsis: [patch] inetd handbook section: use rc.d script in SigHUP example and remove unnecessary manual page duplicates
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Sat Feb 04 20:40:07 GMT 2006
>Closed-Date:
>Last-Modified:
>Originator: Daniel Gerzo
>Release: FreeBSD 6.0-RELEASE i386
>Organization:
rulez.sk
>Environment:
System: FreeBSD 6.0-RELEASE #3: Fri Nov 4 21:58:23 CET 2005 i386
>Description:
As we have a rc.d script for inetd available and its usage is very
simple, use it in the handbook example (and teach people to get used
to rc.d scripts since they are nice and simple to use).
Also, remove the manual page duplicates from this handbook section as
they seem unncessary to me, and they might look too "advanced" for
novice users, and they can get out of date sooner of later (if they
didn't already :)) and rather point users to read manual page.
>How-To-Repeat:
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/network-inetd.html
>Fix:
Use this diff:
--- inetd.diff begins here ---
--- /usr/home/danger/doc/en_US.ISO8859-1/books/handbook/network-servers/chapter.sgml.orig Sat Feb 4 18:47:32 2006
+++ /usr/home/danger/doc/en_US.ISO8859-1/books/handbook/network-servers/chapter.sgml Sat Feb 4 20:07:10 2006
@@ -149,130 +149,15 @@
<para>Additionally, different command-line options can be passed
to <application>inetd</application> via the
- <literal>inetd_flags</literal> option.</para>
- </sect2>
-
- <sect2 id="network-inetd-cmdline">
- <title>Command-Line Options</title>
-
- <para><application>inetd</application> synopsis:</para>
-
- <para><option> inetd [-d] [-l] [-w] [-W] [-c maximum] [-C rate] [-a address | hostname]
- [-p filename] [-R rate] [configuration file]</option></para>
-
- <variablelist>
- <varlistentry>
- <term>-d</term>
-
- <listitem>
- <para>Turn on debugging.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-l</term>
-
- <listitem>
- <para>Turn on logging of successful connections.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-w</term>
-
- <listitem>
- <para>Turn on TCP Wrapping for external services (on by
- default).</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-W</term>
-
- <listitem>
- <para>Turn on TCP Wrapping for internal services which are
- built into <application>inetd</application> (on by
- default).</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-c maximum</term>
-
- <listitem>
- <para>Specify the default maximum number of simultaneous
- invocations of each service; the default is unlimited.
- May be overridden on a per-service basis with the
- <option>max-child</option> parameter.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-C rate</term>
-
- <listitem>
- <para>Specify the default maximum number of times a
- service can be invoked from a single IP address in one
- minute; the default is unlimited. May be overridden on a
- per-service basis with the
- <option>max-connections-per-ip-per-minute</option>
- parameter.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-R rate</term>
-
- <listitem>
- <para>Specify the maximum number of times a service can be
- invoked in one minute; the default is 256. A rate of 0
- allows an unlimited number of invocations.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-a</term>
-
- <listitem>
- <para>Specify one specific IP address to bind to.
- Alternatively, a hostname can be specified, in which case
- the IPv4 or IPv6 address which corresponds to that
- hostname is used. Usually a hostname is specified when
- <application>inetd</application> is run inside a
- &man.jail.8;, in which case the hostname corresponds to
- the &man.jail.8; environment.</para>
-
- <para>When hostname specification is used and both IPv4
- and IPv6 bindings are desired, one entry with the
- appropriate protocol type for each binding is required
- for each service in
- <filename>/etc/inetd.conf</filename>. For example, a
- TCP-based service would need two entries, one using
- <literal>tcp4</literal> for the protocol and the other
- using <literal>tcp6</literal>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-p</term>
-
- <listitem>
- <para>Specify an alternate file in which to store the
- process ID.</para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>These options can be passed to
- <application>inetd</application> using the
- <literal>inetd_flags</literal> option in
- <filename>/etc/rc.conf</filename>. By default,
+ <literal>inetd_flags</literal> option. By default,
<literal>inetd_flags</literal> is set to
<literal>-wW</literal>, which turns on TCP wrapping for
<application>inetd</application>'s internal and external
services. For novice users, these parameters usually do not
need to be modified or even entered in
- <filename>/etc/rc.conf</filename>.</para>
+ <filename>/etc/rc.conf</filename>. Other options with their
+ detailed descriptions can be found in the &man.inetd.8; manual
+ page.</para>
<note>
<para>An external service is a daemon outside of
@@ -282,7 +167,6 @@
<application>inetd</application> has the facility of
offering within itself.</para>
</note>
-
</sect2>
<sect2 id="network-inetd-conf">
@@ -292,16 +176,15 @@
controlled through the <filename>/etc/inetd.conf</filename>
file.</para>
- <para>When a modification is made to
- <filename>/etc/inetd.conf</filename>,
- <application>inetd</application> can be forced to re-read its
- configuration file by sending a HangUP signal to the
- <application>inetd</application> process as shown:</para>
+ <para>Any modification to
+ <filename>/etc/inetd.conf</filename> will not take effect until
+ <application>inetd</application> is forced to re-read the
+ configuration file by using the following rc.d script:</para>
<example id="network-inetd-hangup">
<title>Sending <application>inetd</application> a HangUP Signal</title>
- <screen>&prompt.root; <userinput>kill -HUP `cat /var/run/inetd.pid`</userinput></screen>
+ <screen>&prompt.root; <userinput>/etc/rc.d/inetd reload</userinput></screen>
</example>
<para>Each line of the configuration file specifies an
--- inetd.diff ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
More information about the freebsd-doc
mailing list