| 1 |
commit: 42b434340cf7b3766d892fb07255c490116df2ef |
| 2 |
Author: Devan Franchini <twitch153 <AT> gentoo <DOT> org> |
| 3 |
AuthorDate: Fri Jul 3 04:04:15 2015 +0000 |
| 4 |
Commit: Devan Franchini <twitch153 <AT> gentoo <DOT> org> |
| 5 |
CommitDate: Fri Jul 3 04:49:34 2015 +0000 |
| 6 |
URL: https://gitweb.gentoo.org/proj/webapp-config.git/commit/?id=42b43434 |
| 7 |
|
| 8 |
webapp-config.8.xml: Updates man page in accordance with command line arg changes |
| 9 |
|
| 10 |
Other changes have been made, including: |
| 11 |
* Formatting of command examples |
| 12 |
* Changing short-hand flags to show they no longer require two dashes |
| 13 |
* Adding information on the --prune-database flag. |
| 14 |
* Code cleanup |
| 15 |
|
| 16 |
doc/webapp-config.8.xml | 117 ++++++++++++++++++++++++++++++++++-------------- |
| 17 |
1 file changed, 83 insertions(+), 34 deletions(-) |
| 18 |
|
| 19 |
diff --git a/doc/webapp-config.8.xml b/doc/webapp-config.8.xml |
| 20 |
index 2214d47..13f6baf 100644 |
| 21 |
--- a/doc/webapp-config.8.xml |
| 22 |
+++ b/doc/webapp-config.8.xml |
| 23 |
@@ -70,15 +70,15 @@ |
| 24 |
<arg choice="opt"> |
| 25 |
<option>--bug-report</option> |
| 26 |
</arg> |
| 27 |
- <arg choice="plain"> |
| 28 |
- <option>-I</option> |
| 29 |
- </arg> |
| 30 |
<arg choice="opt"> |
| 31 |
<option>-dghusDE</option> |
| 32 |
<option>--soft</option> |
| 33 |
<option>--copy</option> |
| 34 |
<option>--secure</option> |
| 35 |
</arg> |
| 36 |
+ <arg choice="plain"> |
| 37 |
+ <option>-I</option> |
| 38 |
+ </arg> |
| 39 |
<arg choice="req"> |
| 40 |
<replaceable>app-name</replaceable> |
| 41 |
</arg> |
| 42 |
@@ -92,15 +92,15 @@ |
| 43 |
<arg choice="opt"> |
| 44 |
<option>--bug-report</option> |
| 45 |
</arg> |
| 46 |
- <arg choice="plain"> |
| 47 |
- <option>-U</option> |
| 48 |
- </arg> |
| 49 |
<arg choice="opt"> |
| 50 |
<option>-dghusDE</option> |
| 51 |
<option>--soft</option> |
| 52 |
<option>--copy</option> |
| 53 |
<option>--secure</option> |
| 54 |
</arg> |
| 55 |
+ <arg choice="plain"> |
| 56 |
+ <option>-U</option> |
| 57 |
+ </arg> |
| 58 |
<arg choice="req"> |
| 59 |
<replaceable>app-name</replaceable> |
| 60 |
</arg> |
| 61 |
@@ -114,9 +114,6 @@ |
| 62 |
<arg choice="opt"> |
| 63 |
<option>--bug-report</option> |
| 64 |
</arg> |
| 65 |
- <arg choice="plain"> |
| 66 |
- <option>-C</option> |
| 67 |
- </arg> |
| 68 |
<arg choice="req"> |
| 69 |
<option>-d</option> |
| 70 |
<replaceable>directory</replaceable> |
| 71 |
@@ -124,6 +121,9 @@ |
| 72 |
<arg choice="opt"> |
| 73 |
<replaceable>--secure</replaceable> |
| 74 |
</arg> |
| 75 |
+ <arg choice="plain"> |
| 76 |
+ <option>-C</option> |
| 77 |
+ </arg> |
| 78 |
<arg choice="req"> |
| 79 |
<replaceable>app-name</replaceable> |
| 80 |
</arg> |
| 81 |
@@ -141,8 +141,6 @@ |
| 82 |
<arg> |
| 83 |
<replaceable>app-name</replaceable> |
| 84 |
</arg> |
| 85 |
- </group> |
| 86 |
- <group choice="opt"> |
| 87 |
<arg> |
| 88 |
<replaceable>app-version</replaceable> |
| 89 |
</arg> |
| 90 |
@@ -156,7 +154,7 @@ |
| 91 |
</arg> |
| 92 |
<arg choice="opt"> |
| 93 |
<arg choice="req"> |
| 94 |
- <replaceable>app-version</replaceable> |
| 95 |
+ <replaceable>app-name</replaceable> |
| 96 |
</arg> |
| 97 |
<arg choice="opt"> |
| 98 |
<replaceable>app-version</replaceable> |
| 99 |
@@ -167,6 +165,21 @@ |
| 100 |
<cmdsynopsis> |
| 101 |
<command>webapp-config</command> |
| 102 |
<arg choice="plain"> |
| 103 |
+ <option>--prune-database</option> |
| 104 |
+ </arg> |
| 105 |
+ <group choice="plain"> |
| 106 |
+ <arg choice="req"> |
| 107 |
+ <replaceable>pretend</replaceable> |
| 108 |
+ </arg> |
| 109 |
+ <arg choice="req"> |
| 110 |
+ <replaceable>clean</replaceable> |
| 111 |
+ </arg> |
| 112 |
+ </group> |
| 113 |
+ </cmdsynopsis> |
| 114 |
+ |
| 115 |
+ <cmdsynopsis> |
| 116 |
+ <command>webapp-config</command> |
| 117 |
+ <arg choice="plain"> |
| 118 |
<option>--show-installed</option> |
| 119 |
</arg> |
| 120 |
<group choice="opt"> |
| 121 |
@@ -182,10 +195,10 @@ |
| 122 |
<arg choice="plain"> |
| 123 |
<option>--show-postinst</option> |
| 124 |
</arg> |
| 125 |
- <arg choice="plain"> |
| 126 |
+ <arg choice="req"> |
| 127 |
<replaceable>app-name</replaceable> |
| 128 |
</arg> |
| 129 |
- <arg choice="plain"> |
| 130 |
+ <arg choice="req"> |
| 131 |
<replaceable>app-version</replaceable> |
| 132 |
</arg> |
| 133 |
</cmdsynopsis> |
| 134 |
@@ -193,11 +206,21 @@ |
| 135 |
<cmdsynopsis> |
| 136 |
<command>webapp-config</command> |
| 137 |
<group choice="plain"> |
| 138 |
- <arg>--list-servers</arg> |
| 139 |
- <arg>-v</arg> |
| 140 |
- <arg>--version</arg> |
| 141 |
- <arg>-h</arg> |
| 142 |
- <arg>--help</arg> |
| 143 |
+ <arg choice="plain"> |
| 144 |
+ <option>--list-servers</option> |
| 145 |
+ </arg> |
| 146 |
+ <arg choice="plain"> |
| 147 |
+ <option>-v</option> |
| 148 |
+ </arg> |
| 149 |
+ <arg choice="plain"> |
| 150 |
+ <option>--version</option> |
| 151 |
+ </arg> |
| 152 |
+ <arg choice="plain"> |
| 153 |
+ <option>-h</option> |
| 154 |
+ </arg> |
| 155 |
+ <arg choice="plain"> |
| 156 |
+ <option>--help</option> |
| 157 |
+ </arg> |
| 158 |
</group> |
| 159 |
</cmdsynopsis> |
| 160 |
|
| 161 |
@@ -264,32 +287,32 @@ |
| 162 |
<title>Actions</title> |
| 163 |
<variablelist> |
| 164 |
<varlistentry> |
| 165 |
- <term><option>-I</option></term> |
| 166 |
- <term><option>--install</option></term> |
| 167 |
+ <term><option>-I</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 168 |
+ <term><option>--install</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 169 |
<listitem> |
| 170 |
<para>Activate <emphasis>install mode</emphasis>.</para> |
| 171 |
</listitem> |
| 172 |
</varlistentry> |
| 173 |
|
| 174 |
<varlistentry> |
| 175 |
- <term><option>-U</option></term> |
| 176 |
- <term><option>--upgrade</option></term> |
| 177 |
+ <term><option>-U</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 178 |
+ <term><option>--upgrade</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 179 |
<listitem> |
| 180 |
<para>Activate <emphasis>upgrade mode</emphasis>.</para> |
| 181 |
</listitem> |
| 182 |
</varlistentry> |
| 183 |
|
| 184 |
<varlistentry> |
| 185 |
- <term><option>-C</option></term> |
| 186 |
- <term><option>--clean</option></term> |
| 187 |
+ <term><option>-C</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 188 |
+ <term><option>--clean</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 189 |
<listitem> |
| 190 |
<para>Activate <emphasis>remove mode</emphasis>.</para> |
| 191 |
</listitem> |
| 192 |
</varlistentry> |
| 193 |
|
| 194 |
<varlistentry> |
| 195 |
+ <term><option>-li</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 196 |
<term><option>--list-installs</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 197 |
- <term><option>--li</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 198 |
<listitem> |
| 199 |
<para>Outputs a list of all the virtual copies of the <replaceable>app-name</replaceable>-<replaceable>app-version</replaceable> package.</para> |
| 200 |
<para>If you omit <replaceable>app-name</replaceable> or <replaceable>app-version</replaceable> webapp-config will display all available packages/versions.</para> |
| 201 |
@@ -297,16 +320,39 @@ |
| 202 |
</varlistentry> |
| 203 |
|
| 204 |
<varlistentry> |
| 205 |
+ <term><option>-lui</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 206 |
<term><option>--list-unused-installs</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 207 |
- <term><option>--lui</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 208 |
<listitem> |
| 209 |
<para>Outputs a list of all the master copies of the <replaceable>app-name</replaceable>-<replaceable>app-version</replaceable> package that have not been installed using <command>webapp-config</command> <option>-I</option>.</para> |
| 210 |
</listitem> |
| 211 |
</varlistentry> |
| 212 |
|
| 213 |
<varlistentry> |
| 214 |
+ <term><option>-pd</option> <replaceable>action</replaceable></term> |
| 215 |
+ <term><option>--prune-database</option> <replaceable>action</replaceable></term> |
| 216 |
+ <listitem> |
| 217 |
+ <para>Cleans up the installed webapps database for lingering uninstalled webapps. Behavior is determined by the <replaceable>action</replaceable> given.</para> |
| 218 |
+ <para><replaceable>action</replaceable> must be one of:</para> |
| 219 |
+ <variablelist> |
| 220 |
+ <varlistentry> |
| 221 |
+ <term>pretend</term> |
| 222 |
+ <listitem> |
| 223 |
+ <para>Shows output of what would be cleaned from the database</para> |
| 224 |
+ </listitem> |
| 225 |
+ </varlistentry> |
| 226 |
+ <varlistentry> |
| 227 |
+ <term>clean</term> |
| 228 |
+ <listitem> |
| 229 |
+ <para>Removes webapp entries that are not installed on the system</para> |
| 230 |
+ </listitem> |
| 231 |
+ </varlistentry> |
| 232 |
+ </variablelist> |
| 233 |
+ </listitem> |
| 234 |
+ </varlistentry> |
| 235 |
+ |
| 236 |
+ <varlistentry> |
| 237 |
+ <term><option>-si</option></term> |
| 238 |
<term><option>--show-installed</option></term> |
| 239 |
- <term><option>--si</option></term> |
| 240 |
<listitem> |
| 241 |
<para>Outputs the app-name and app-version of the application installed in <replaceable>directory</replaceable>.</para> |
| 242 |
<para>Use the <option>-d</option> switch to tell <command>webapp-config</command> which <replaceable>directory</replaceable> to look in. <replaceable>directory</replaceable> is a directory under the htdocs dir.</para> |
| 243 |
@@ -314,24 +360,24 @@ |
| 244 |
</varlistentry> |
| 245 |
|
| 246 |
<varlistentry> |
| 247 |
+ <term><option>-spi</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 248 |
<term><option>--show-postinst</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 249 |
- <term><option>--spi</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 250 |
<listitem> |
| 251 |
<para>Displays the post-installation instructions of the <replaceable>app-name</replaceable>-<replaceable>app-version</replaceable> package. Very handy if you didn't see them displayed when the package was installed.</para> |
| 252 |
</listitem> |
| 253 |
</varlistentry> |
| 254 |
|
| 255 |
<varlistentry> |
| 256 |
+ <term><option>-spu</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 257 |
<term><option>--show-postupgrade</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 258 |
- <term><option>--spu</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term> |
| 259 |
<listitem> |
| 260 |
<para>Displays the post-upgrade instructions of the <replaceable>app-name</replaceable>-<replaceable>app-version</replaceable> package. Very handy if you didn't see them displayed when the package was upgraded.</para> |
| 261 |
</listitem> |
| 262 |
</varlistentry> |
| 263 |
|
| 264 |
<varlistentry> |
| 265 |
+ <term><option>-ls</option></term> |
| 266 |
<term><option>--list-servers</option></term> |
| 267 |
- <term><option>--ls</option></term> |
| 268 |
<listitem> |
| 269 |
<para>Outputs a list of the web servers that <command>webapp-config</command> currently supports.</para> |
| 270 |
<para>Use the <option>-s</option> <replaceable>server</replaceable> switch to change which web-server an install or upgrade should use.</para> |
| 271 |
@@ -485,6 +531,7 @@ |
| 272 |
</varlistentry> |
| 273 |
|
| 274 |
<varlistentry> |
| 275 |
+ <term><option>-sf</option></term> |
| 276 |
<term><option>--soft</option></term> |
| 277 |
<listitem> |
| 278 |
<para>Use this option to create the virtual copy using symbolic links.</para> |
| 279 |
@@ -493,6 +540,7 @@ |
| 280 |
</varlistentry> |
| 281 |
|
| 282 |
<varlistentry> |
| 283 |
+ <term><option>-c</option></term> |
| 284 |
<term><option>--copy</option></term> |
| 285 |
<listitem> |
| 286 |
<para>Use this option to create the virtual copy by copying the files from the <filename>/usr/share/webapps/</filename> directories.</para> |
| 287 |
@@ -501,6 +549,7 @@ |
| 288 |
</varlistentry> |
| 289 |
|
| 290 |
<varlistentry> |
| 291 |
+ <term><option>-S</option></term> |
| 292 |
<term><option>--secure</option></term> |
| 293 |
<listitem> |
| 294 |
<para>Use this option to install into the <filename>htdocs-secure</filename> directory rather than into the <filename>htdocs</filename> directory.</para> |
| 295 |
@@ -510,8 +559,8 @@ |
| 296 |
</varlistentry> |
| 297 |
|
| 298 |
<varlistentry> |
| 299 |
- <term><option>--default-dirs</option></term> |
| 300 |
- <term><option>--dd</option></term> |
| 301 |
+ <term><option>-dd</option> <replaceable>type</replaceable></term> |
| 302 |
+ <term><option>--default-dirs</option> <replaceable>type</replaceable></term> |
| 303 |
<listitem> |
| 304 |
<para><replaceable>type</replaceable> must be one of:</para> |
| 305 |
<variablelist> |
| 306 |
@@ -538,8 +587,8 @@ |
| 307 |
</varlistentry> |
| 308 |
|
| 309 |
<varlistentry> |
| 310 |
+ <term><option>-vf</option> <replaceable>type</replaceable></term> |
| 311 |
<term><option>--virtual-files</option> <replaceable>type</replaceable></term> |
| 312 |
- <term><option>--vf</option> <replaceable>type</replaceable></term> |
| 313 |
<listitem> |
| 314 |
<para><replaceable>type</replaceable> must be one of:</para> |
| 315 |
<variablelist> |
Archives