summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGary Lockyer <gary@catalyst.net.nz>2019-02-07 13:50:40 +1300
committerKarolin Seeger <kseeger@samba.org>2019-03-04 10:37:53 +0000
commit6a38b9917b2c25bb557687df2c24618273b6f7f5 (patch)
tree1dda06a95529b737084813c77c008a7f9c953af1
parentab66f70056c3b038c8e24426a99c6ce27bd42722 (diff)
downloadsamba-6a38b9917b2c25bb557687df2c24618273b6f7f5.tar.gz
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 (manual merge of commit 4ecdcc4b462d03bec3ec36ba1b90f45d9977be8b, with description updated for v4.9 behaviour)
-rw-r--r--docs-xml/manpages/samba.8.xml35
-rw-r--r--docs-xml/smbdotconf/base/preforkchildren.xml4
2 files changed, 33 insertions, 6 deletions
diff --git a/docs-xml/manpages/samba.8.xml b/docs-xml/manpages/samba.8.xml
index 529b687be49..0d5affddd24 100644
--- a/docs-xml/manpages/samba.8.xml
+++ b/docs-xml/manpages/samba.8.xml
@@ -101,14 +101,39 @@
</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
- 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 only LDAP).
+ 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 1.
+ </para></listitem>
+ </itemizedlist>
</para></listitem>
</varlistentry>
diff --git a/docs-xml/smbdotconf/base/preforkchildren.xml b/docs-xml/smbdotconf/base/preforkchildren.xml
index 720e43909cb..f2f55a597a4 100644
--- 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
- 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 only ldap). For processes that don't
support preforking all requests are handled by a single process