summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDevan Franchini <twitch153@gentoo.org>2014-09-23 12:50:02 -0400
committerDevan Franchini <twitch153@gentoo.org>2015-06-19 15:44:32 -0400
commitb6b9a1ab369704fe2f65259aa5d1f45bf843d2ee (patch)
treebcb0de7dc7fada084580eea3d1572605c285489a
parent{config, debug}.py: Removes deprecated use of __dict__ invocation (diff)
downloadwebapp-config-b6b9a1ab369704fe2f65259aa5d1f45bf843d2ee.tar.gz
webapp-config-b6b9a1ab369704fe2f65259aa5d1f45bf843d2ee.tar.bz2
webapp-config-b6b9a1ab369704fe2f65259aa5d1f45bf843d2ee.zip
webapp-config.8.xml: clarifies man page for --dd and --vf flags
This commit corrects a typo where the short option for --default-dirs is --vd instead of --dd, this has been corrected. Secondly, it also attempts to make it clearer to the user that the --dd and --vf options are two separate options and should not be treated equally by listing them in two separate variable list entries. X-Gentoo-Bug: 257592 X-Gentoo-Bug-URL: https://bugs.gentoo.org/257592
-rw-r--r--doc/webapp-config.8.xml36
1 files changed, 31 insertions, 5 deletions
diff --git a/doc/webapp-config.8.xml b/doc/webapp-config.8.xml
index e4141a1..5ab475d 100644
--- a/doc/webapp-config.8.xml
+++ b/doc/webapp-config.8.xml
@@ -502,8 +502,34 @@
</varlistentry>
<varlistentry>
- <term><option>--default-dirs</option> <replaceable>type</replaceable></term>
- <term><option>--vd</option> <replaceable>type</replaceable></term>
+ <term><option>--default-dirs</option></term>
+ <term><option>--dd</option></term>
+ <listitem>
+ <para><replaceable>type</replaceable> must be one of:</para>
+ <variablelist>
+ <varlistentry>
+ <term>server-owned</term>
+ <listitem>
+ <para>Directories are owned by the user that the web server runs as. Use the <option>-s</option> switch to specify which web server to use.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>config-owned</term>
+ <listitem>
+ <para>Directories are owned by the user and group specified with the <option>-u</option> and <option>-g</option> switches.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>virtual</term>
+ <listitem>
+ <para>Directories are shared; no local copy is created.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>--virtual-files</option> <replaceable>type</replaceable></term>
<term><option>--vf</option> <replaceable>type</replaceable></term>
<listitem>
@@ -512,19 +538,19 @@
<varlistentry>
<term>server-owned</term>
<listitem>
- <para>Directories or files are owned by the user that the web server runs as. Use the <option>-s</option> switch to specify which web server to use.</para>
+ <para>Files are owned by the user that the web server runs as. Use the <option>-s</option> switch to specify which web server to use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>config-owned</term>
<listitem>
- <para>Directories or files are owned by the user and group specified with the <option>-u</option> and <option>-g</option> switches.</para>
+ <para>Files are owned by the user and group specified with the <option>-u</option> and <option>-g</option> switches.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>virtual</term>
<listitem>
- <para>Directories or files are shared; no local copy is created.</para>
+ <para>Files are shared; no local copy is created.</para>
</listitem>
</varlistentry>
</variablelist>