Introduce mod_unixd into the documentation

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@713242 13f79535-47bb-0310-9956-ffa450edef68

10 files changed, 175 insertions, 165 deletions

diff --git a/docs/manual/mod/mod_cgi.xml b/docs/manual/mod/mod_cgi.xml
index 029d1c0484..202426243e 100644
--- a/docs/manual/mod/mod_cgi.xml
+++ b/docs/manual/mod/mod_cgi.xml
@@ -177,7 +177,7 @@
 
     <p>This log will be opened as the user the child processes run
     as, <em>i.e.</em> the user specified in the main <directive
-    module="mpm_common">User</directive> directive. This means that
+    module="mod_unixd">User</directive> directive. This means that
     either the directory the script log is in needs to be writable
     by that user or the file needs to be manually created and set
     to be writable by that user. If you place the script log in
diff --git a/docs/manual/mod/mod_dav.xml b/docs/manual/mod/mod_dav.xml
index 9894f4e0c3..06bd77eb28 100644
--- a/docs/manual/mod/mod_dav.xml
+++ b/docs/manual/mod/mod_dav.xml
@@ -62,8 +62,8 @@
     </example>
 
     <p>The directory containing the lock database file must be
-    writable by the <directive module="mpm_common">User</directive>
-    and <directive module="mpm_common" >Group</directive> under which
+    writable by the <directive module="mod_unixd">User</directive>
+    and <directive module="mod_unixd" >Group</directive> under which
     Apache is running.</p>
 
     <p>You may wish to add a <directive module="core" type="section"
@@ -120,11 +120,11 @@
 
     <p>In order for <module>mod_dav</module> to manage files, it must
     be able to write to the directories and files under its control
-    using the <directive module="mpm_common">User</directive> and
-    <directive module="mpm_common">Group</directive> under which
+    using the <directive module="mod_unixd">User</directive> and
+    <directive module="mod_unixd">Group</directive> under which
     Apache is running.  New files created will also be owned by this
-    <directive module="mpm_common">User</directive> and <directive
-    module="mpm_common">Group</directive>.  For this reason, it is
+    <directive module="mod_unixd">User</directive> and <directive
+    module="mod_unixd">Group</directive>.  For this reason, it is
     important to control access to this account.  The DAV repository
     is considered private to Apache; modifying files outside of Apache
     (for example using FTP or filesystem-level tools) should not be
diff --git a/docs/manual/mod/mod_dav_fs.xml b/docs/manual/mod/mod_dav_fs.xml
index ecb709aafd..6fdfe1be39 100644
--- a/docs/manual/mod/mod_dav_fs.xml
+++ b/docs/manual/mod/mod_dav_fs.xml
@@ -71,8 +71,8 @@
     </example>
 
     <p>The directory containing the lock database file must be
-    writable by the <directive module="mpm_common">User</directive>
-    and <directive module="mpm_common" >Group</directive> under which
+    writable by the <directive module="mod_unixd">User</directive>
+    and <directive module="mod_unixd" >Group</directive> under which
     Apache is running.  For security reasons, you should create a
     directory for this purpose rather than changing the permissions on
     an existing directory.  In the above example, Apache will create
diff --git a/docs/manual/mod/mod_dav_lock.xml b/docs/manual/mod/mod_dav_lock.xml
index 60dfa111f7..d1f0a9e86e 100644
--- a/docs/manual/mod/mod_dav_lock.xml
+++ b/docs/manual/mod/mod_dav_lock.xml
@@ -76,8 +76,8 @@
     </example>
 
     <p>The directory containing the lock database file must be
-    writable by the <directive module="mpm_common">User</directive>
-    and <directive module="mpm_common" >Group</directive> under which
+    writable by the <directive module="mod_unixd">User</directive>
+    and <directive module="mod_unixd" >Group</directive> under which
     Apache is running.  For security reasons, you should create a
     directory for this purpose rather than changing the permissions on
     an existing directory.  In the above example, Apache will create
diff --git a/docs/manual/mod/mod_suexec.xml b/docs/manual/mod/mod_suexec.xml
index 75e9d07c54..61f13e2115 100644
--- a/docs/manual/mod/mod_suexec.xml
+++ b/docs/manual/mod/mod_suexec.xml
@@ -53,7 +53,7 @@ later.</compatibility>
     <p>The <directive>SuexecUserGroup</directive> directive allows you
     to specify a user and group for CGI programs to run as. Non-CGI
     requests are still processes with the user specified in the <directive
-    module="mpm_common">User</directive> directive. This directive replaces
+    module="mod_unixd">User</directive> directive. This directive replaces
     the Apache 1.3 configuration of using the <code>User</code> and
     <code>Group</code> directives inside of VirtualHosts.</p>
 
