[gentoo-commits] proj/webapp-config:experimental commit in: doc/

[gentoo-commits] proj/webapp-config:experimental commit in: doc/

[Devan Franchini]

commit:     a00c4e7d07a96d61dafd9b1ea5afd39b24148bb6
Author:     Devan Franchini <twitch153 <AT> gentoo <DOT> org>
AuthorDate: Mon Jan  6 06:32:08 2014 +0000
Commit:     Devan Franchini <twitch153 <AT> gentoo <DOT> org>
CommitDate: Mon Jan  6 06:32:08 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/webapp-config.git;a=commit;h=a00c4e7d

doc/webapp-config.8.xml: Improves man page synopsis.

Improvements done to the synopsis of webapp-config include the
following: including the --copy, --soft, and --secure flags with the
synopsis for the -U flag to indicate to the user that these flags are
also usable with this flag. Adding the necessary opts app-name and
app-version for the -C flag to indicate to users that these two args are
necessary when uninstalling a webapp. And adding the --secure flag to
the synopsis for the -C flag to indicate that it is an optional arg if
the --secure flag is used with the -I flag or -U flag.

X-Gentoo-Bug: 496568
X-Gentoo-Bug-URL: https://bugs.gentoo.org/496568

---
 doc/webapp-config.8.xml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/webapp-config.8.xml b/doc/webapp-config.8.xml
index 459e301..e4141a1 100644
--- a/doc/webapp-config.8.xml
+++ b/doc/webapp-config.8.xml
@@ -89,6 +89,9 @@
 	  </arg>
 	  <arg choice="opt">
 	    <option>-dghusDE</option>
+	    <option>--soft</option>
+	    <option>--copy</option>
+	    <option>--secure</option>
 	  </arg>
 	  <arg choice="req">
 	    <replaceable>app-name</replaceable>
@@ -110,6 +113,15 @@
 	    <option>-d</option>
 	    <replaceable>directory</replaceable>
 	  </arg>
+	  <arg choice="opt">
+	    <replaceable>--secure</replaceable>
+	  </arg>
+	  <arg choice="req">
+	    <replaceable>app-name</replaceable>
+	  </arg>
+	  <arg choice="req">
+	    <replaceable>app-version</replaceable>
+	  </arg>
 	</cmdsynopsis>
 
 	<cmdsynopsis>

[gentoo-commits] proj/webapp-config:experimental commit in: doc/

[Devan Franchini]

commit:     f6cd6abf825f776489acaf5f584a1b21d141d0ea
Author:     Devan Franchini <twitch153 <AT> gentoo <DOT> org>
AuthorDate: Tue Sep 23 16:50:02 2014 +0000
Commit:     Devan Franchini <twitch153 <AT> gentoo <DOT> org>
CommitDate: Tue Sep 23 17:06:41 2014 +0000
URL:        http://sources.gentoo.org/gitweb/?p=proj/webapp-config.git;a=commit;h=f6cd6abf

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

---
 doc/webapp-config.8.xml | 36 +++++++++++++++++++++++++++++++-----
 1 file 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>