man pages: document prefork process model

Document the process model options -M

BUG: https://bugzilla.samba.org/show_bug.cgi?id=13765

Signed-off-by: Gary Lockyer <gary@catalyst.net.nz>
Signed-off-by: Tim Beale <timbeale@catalyst.net.nz>
Reviewed-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Autobuild-User(master): Tim Beale <timbeale@samba.org>
Autobuild-Date(master): Thu Jan 31 04:25:14 CET 2019 on sn-devel-144

diff --git a/docs-xml/manpages/samba.8.xml b/docs-xml/manpages/samba.8.xml
index 529b687be49f099f3825969a47f033024a6d1593..0d542b2fbc86d924c59eb597b62fbef757bf8858 100644 (file)
--- a/docs-xml/manpages/samba.8.xml
+++ b/docs-xml/manpages/samba.8.xml
@@ -101,14 +101,39 @@
                </varlistentry>
 
                <varlistentry>
                </varlistentry>
 
                <varlistentry>

-               <term>-M model</term>
+               <term>-M|--model</term>

                <listitem><para>This parameter can be used to specify the
                &quot;process model&quot; samba should use. This determines
                how concurrent clients are handled. Available process
                <listitem><para>This parameter can be used to specify the
                &quot;process model&quot; samba should use. This determines
                how concurrent clients are handled. Available process

-               models include <emphasis>single</emphasis> (everything in
-               a single process), <emphasis>standard</emphasis> (similar
-               behaviour to that of Samba 3), <emphasis>thread</emphasis>
-               (single process, different threads.
+               models include:
+               <itemizedlist>
+                       <listitem><para><emphasis>single</emphasis></para>
+                       <para>All Samba services run in a single process. This is
+                       not recommended for production configurations.
+                       </para></listitem>
+
+                       <listitem><para><emphasis>standard</emphasis></para>
+                       <para>A process is created for each Samba service,
+                       and for those services that support it (currently only
+                       LDAP and NETLOGON) a new processes is started
+                       for each new client connection.</para></listitem>
+
+                       <listitem><para><emphasis>prefork</emphasis></para>
+                       <para>A process is started for each Samba service, and a
+                       fixed number of worker processes are started for those
+                       services that support it (currently LDAP, NETLOGON, and KDC).
+                       The client connections are then shared amongst the worker
+                       processes.
+                       Requests for services not supporting prefork are handled
+                       by a single process for that service.</para>
+                       <para>The number of prefork worker processes started is
+                       controlled by the
+                       <citerefentry><refentrytitle>smb.conf</refentrytitle>
+                       <manvolnum>5</manvolnum></citerefentry> parameter
+                       <smbconfoption name="prefork children"/>,
+                       which defaults to 4.
+                       </para></listitem>
+               </itemizedlist>

                </para></listitem>
                </varlistentry>
 
                </para></listitem>
                </varlistentry>
 

diff --git a/docs-xml/smbdotconf/base/preforkchildren.xml b/docs-xml/smbdotconf/base/preforkchildren.xml
index ab13efce405cd021a0237a9a40b35faa8c101406..1b9f8cf9a078c31456943092c6f85a3247f44861 100644 (file)
--- a/docs-xml/smbdotconf/base/preforkchildren.xml
+++ b/docs-xml/smbdotconf/base/preforkchildren.xml
@@ -4,7 +4,9 @@
                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 <description>
        <para>This option controls the number of worker processes that are
                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 <description>
        <para>This option controls the number of worker processes that are

-               started for each service when prefork process model is enabled.
+               started for each service when prefork process model is enabled
+               (see <citerefentry><refentrytitle>samba</refentrytitle>
+                       <manvolnum>8</manvolnum></citerefentry> -M)

                The prefork children are only started for those services that
                support prefork (currently ldap, kdc and netlogon).
                For processes that don't support preforking all requests are
                The prefork children are only started for those services that
                support prefork (currently ldap, kdc and netlogon).
                For processes that don't support preforking all requests are