diff --git a/docs/manual/mod/mod_unixd.xml b/docs/manual/mod/mod_unixd.xml
new file mode 100644
index 0000000000..5ae2032b9e
--- /dev/null
+++ b/docs/manual/mod/mod_unixd.xml
@@ -0,0 +1,143 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision: 703441 $ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<modulesynopsis metafile="mod_unixd.xml.meta">
+
+<name>mod_unixd</name>
+<description>Basic (required) security for Unix-family platforms.</description>
+<status>Core</status>
+
+<directivesynopsis>
+<name>Group</name>
+<description>Group under which the server will answer
+requests</description>
+<syntax>Group <var>unix-group</var></syntax>
+<default>Group #-1</default>
+<contextlist><context>server config</context></contextlist>
+<compatibility>Only valid in global server config since Apache
+2.0</compatibility>
+
+<usage>
+    <p>The <directive>Group</directive> directive sets the group under
+    which the server will answer requests. In order to use this
+    directive, the server must be run initially as <code>root</code>. If
+    you start the server as a non-root user, it will fail to change to the
+    specified group, and will instead continue to run as the group of the
+    original user. <var>Unix-group</var> is one of:</p>
+
+    <dl>
+      <dt>A group name</dt>
+      <dd>Refers to the given group by name.</dd>
+
+      <dt><code>#</code> followed by a group number.</dt>
+      <dd>Refers to a group by its number.</dd>
+    </dl>
+
+    <example><title>Example</title>
+      Group www-group
+    </example>
+
+    <p>It is recommended that you set up a new group specifically for
+    running the server. Some admins use user <code>nobody</code>,
+    but this is not always possible or desirable.</p>
+
+    <note type="warning"><title>Security</title>
+      <p>Don't set <directive>Group</directive> (or <directive
+      module="mod_unixd">User</directive>) to <code>root</code> unless
+      you know exactly what you are doing, and what the dangers are.</p>
+    </note>
+
+</usage>
+<seealso><directive module="mod_privileges">VHostGroup</directive></seealso>
+<seealso><directive module="mod_suexec">SuexecUserGroup</directive></seealso>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>User</name>
+<description>The userid under which the server will answer
+requests</description>
+<syntax>User <var>unix-userid</var></syntax>
+<default>User #-1</default>
+<contextlist><context>server config</context></contextlist>
+<compatibility>Only valid in global server config since Apache
+2.0</compatibility>
+
+<usage>
+    <p>The <directive>User</directive> directive sets the user ID as
+    which the server will answer requests. In order to use this
+    directive, the server must be run initially as <code>root</code>.
+    If you start the server as a non-root user, it will fail to change
+    to the lesser privileged user, and will instead continue to run as
+    that original user. If you do start the server as <code>root</code>,
+    then it is normal for the parent process to remain running as root.
+    <var>Unix-userid</var> is one of:</p>
+
+    <dl>
+      <dt>A username</dt>
+      <dd>Refers to the given user by name.</dd>
+
+      <dt># followed by a user number.</dt>
+      <dd>Refers to a user by its number.</dd>
+    </dl>
+
+    <p>The user should have no privileges that result in it being
+    able to access files that are not intended to be visible to the
+    outside world, and similarly, the user should not be able to
+    execute code that is not meant for HTTP requests. It is
+    recommended that you set up a new user and group specifically for
+    running the server. Some admins use user <code>nobody</code>, but
+    this is not always desirable, since the <code>nobody</code> user
+    can have other uses on the system.</p>
+
+    <note type="warning"><title>Security</title>
+      <p>Don't set <directive>User</directive> (or <directive
+      module="mod_unixd">Group</directive>) to <code>root</code> unless
+      you know exactly what you are doing, and what the dangers are.</p>
+    </note>
+
+</usage>
+<seealso><directive module="mod_privileges">VHostUser</directive></seealso>
+<seealso><directive module="mod_suexec">SuexecUserGroup</directive></seealso>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>ChrootDir</name>
+<description>Directory for apache to run chroot(8) after startup.</description>
+<syntax>ChrootDir <var>/path/to/directory</var></syntax>
+<default>none</default>
+<contextlist><context>server config</context></contextlist>
+<modulelist><module>event</module>
+<module>prefork</module><module>worker</module></modulelist>
+
+<usage>
+    <p>This directive, available in httpd 2.2.9(?) and later, tells the
+    server to <var>chroot(8)</var> to the specified directory after
+    startup, but before accepting requests over the 'net.</p>
+    <p>Note that running the server under chroot is not simple,
+    and requires additional setup, particularly if you are running
+    scripts such as CGI or PHP.  Please make sure you are properly
+    familiar with the operation of chroot before attempting to use
+    this feature.</p>
+</usage>
+</directivesynopsis>
+
+</modulesynopsis>
diff --git a/docs/manual/mod/mod_unixd.xml.meta b/docs/manual/mod/mod_unixd.xml.meta
new file mode 100644
index 0000000000..6e9b0ff3da
--- /dev/null
+++ b/docs/manual/mod/mod_unixd.xml.meta
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!-- GENERATED FROM XML: DO NOT EDIT -->
+
+<metafile>
+  <basename>mod_unixd</basename>
+  <path>/mod/</path>
+  <relpath>..</relpath>
+
+  <variants>
+    <variant>en</variant>
+  </variants>
+</metafile>
diff --git a/docs/manual/mod/mpm_common.xml b/docs/manual/mod/mpm_common.xml
index 126b813e04..d428dd9783 100644
--- a/docs/manual/mod/mpm_common.xml
+++ b/docs/manual/mod/mpm_common.xml
@@ -196,63 +196,6 @@ will exit.</description>
 </directivesynopsis>
 
 <directivesynopsis>
-<name>Group</name>
-<description>Group under which the server will answer
-requests</description>
-<syntax>Group <var>unix-group</var></syntax>
-<default>Group #-1</default>
-<contextlist><context>server config</context></contextlist>
-<modulelist><module>beos</module><module>leader</module>
-<module>mpmt_os2</module><module>perchild</module><module>prefork</module>
-<module>threadpool</module><module>worker</module></modulelist>
-<compatibility>Only valid in global server config since Apache
-2.0</compatibility>
-
-<usage>
-    <p>The <directive>Group</directive> directive sets the group under
-    which the server will answer requests. In order to use this
-    directive, the server must be run initially as <code>root</code>. If
-    you start the server as a non-root user, it will fail to change to the
-    specified group, and will instead continue to run as the group of the
-    original user. <var>Unix-group</var> is one of:</p>
-
-    <dl>
-      <dt>A group name</dt>
-      <dd>Refers to the given group by name.</dd>
-
-      <dt><code>#</code> followed by a group number.</dt>
-      <dd>Refers to a group by its number.</dd>
-    </dl>
-
-    <example><title>Example</title>
-      Group www-group
-    </example>
-
-    <p>It is recommended that you set up a new group specifically for
-    running the server. Some admins use user <code>nobody</code>,
-    but this is not always possible or desirable.</p>
-
-    <note type="warning"><title>Security</title>
-      <p>Don't set <directive>Group</directive> (or <directive
-      module="mpm_common">User</directive>) to <code>root</code> unless
-      you know exactly what you are doing, and what the dangers are.</p>
-    </note>
-
-    <p>Special note: Use of this directive in <directive module="core"
-    type="section">VirtualHost</directive> is no longer supported. To
-    configure your server for <program>suexec</program> use
-    <directive module="mod_suexec">SuexecUserGroup</directive>.</p>
-
-    <note><title>Note</title>
-      <p>Although the <directive>Group</directive> directive is present
-      in the <module>beos</module> and <module>mpmt_os2</module> MPMs,
-      it is actually a no-op there and only exists for compatibility
-      reasons.</p>
-    </note>
-</usage>
-</directivesynopsis>
-
-<directivesynopsis>
 <name>PidFile</name>
 <description>File where the server records the process ID
 of the daemon</description>
@@ -955,92 +898,4 @@ client connections</description>
 </usage>
 </directivesynopsis>
 
-<directivesynopsis>
-<name>User</name>
-<description>The userid under which the server will answer
-requests</description>
-<syntax>User <var>unix-userid</var></syntax>
-<default>User #-1</default>
-<contextlist><context>server config</context></contextlist>
-<modulelist><module>leader</module><module>perchild</module>
-<module>prefork</module><module>threadpool</module><module>worker</module>
-</modulelist>
-<compatibility>Only valid in global server config since Apache
-2.0</compatibility>
-
-<usage>
-    <p>The <directive>User</directive> directive sets the user ID as
-    which the server will answer requests. In order to use this
-    directive, the server must be run initially as <code>root</code>.
-    If you start the server as a non-root user, it will fail to change
-    to the lesser privileged user, and will instead continue to run as
-    that original user. If you do start the server as <code>root</code>,
-    then it is normal for the parent process to remain running as root.
-    <var>Unix-userid</var> is one of:</p>
-
-    <dl>
-      <dt>A username</dt>
-      <dd>Refers to the given user by name.</dd>
-
-      <dt># followed by a user number.</dt>
-      <dd>Refers to a user by its number.</dd>
-    </dl>
-
-    <p>The user should have no privileges that result in it being
-    able to access files that are not intended to be visible to the
-    outside world, and similarly, the user should not be able to
-    execute code that is not meant for HTTP requests. It is
-    recommended that you set up a new user and group specifically for
-    running the server. Some admins use user <code>nobody</code>, but
-    this is not always desirable, since the <code>nobody</code> user
-    can have other uses on the system.</p>
-
-    <note type="warning"><title>Security</title>
-      <p>Don't set <directive>User</directive> (or <directive
-      module="mpm_common">Group</directive>) to <code>root</code> unless
-      you know exactly what you are doing, and what the dangers are.</p>
-    </note>
-
-    <p>With the <module>perchild</module> MPM, which is intended to
-    server virtual hosts run under different user IDs, the
-    <directive>User</directive> directive defines the user ID for the
-    main server and the fallback for <directive type="section"
-    module="core">VirtualHost</directive> sections without an
-    <directive module="perchild">AssignUserID</directive> directive.</p>
-
-    <p>Special note: Use of this directive in <directive module="core"
-    type="section">VirtualHost</directive> is no longer supported. To
-    configure your server for <program>suexec</program> use
-    <directive module="mod_suexec">SuexecUserGroup</directive>.</p>
-
-    <note><title>Note</title>
-      <p>Although the <directive>User</directive> directive is present
-      in the <module>beos</module> and <module>mpmt_os2</module> MPMs,
-      it is actually a no-op there and only exists for compatibility
-      reasons.</p>
-    </note>
-</usage>
-</directivesynopsis>
-
-<directivesynopsis>
-<name>ChrootDir</name>
-<description>Directory for apache to run chroot(8) after startup.</description>
-<syntax>ChrootDir <var>/path/to/directory</var></syntax>
-<default>none</default>
-<contextlist><context>server config</context></contextlist>
-<modulelist><module>event</module>
-<module>prefork</module><module>worker</module></modulelist>
-
-<usage>
-    <p>This directive, available in httpd 2.2.9(?) and later, tells the
-    server to <var>chroot(8)</var> to the specified directory after
-    startup, but before accepting requests over the 'net.</p>
-    <p>Note that running the server under chroot is not simple,
-    and requires additional setup, particularly if you are running
-    scripts such as CGI or PHP.  Please make sure you are properly
-    familiar with the operation of chroot before attempting to use
-    this feature.</p>
-</usage>
-</directivesynopsis>
-
 </modulesynopsis>
diff --git a/docs/manual/mod/prefork.xml b/docs/manual/mod/prefork.xml
index febbf5d732..c5288611dd 100644
--- a/docs/manual/mod/prefork.xml
+++ b/docs/manual/mod/prefork.xml
@@ -74,8 +74,8 @@ uses</a></seealso>
     <p>While the parent process is usually started as <code>root</code>
     under Unix in order to bind to port 80, the child processes are
     launched by Apache as a less-privileged user. The <directive
-    module="mpm_common">User</directive> and <directive
-    module="mpm_common">Group</directive> directives are used to set
+    module="mod_unixd">User</directive> and <directive
+    module="mod_unixd">Group</directive> directives are used to set
     the privileges of the Apache child processes. The child processes
     must be able to read all the content that will be served, but
     should have as few privileges beyond that as possible.</p>
@@ -113,9 +113,9 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>StartServers</name>
 </directivesynopsis>
-<directivesynopsis location="mpm_common"><name>User</name>
+<directivesynopsis location="mod_unixd"><name>User</name>
 </directivesynopsis>
-<directivesynopsis location="mpm_common"><name>Group</name>
+<directivesynopsis location="mod_unixd"><name>Group</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>AcceptMutex</name>
 </directivesynopsis>
diff --git a/docs/manual/mod/worker.xml b/docs/manual/mod/worker.xml
index 5593a5f40c..1490cb2d11 100644
--- a/docs/manual/mod/worker.xml
+++ b/docs/manual/mod/worker.xml
@@ -123,8 +123,8 @@ uses</a></seealso>
     <p>While the parent process is usually started as <code>root</code>
     under Unix in order to bind to port 80, the child processes and threads
     are launched by Apache as a less-privileged user. The <directive
-    module="mpm_common">User</directive> and <directive
-    module="mpm_common">Group</directive> directives are used to set
+    module="mod_unixd">User</directive> and <directive
+    module="mod_unixd">Group</directive> directives are used to set
     the privileges of the Apache child processes. The child processes
     must be able to read all the content that will be served, but
     should have as few privileges beyond that as possible. In
@@ -143,7 +143,7 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>EnableExceptionHook</name>
 </directivesynopsis>
-<directivesynopsis location="mpm_common"><name>Group</name>
+<directivesynopsis location="mod_unixd"><name>Group</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>PidFile</name>
 </directivesynopsis>
@@ -179,7 +179,7 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ThreadStackSize</name>
 </directivesynopsis>
-<directivesynopsis location="mpm_common"><name>User</name>
+<directivesynopsis location="mod_unixd"><name>User</name>
 </directivesynopsis>
 
 </modulesynopsis>