* [gentoo-commits] proj/webapp-config:master commit in: doc/
@ 2012-06-28 0:37 Anthony G. Basile
0 siblings, 0 replies; 7+ messages in thread
From: Anthony G. Basile @ 2012-06-28 0:37 UTC (permalink / raw
To: gentoo-commits
commit: 94f241acb9a3998c1ea41fe74a44091b1dff72eb
Author: Anthony G. Basile <blueness <AT> gentoo <DOT> org>
AuthorDate: Thu Jun 28 00:37:22 2012 +0000
Commit: Anthony G. Basile <blueness <AT> gentoo <DOT> org>
CommitDate: Thu Jun 28 00:37:22 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/webapp-config.git;a=commit;h=94f241ac
Clean up doc, readdress gentoo bug #322759
---
doc/Makefile | 4 +-
doc/{webapp.eclass.5.xml => webapp-eclass.5.xml} | 0
doc/webapp-eclass.xml | 567 ----------------------
3 files changed, 2 insertions(+), 569 deletions(-)
diff --git a/doc/Makefile b/doc/Makefile
index aaace8a..4dc8e44 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -14,8 +14,8 @@
#
# ========================================================================
-MAN_PAGES = webapp-config.8 webapp-config.5 webapp.eclass.5
-HTML_PAGES = webapp-config.8.html webapp-config.5.html webapp.eclass.5.html
+MAN_PAGES = webapp-config.8 webapp-config.5 webapp-eclass.5
+HTML_PAGES = webapp-config.8.html webapp-config.5.html webapp-eclass.5.html
TMPFILE=./webapp-config.man
diff --git a/doc/webapp.eclass.5.xml b/doc/webapp-eclass.5.xml
similarity index 100%
rename from doc/webapp.eclass.5.xml
rename to doc/webapp-eclass.5.xml
diff --git a/doc/webapp-eclass.xml b/doc/webapp-eclass.xml
deleted file mode 100644
index 569b353..0000000
--- a/doc/webapp-eclass.xml
+++ /dev/null
@@ -1,567 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/webapps/webapp-eclass.xml,v 1.3 2006/01/19 16:43:24 rl03 Exp $ -->
-
-<guide link="/proj/en/webapps/webapp-eclass.xml" lang="en">
-<title>webapp.eclass Documentation</title>
-
-<author title="Author">
- <mail link="rl03@gentoo.org">Renat Lumpau</mail>
-</author>
-
-<abstract>
-The goal of this guide is to teach the reader how to create and maintain ebuilds
-for web applications. It presents an overview of the webapp.eclass and then
-discusses three ebuilds of increasing complexity and functionality.
-</abstract>
-
-<!-- The content of this document is licensed under the CC-BY-SA license -->
-<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
-<license/>
-
-<version>1.0</version>
-<date>2006-01-17</date>
-
-<chapter>
-<title>Introduction</title>
-<section>
-<title>Background</title>
-<body>
-
-<p>
-<c>webapp.eclass</c> and <c>webapp-config</c> provide a standardized way to
-maintain web applications on Gentoo. Server administrators can use the
-<c>webapp-config</c> utility to install, upgrade, and remove software.
-<c>webapp-config</c> relies on a package manager such as Portage to prepare
-the application for installation into multiple virtual hosts. On Gentoo, this
-is done by an ebuild that uses <c>webapp.eclass</c>.
-</p>
-
-<p>
-The goal of this guide is to teach the reader how to create and maintain
-ebuilds for web applications. It presents an overview of the
-<c>webapp.eclass</c> and then discusses three ebuilds of increasing complexity
-and functionality. Using the <c>webapp-config</c> utility is beyond the scope
-of this guide and is documented in <c>man 8 webapp-config</c>.
-</p>
-
-</body>
-</section>
-<section>
-<title>Prerequisites</title>
-<body>
-
-<p>
-This guide assumes a basic familiarity with Portage and the ebuild format. Both
-are well-documented; the reader is encouraged to consult the <uri
-link="/proj/en/devrel/handbook/handbook.xml">official ebuild HOWTO</uri> and
-the unofficial <uri
-link="http://dev.gentoo.org/~plasmaroo/devmanual/">devmanual</uri>.
-</p>
-
-<p>
-<c>webapp-config</c> is under active development. Be sure to install the latest
-version; as of the time of this writing, it is 1.50.7. You can follow the
-development process on our <uri
-link="http://www.vhost-tools.org/">website</uri>.
-</p>
-
-</body>
-</section>
-<section>
-<title>A standardized approach to installing web applications</title>
-<body>
-
-<p>
-Gentoo has developed a standardized way of handling web applications. It is
-outlined in <uri link="/proj/en/glep/glep-0011.html">GLEP 11</uri> and
-discussed in detail in <c>man 5 webapp.eclass</c>. The reader is urged to
-familiarize himself with these documents before proceeding. The manpage also
-outlines the filesystem locations into which the eclass and
-<c>webapp-config</c> install files; advanced users and developers should take
-note.
-</p>
-
-<p>
-The <c>webapp.eclass</c> is located in the usual place in the Portage tree. By
-default, it will be found in <path>/usr/portage/eclass/webapp.eclass</path>. By
-definition, the source code is the ultimate documentation and should be
-consulted whenever something does not perform as expected or further
-clarification is required.
-</p>
-</body>
-</section>
-</chapter>
-
-<chapter>
-<title>Writing Ebuilds</title>
-<section>
-<title>Beginner: www-apps/gallery-2.0.2</title>
-<body>
-
-<p>
-Many web applications require no compilation and are installed by copying their
-files to a directory to be served by a httpd server such as Apache. The
-<c>webapp.eclass</c> simplifies this task by preparing the necessary set of
-directories.
-</p>
-
-<p>
-Let's take a look at a simple ebuild for <uri
-link="http://sources.gentoo.org/viewcvs.py/gentoo-x86/www-apps/gallery">www-apps/gallery-2.0.2</uri>.
-To use any of the functions in the eclass, the ebuild must first inherit it:
-</p>
-
-<pre caption="Inheriting the eclass">
-inherit webapp.eclass
-</pre>
-
-<p>
-The ebuild then sets several standard variables, such as <c>DESCRIPTION</c>,
-<c>IUSE</c>, <c>RDEPEND</c>, and <c>S</c>. The first important note is that
-ebuilds that use the <c>webapp.eclass</c> do not typically set the <c>SLOT</c>
-variable (the rationale for this is described in the manpage). <uri
-link="#doc_chap2_sect3">Section 2.3</uri> will explain how <c>SLOT</c> can be
-set when it is truly needed, but for now we will let the eclass handle it.
-</p>
-
-<note>
-Unless explicitly overridden, the eclass sets <c>SLOT="${PVR}"</c>. One
-important downside of this behavior is that security revision bumps are no
-longer possible. This is unfortunate and will be changed soon.
-</note>
-
-<p>
-<path>www-apps/gallery-2.0.2</path> does not require patching or compiling, so
-the ebuild does not call <c>src_unpack</c> or <c>src_compile</c>; installation
-is handled in <c>src_install</c>. The first thing <c>src_install</c> does is
-call a special helper function that sets up the required directory structure:
-</p>
-
-<pre caption="Setting up src_install">
-src_install() {
- webapp_src_preinst
-</pre>
-
-<p>
-This function is required of all ebuilds that use the <c>webapp.eclass</c> and
-override the default <c>src_install</c>.
-</p>
-
-<p>
-Having set up the environment, the ebuild installs the web application:
-</p>
-
-<pre caption="Installing">
-cp -R * ${D}/${MY_HTDOCSDIR}
-</pre>
-
-<p>
-<c>${MY_HTDOCSDIR}</c> is one of the variables exported by
-<c>webapp_src_preinst</c>. Files placed there will be copied into the right
-directory under the webserver's document root by <c>webapp-config</c>. For a
-full list of variables exported by the eclass, please see the manpage.
-</p>
-
-<p>
-Next, the ebuild marks a file in <c>${FILESDIR}</c> as a file containing
-instructions to be displayed by <c>webapp-config</c> after the application has
-been installed:
-</p>
-
-<pre caption="Post-install instructions">
-webapp_postinst_txt en ${FILESDIR}/postinstall-en2.txt
-</pre>
-
-<note>
-A careful reader will observe that it is customary for other ebuilds to display
-instructions to the user in <c>pkg_postinst</c>. Ebuilds that inherit
-<c>webapp.eclass</c> may still do so, but the ebuild author should understand
-the important difference in usage. More often than not, post-install
-instructions include information specific to a virtual host, such as locations
-of a particular configuration file or a URL to access the web application
-remotely. This information is not available to Portage and cannot be included
-in <c>pkg_postinst</c>. Instead, it should be included in a post-install file
-and installed using <c>webapp_postinstall_txt</c>.
-</note>
-
-<p>
-Let's examine a typical post-install file:
-</p>
-
-<pre caption="Post-install file">
- 0. Create a new MySQL database:
- mysqladmin create geeklog
-
- 1. Edit ${VHOST_ROOT}/${PN}-${PVR}/config.php and set database settings.
-
- 2. Login on
- http://${VHOST_HOSTNAME}/${VHOST_APPDIR}/admin/install/install.php
- and follow the directions.
-
- 3. Don't forget to delete the admin/install directory when you're done!
-</pre>
-
-<p>
-Post-install instruction files are plain text files. They can contain
-bash-style variables (e.g., <c>${PN}</c>) that will be expanded at display
-time. The <c>webapp-config</c> utility responsible for displaying the file
-exports a number of variables that allow for the customization of instructions.
-Consult the manpage for a list of available variables.
-</p>
-
-<p>
-Finally, the ebuild calls another mandatory helper function:
-</p>
-
-<pre caption="webapp_src_install">
-webapp_src_install
-</pre>
-
-<p>
-<c>webapp_src_install</c> is responsible for setting the right permissions on
-installed files.
-</p>
-
-<p>
-There are several best practices for writing simple ebuilds:
-</p>
-
-<ul>
- <li>
- Don't copy unneeded files. Some packages include <path>.svn</path> or
- <path>CVS</path> directories or <path>Makefiles</path>; those should be
- removed prior to installation. Note that the <path>LICENSE</path> file is
- sometimes needed by the application and should not be removed.
- </li>
- <li>
- Ensure that consecutive calls to all ebuild functions succeed. For
- instance, don't remove files outside of <c>src_unpack</c>. If you must,
- remove files from <c>${D}</c> rather than <c>${S}</c>.
- </li>
- <li>
- For portability purposes, don't use GNU-only extensions such as <c>cp
- -a</c>. They will break on non-GNU userlands such as Gentoo/FreeBSD.
- </li>
-</ul>
-
-</body>
-</section>
-<section>
-<title>Intermediate: www-apps/tikiwiki-1.9.2</title>
-<body>
-
-<p>
-Many web applications have a more complicated installation procedure. Let's
-look at how <uri
-link="http://sources.gentoo.org/viewcvs.py/gentoo-x86/www-apps/tikiwiki">www-apps/tikiwiki-1.9.2</uri>
-handles one such package. After inheriting the eclass, the ebuild specifies a
-number of required and optional dependencies.
-</p>
-
-<pre caption="Specifying Dependencies">
-RDEPEND="virtual/php
- mysql? ( >=dev-db/mysql-4 )
- postgres? ( dev-db/postgresql )
- graphviz? ( media-gfx/graphviz )
-"
-</pre>
-
-<p>
-Many web-applications written in PHP require that the PHP binary have certain
-capabilities built-in; common requirements include support for sessions and a
-specific database engine. This is typically accomplished by using the
-<c>depend.php</c> eclass; unfortunately, the author is not aware of any existing
-documentation for that eclass. The reader is referred to the eclass itself for
-further information and encouraged to consult relevant ebuilds in Portage.
-</p>
-
-<warn>
-If the package requires specific Perl modules, all dependencies must have
-ebuilds available. Relying on CPAN is not acceptable.
-</warn>
-
-<p>
-A common mistake with specifying dependencies for web applications is to
-unconditionally <c>RDEPEND</c> on a database engine such as MySQL or
-PostgreSQL. Many, if not all, web applications are able to connect to a remote
-database server. Thus, a local database should not be a requirement; the right
-syntax for dealing with this is:
-</p>
-
-<pre caption="Database Dependencies">
-mysql? ( >=dev-db/mysql-4 )
-</pre>
-
-<note>
-It is currently not possible to depend on a generic webserver. Instead, you
-must explicitly specify the webserver (e.g., <path>net-www/apache</path>). This
-is inconvenient and has been reported in <uri
-link="http://bugs.gentoo.org/show_bug.cgi?id=11007">bug #11007</uri>; we hope
-that this issue will be resolved soon.
-</note>
-
-<p>
-<path>www-apps/tikiwiki</path> does not use <c>depend.php</c> and instead uses
-<c>pkg_setup</c> to print a warning:
-</p>
-
-<pre caption="pkg_setup()">
-pkg_setup () {
- webapp_pkg_setup
- einfo "Make sure your PHP is compiled with mysql or postgres support"
- einfo "If you need PDF generation, make sure your PHP is emerged with xml2"
-}
-</pre>
-
-<p>
-Note the use of a mandatory helper function <c>webapp_pkg_setup</c>.
-</p>
-
-<p>
-Many web applications require write access to certain files. The eclass
-provides a helper function that marks a file as server-owned; at install time,
-<c>webapp-config</c> will ensure that it has the right owner and permissions:
-</p>
-
-<pre caption="webapp_serverowned">
-webapp_serverowned ${MY_HTDOCSDIR}/tiki-install.php
-</pre>
-
-<p>
-<c>webapp_serverowned</c> takes an optional <c>-R</c> flag to recurse into
-subdirectories. This flag has been added recently and not many ebuilds take
-advantage of it. Please consult the manpage for more information.
-</p>
-
-<p>
-Practically all web applications use configuration files to store settings.
-Such files should not be placed into <path>/etc</path> (figuring out the
-rationale is left as an exercise for the reader). To avoid losing important
-configuration information, the eclass provides another helper function that
-will instruct <c>webapp-config</c> not to overwrite an existing file. The
-administrator can use familiar tools such as <c>etc-update</c> or
-<c>dispatch-conf</c> to manage such files.
-</p>
-
-<pre caption="webapp_configfile">
-webapp_configfile ${MY_HTDOCSDIR}/config.php
-</pre>
-
-<p>
-Note that it is currently not possible to mark a file as both server-owned and
-config-protected. This has been fixed in an upcoming version of
-<c>webapp-config</c>. For now, there is a workaround described in <uri
-link="#doc_chap2_sect3">Section 2.3</uri>.
-</p>
-
-<p>
-To ease upgrades of web applications, the eclass provides a helper function
-that displays instructions when an existing installation is being upgraded:
-</p>
-
-<pre caption="Post-upgrade file">
-webapp_postupgrade_txt en ${FILESDIR}/postupgrade-en.txt
-</pre>
-
-<p>
-Even though no ebuilds in Portage currently take advantage this functionality,
-the reader is encouraged to use it in his ebuilds.
-</p>
-
-<p>
-The ebuild calls the familiar helper function to complete the installation.
-Note an important consequence of using <c>webapp_src_install</c> to set the
-correct file permissions: any manual adjustments to file permissions and
-ownership via <c>fowners</c> and <c>fperms</c> must occur <e>after</e>
-<c>webapp_src_install</c> is called.
-</p>
-
-<pre caption="Adjusting permissions">
-webapp_src_install
-fperms 0644 /etc/zm.conf
-</pre>
-
-<p>
-The tikiwiki ebuild displays some brief notes using <c>pkg_postinst</c>. Note
-the use of another helper function:
-</p>
-
-<pre caption="pkg_postinst">
-pkg_postinst() {
- einfo "To setup a MySQL database, run:"
- einfo "\"emerge --config =${PF}\""
- einfo "If you are using PostgreSQL, consult your documentation"
- webapp_pkg_postinst
-}
-</pre>
-
-<p>
-Strictly speaking, <c>webapp_pkg_postinst</c> is not mandatory. It is
-responsible for automatically calling <c>webapp-config</c> when the
-<c>vhosts</c> USE flag is unset. In rare instances it may be desirable to
-override this behavior; please consult <path>www-apps/otrs</path> for an
-example.
-</p>
-
-</body>
-</section>
-<section>
-<title>Advanced: www-apps/moinmoin-1.5.0</title>
-<body>
-
-<p>
-This section presents an overview of more advanced installation tasks provided
-by the <c>webapp.eclass</c>. An example of this functionality is <uri
-link="http://sources.gentoo.org/viewcvs.py/gentoo-x86/www-apps/moinmoin">www-apps/moinmoin-1.5.0</uri>.
-</p>
-
-<p>
-<c>moinmoin</c> is a wiki engine written in Python that uses <c>distutils</c>
-to install itself. Thus, it requires <c>SLOT="0"</c> to avoid collisions.
-Ebuilds that inherit <c>webapp.eclass</c> must set
-<c>WEBAPP_MANUAL_SLOT="yes"</c> to override the default <c>SLOT</c>ting
-behavior:
-</p>
-
-<pre caption="Setting SLOT">
-SLOT="0"
-WEBAPP_MANUAL_SLOT="yes"
-</pre>
-
-<note>
-The <c>yes</c> in <c>WEBAPP_MANUAL_SLOT="yes"</c> is case-sensitive.
-</note>
-
-<p>
-<c>moinmoin</c> installs files that should not be served by the webserver. The
-ebuild places such files in <c>${MY_HOSTROOTDIR}/${PF}</c>.
-</p>
-
-<pre caption="Installing into dodir ${MY_HOSTROOTDIR}/${PF}">
-dodir ${MY_HOSTROOTDIR}/${PF}
-cp -r data underlay config/wikiconfig.py ${D}/${MY_HOSTROOTDIR}/${PF}
-</pre>
-
-<p>
-A best practice for installing any application via Portage is to ensure it
-operates out of the proverbial box with sensible defaults. The eclass
-implements a helper function to aid with configuring the application after it
-has been installed by <c>webapp-config</c>.
-</p>
-
-<pre caption="webapp_hook_script">
-webapp_hook_script ${FILESDIR}/reconfig-2
-</pre>
-
-<p>
-The reconfig hook is a script, typically written in bash, that is invoked by
-<c>webapp-config</c> after installation and before removal.
-</p>
-
-<pre caption="Reconfig hook">
-#!/bin/bash
-
-die() {
- echo "#####"
- echo $1
- echo "#####"
- exit 1
-}
-
-if [ $1 = "install" ]; then
- sed -e "s|/path/to/wikiconfig|${VHOST_ROOT}/${PN}-${PVR}|g" \
- -i ${MY_INSTALLDIR}/moin.cgi || die "sed failed"
- sed -e "s|\./data/|${VHOST_ROOT}/${PN}-${PVR}/data|
- s|\./underlay/|${VHOST_ROOT}/${PN}-${PVR}/underlay|" \
- -i ${VHOST_ROOT}/${PN}-${PVR}/wikiconfig.py || die "sed failed"
-
-elif [ $1 = "clean" ]; then
- echo $1
-fi
-</pre>
-
-<p>
-The reconfig hook can use the same variables as the postinstall file. It is
-typically used to edit configuration files to set file locations that may
-differ from the default values. As of <c>webapp-config-1.50</c>, reconfig hooks
-are run in a sandbox to minimize risk; please consult the manpage for more
-details.
-</p>
-
-<p>
-There are several best practices for using reconfig hooks:
-</p>
-
-<ul>
- <li>Die with an error message if the script failed</li>
- <li>
- Be careful about removing files when called with <c>clean</c>. Don't remove
- configuration files or any other files that may have been locally
- modified.
- </li>
- <li>
- To mark a file as both config-protected and server-owned, use
- <c>webapp_configfile</c> from the ebuild and use the reconfig hook to mark
- it as server-owned:
- </li>
-</ul>
-
-<pre caption="Using the reconfig hook to mark files as server-owned">
-chown ${VHOST_SERVER_UID}:${VHOST_SERVER_GID} ${MY_INSTALLDIR}/Settings.php
-</pre>
-
-<p>
-The eclass provides several other functions that are rarely used. The most
-notable is <c>webapp_sqlscript</c>, which marks a file as an SQL create script.
-In its current state, this function is only moderately useful.
-</p>
-
-</body>
-</section>
-</chapter>
-
-<chapter>
-<title>Additional Best Practices</title>
-<section>
-<title>Apache</title>
-<body>
-
-<ul>
- <li>
- Be careful when installing apache configuration files. If you place a
- misconfigured Apache configuration file into
- <path>/etc/apache{2}/vhosts.d</path>, the server will fail on next restart.
- Is is better to either install the file elsewhere and let the administrator
- customize it, or comment out the contents to avoid failure.
- </li>
-</ul>
-
-</body>
-</section>
-</chapter>
-
-<chapter>
-<title>Next Steps</title>
-<section>
-<title>Obtaining More Information</title>
-<body>
-
-<p>
-Additional examples can be found in the <path>www-apps</path> category of the
-Portage tree. Developers and users should also consult the <uri
-link="http://svn.gnqs.org/projects/gentoo-webapps-overlay">web-apps
-overlay</uri> for even more examples and software packages.
-</p>
-
-<p>
-If you have a question that is not answered in this document, please feel free
-to contact the <uri
-link="http://svn.gnqs.org/projects/gentoo-webapps-overlay/wiki/Contributors">web-apps
-herd</uri> or ask on <uri link="irc://freenode/gentoo-web">IRC</uri>.
-</p>
-
-</body>
-</section>
-</chapter>
-</guide>
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [gentoo-commits] proj/webapp-config:master commit in: doc/
@ 2012-06-28 0:43 Anthony G. Basile
0 siblings, 0 replies; 7+ messages in thread
From: Anthony G. Basile @ 2012-06-28 0:43 UTC (permalink / raw
To: gentoo-commits
commit: a7712ced083639938480d570f160883430397642
Author: Anthony G. Basile <blueness <AT> gentoo <DOT> org>
AuthorDate: Thu Jun 28 00:43:44 2012 +0000
Commit: Anthony G. Basile <blueness <AT> gentoo <DOT> org>
CommitDate: Thu Jun 28 00:43:44 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/webapp-config.git;a=commit;h=a7712ced
doc/webapp-eclass.5.xml: fix generated man/html filename
---
doc/webapp-eclass.5.xml | 28 ++++++++++++++--------------
1 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/doc/webapp-eclass.5.xml b/doc/webapp-eclass.5.xml
index f310f56..f2a0990 100644
--- a/doc/webapp-eclass.5.xml
+++ b/doc/webapp-eclass.5.xml
@@ -3,7 +3,7 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<article>
<articleinfo>
- <title>webapp.eclass</title>
+ <title>webapp-eclass</title>
<authorgroup>
<author>
@@ -43,16 +43,16 @@
<refentry>
<refentryinfo>
- <title>webapp.eclass</title>
+ <title>webapp-eclass</title>
<date>January 2006</date>
<productname>Gentoo Linux</productname>
</refentryinfo>
<refmeta>
- <refentrytitle>webapp.eclass</refentrytitle>
+ <refentrytitle>webapp-eclass</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
- <refname>webapp.eclass</refname>
+ <refname>webapp-eclass</refname>
<refpurpose>standardised approach to writing ebuilds for web-based applications</refpurpose>
</refnamediv>
@@ -70,47 +70,47 @@
<title>Support For Virtual Hosts</title>
<para>Many web servers today have to be able to host more than one website at a time. This is normally done through <glossterm>name-based virtual hosting</glossterm>. See the Apache documentation for more details about how this works.</para>
<para>Traditional package installers only install a single copy of a package. Many webservers need to make the same package available as part of different virtual hosts. The administrator normally ends up installing and upgrading each of these packages by hand. This makes for more work for the administrator.</para>
- <para><userinput>webapp.eclass</userinput> overcomes this problem by installing packages, and associated metadata, in a format and location understood by <citerefentry><refentrytitle>webapp-config</refentrytitle><manvolnum>8</manvolnum></citerefentry>. The administrator then uses <command>webapp-config</command> to install and upgrade however many copies of the package as he needs.</para>
+ <para><userinput>webapp-eclass</userinput> overcomes this problem by installing packages, and associated metadata, in a format and location understood by <citerefentry><refentrytitle>webapp-config</refentrytitle><manvolnum>8</manvolnum></citerefentry>. The administrator then uses <command>webapp-config</command> to install and upgrade however many copies of the package as he needs.</para>
</refsect2>
<refsect2>
<title>Installing Into The Correct Directory</title>
<para>Virtual hosts are normally stored on disk in their own directories. The location of these directories can vary from computer to computer. It is not unusual for each administrator to have his own preferred location for putting virtual hosts.</para>
<para>Traditional packagers always install a single copy of the package, normally into <filename>/home/httpd/htdocs/<package-name>/</filename>. If the administrator changes the DocumentRoot of their preferred web server to point to a different directory, traditional packagers are unable to detect this and adjust accordingly. They also are unable to detect any attempt to install a package into a virtual host.</para>
- <para><userinput>webapp.eclass</userinput> overcomes this problem because it makes no attempt to install packages into the webserver's DocumentRoot. Instead, it installs the files of the package into the <filename>/usr/share/webapps</filename> hierarchy - which is never directly used by any webserver. The administrator then uses <command>webapp-config</command> to complete the installation to the directory of his choice.</para>
+ <para><userinput>webapp-eclass</userinput> overcomes this problem because it makes no attempt to install packages into the webserver's DocumentRoot. Instead, it installs the files of the package into the <filename>/usr/share/webapps</filename> hierarchy - which is never directly used by any webserver. The administrator then uses <command>webapp-config</command> to complete the installation to the directory of his choice.</para>
</refsect2>
<refsect2>
<title>Installing With The Correct File Ownerships</title>
<para>Web-based applications are made up of files and directories that need to be owned by more than one user. Any files or directories that the web server needs to write to - these need to be owned by whatever user the web server runs as. Configuration files need to be owned by the non-root user who owns the website. The rest of the files and directories need to be owned by root, to ensure that they cannot be tampered with by other users.</para>
<para>Traditional packagers have no way to understand which user the web server runs as, or which user needs to own the configuration files. Some packages assume that the user is running the Apache web server, and hard-code the information into their installation scripts. Unfortunately, any packages that do this will not work if the user chooses to use an alternative web server.</para>
- <para><userinput>webapp.eclass</userinput> overcomes this problem because it provides a number of functions which the ebuild can use to indicate who needs to own what. When the administrator completes the install using <command>webapp-config</command>, he can tell <command>webapp-config</command> which web server the package will be running under, and which user needs to own the configuration files.</para>
+ <para><userinput>webapp-eclass</userinput> overcomes this problem because it provides a number of functions which the ebuild can use to indicate who needs to own what. When the administrator completes the install using <command>webapp-config</command>, he can tell <command>webapp-config</command> which web server the package will be running under, and which user needs to own the configuration files.</para>
</refsect2>
<refsect2>
<title>Apache Modules vs CGI Scripts</title>
<para>Most web-based applications are written in scripting languages such as PHP, Python, or Perl. Most scripting languages are available either as Apache modules and as stand-alone CGI scripting engines. Sometimes, it makes more sense to install scripting languages as CGI scripting engines. Although CGI engines run much slower than Apache modules, the advantage is that it allows a single computer to run multiple versions of the same language - something that sometimes is necessary.</para>
<para>It's also worth pointing out that the administrator has a choice of web servers - and not all scripting languages run as compiled-in modules in all web servers.</para>
<para>It is difficult-to-impossible for a traditional package manager to provide a single package that can cope with all of the possible permutations.</para>
- <para><userinput>webapp.eclass</userinput> provides a function for ebuilds to indicate which script files need to be run by which scripting engine. <command>webapp-config</command> can, if necessary, modify these script files to use the correct CGI engine when installing into a virtual host.</para>
+ <para><userinput>webapp-eclass</userinput> provides a function for ebuilds to indicate which script files need to be run by which scripting engine. <command>webapp-config</command> can, if necessary, modify these script files to use the correct CGI engine when installing into a virtual host.</para>
</refsect2>
<refsect2>
<title>Overwriting Configuration Files</title>
<para>When packages are upgraded, new configuration files are installed. Different package managers handle this in different ways. Portage can prevent files being overwritten on a per-directory basis. Web-based applications normally have configuration files installed in the same directories as the scripts themselves. Packages for Portage, therefore, normally end up overwriting the configuration file because the alternative is having to wade through pages of <command>etc-update</command> output.</para>
- <para><userinput>webapp.eclass</userinput> avoids this problem by allowing ebuilds to indicate which files are configuration files. <command>webapp-config</command> uses this information to ensure that configuration files are not overwritten. The administrator can then use <command>etc-update</command> as normal to complete the upgrade.</para>
+ <para><userinput>webapp-eclass</userinput> avoids this problem by allowing ebuilds to indicate which files are configuration files. <command>webapp-config</command> uses this information to ensure that configuration files are not overwritten. The administrator can then use <command>etc-update</command> as normal to complete the upgrade.</para>
</refsect2>
<refsect2>
<title>Handling Web Server Configuration Files</title>
<para>There are some web-based applications that will not work without installing configuration files for the webserver. Deciding which webserver to install configuration files for, and where to install these configuration files, is problematic at best.</para>
- <para><userinput>webapp.eclass</userinput> addresses this in two ways. Firstly, ebuilds are encouraged to supply configuration files for <emphasis>all</emphasis> supported webservers. <command>webapp-config</command> will then install the correct configuration files for the selected webserver when the virtual copy of the application is installed.</para>
+ <para><userinput>webapp-eclass</userinput> addresses this in two ways. Firstly, ebuilds are encouraged to supply configuration files for <emphasis>all</emphasis> supported webservers. <command>webapp-config</command> will then install the correct configuration files for the selected webserver when the virtual copy of the application is installed.</para>
</refsect2>
<refsect2>
<title>Handling SQL Databases</title>
<para>Many web-based applications store their data in sql-based databases. Installing these databases is enough of a pain; upgrading them is something that's often left to the administrator to struggle through.</para>
- <para><userinput>webapp.eclass</userinput> does not provide a full solution today to this problem. Ebuilds can indicate which files are SQL scripts, and which database engine the scripts are for. A future version of <userinput>webapp.eclass</userinput> will (hopefully) provide a tool to automatically generate an upgrade script to help the administrator.</para>
+ <para><userinput>webapp-eclass</userinput> does not provide a full solution today to this problem. Ebuilds can indicate which files are SQL scripts, and which database engine the scripts are for. A future version of <userinput>webapp-eclass</userinput> will (hopefully) provide a tool to automatically generate an upgrade script to help the administrator.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Installation Directories</title>
- <para><glossterm>webapp.eclass</glossterm> creates an intermediate install of a package, so that the computer's administrator can then perform multiple installations using <citerefentry><refentrytitle>webapp-config</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+ <para><glossterm>webapp-eclass</glossterm> creates an intermediate install of a package, so that the computer's administrator can then perform multiple installations using <citerefentry><refentrytitle>webapp-config</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
<para>The intermediate install (known as the <glossterm>master copy</glossterm>) is never used by, or accessed via, the web server.</para>
<para>The intermediate install goes into the <filename>/usr/share/webapps</filename> directory structure:</para>
<screen>
@@ -428,7 +428,7 @@
<varlistentry>
<term><filename>/etc/vhosts/webapp-config</filename></term>
<listitem>
- <para>Configuration file, holding the defaults for <command>webapp-config</command> and the <userinput>webapp.eclass</userinput> eclass.</para>
+ <para>Configuration file, holding the defaults for <command>webapp-config</command> and the <userinput>webapp-eclass</userinput> eclass.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -437,7 +437,7 @@
<refsect1>
<title>See Also</title>
<para><citerefentry><refentrytitle>webapp-config</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>webapp-config</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>emerge</refentrytitle><manvolnum>1</manvolnum></citerefentry></para>
- <para>The <userinput>webapp.eclass</userinput> is part of the <command>webapp-config</command> package. <command>webapp-config</command> is based on the design for an installer for web-based applications first discussed in <ulink url="http://www.gentoo.org/proj/en/glep/glep-0011.html">GLEP #11</ulink> for the Gentoo Linux project.</para>
+ <para>The <userinput>webapp-eclass</userinput> is part of the <command>webapp-config</command> package. <command>webapp-config</command> is based on the design for an installer for web-based applications first discussed in <ulink url="http://www.gentoo.org/proj/en/glep/glep-0011.html">GLEP #11</ulink> for the Gentoo Linux project.</para>
</refsect1>
</refentry>
</section>
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [gentoo-commits] proj/webapp-config:master commit in: doc/
@ 2012-06-28 22:33 Anthony G. Basile
0 siblings, 0 replies; 7+ messages in thread
From: Anthony G. Basile @ 2012-06-28 22:33 UTC (permalink / raw
To: gentoo-commits
commit: 67d43e6ee0e6d411ceb937314985403497acc7ea
Author: Anthony G. Basile <blueness <AT> gentoo <DOT> org>
AuthorDate: Thu Jun 28 22:32:51 2012 +0000
Commit: Anthony G. Basile <blueness <AT> gentoo <DOT> org>
CommitDate: Thu Jun 28 22:32:51 2012 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/webapp-config.git;a=commit;h=67d43e6e
doc/Makefile: fix parallel build, thanks Arfrever
---
doc/Makefile | 13 ++++---------
1 files changed, 4 insertions(+), 9 deletions(-)
diff --git a/doc/Makefile b/doc/Makefile
index 4dc8e44..f38cdb2 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -17,8 +17,6 @@
MAN_PAGES = webapp-config.8 webapp-config.5 webapp-eclass.5
HTML_PAGES = webapp-config.8.html webapp-config.5.html webapp-eclass.5.html
-TMPFILE=./webapp-config.man
-
all: man html
html: $(HTML_PAGES)
@@ -31,13 +29,10 @@ clean:
%.html: %.xml
@echo HTML $@
- @xmlto html-nochunks $<
+ @xmlto html-nochunks $< 2>/dev/null
%: %.xml
@echo MAN $@
- @xmlto man $<
-#
-# fix up the blank lines that docbook leaves behind
-#
- @cat $@ | sed -e 's/$$/.fred/g;' | tr -d '\n' | sed -e 's/.fred.fred\./.fred./g;' | sed -e 's/.fred/\n/g;' > $(TMPFILE)
- @mv $(TMPFILE) $@
+ @xmlto man $< 2>/dev/null
+ @cat $@ | sed -e 's/$$/.fred/g;' | tr -d '\n' | sed -e 's/.fred.fred\./.fred./g;' | sed -e 's/.fred/\n/g;' > $@.temp
+ @mv $@.temp $@
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [gentoo-commits] proj/webapp-config:master commit in: doc/
@ 2013-03-29 23:17 Anthony G. Basile
0 siblings, 0 replies; 7+ messages in thread
From: Anthony G. Basile @ 2013-03-29 23:17 UTC (permalink / raw
To: gentoo-commits
commit: 932bdfb10bb802e505358473248c1d1375e219b0
Author: Anthony G. Basile <blueness <AT> gentoo <DOT> org>
AuthorDate: Fri Mar 29 23:15:55 2013 +0000
Commit: Anthony G. Basile <blueness <AT> gentoo <DOT> org>
CommitDate: Fri Mar 29 23:15:55 2013 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/webapp-config.git;a=commit;h=932bdfb1
doc/webapp-config.8.xml: fix unpaired tag
Signed-off-by: Anthony G. Basile <blueness <AT> gentoo.org>
---
doc/webapp-config.8.xml | 1 +
1 files changed, 1 insertions(+), 0 deletions(-)
diff --git a/doc/webapp-config.8.xml b/doc/webapp-config.8.xml
index dda1ec4..5b0048b 100644
--- a/doc/webapp-config.8.xml
+++ b/doc/webapp-config.8.xml
@@ -478,6 +478,7 @@
<listitem>
<para>Use this option to create the virtual copy by copying the files from the <filename>/usr/share/webapps/</filename> directories.</para>
<para>This option is useful if you want to copy the files directly from <filename>/usr/share/webapps/</filename> to your virtual host in /var/www without the use of softlinks, or hardlinks. Be aware that because this is a direct copying of files it will prove to take up more space on your filesystem as opposed to the other two options since you are duplicating the webapp.</para>
+ </listitem>
</varlistentry>
<varlistentry>
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [gentoo-commits] proj/webapp-config:master commit in: doc/
@ 2014-01-25 3:14 Devan Franchini
0 siblings, 0 replies; 7+ messages in thread
From: Devan Franchini @ 2014-01-25 3:14 UTC (permalink / raw
To: gentoo-commits
commit: beef26131a2b31c5e58895975a87d2ea7f339fae
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: Sat Jan 25 03:14:43 2014 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/webapp-config.git;a=commit;h=beef2613
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>
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [gentoo-commits] proj/webapp-config:master commit in: doc/
@ 2015-07-03 4:10 Devan Franchini
0 siblings, 0 replies; 7+ messages in thread
From: Devan Franchini @ 2015-07-03 4:10 UTC (permalink / raw
To: gentoo-commits
commit: eac7e48acb2103df75b5f4b6e19d48def12d2f96
Author: Devan Franchini <twitch153 <AT> gentoo <DOT> org>
AuthorDate: Fri Jul 3 04:04:15 2015 +0000
Commit: Devan Franchini <twitch153 <AT> gentoo <DOT> org>
CommitDate: Fri Jul 3 04:04:19 2015 +0000
URL: https://gitweb.gentoo.org/proj/webapp-config.git/commit/?id=eac7e48a
webapp-config.8.xml: Updates man page in accordance with command line arg changes
Other changes have been made, including:
* Formatting of command examples
* Changing short-hand flags to show they no longer require two dashes
* Adding information on the --prune-database flag.
* Code cleanup
doc/webapp-config.8.xml | 117 ++++++++++++++++++++++++++++++++++--------------
1 file changed, 83 insertions(+), 34 deletions(-)
diff --git a/doc/webapp-config.8.xml b/doc/webapp-config.8.xml
index 2214d47..13f6baf 100644
--- a/doc/webapp-config.8.xml
+++ b/doc/webapp-config.8.xml
@@ -70,15 +70,15 @@
<arg choice="opt">
<option>--bug-report</option>
</arg>
- <arg choice="plain">
- <option>-I</option>
- </arg>
<arg choice="opt">
<option>-dghusDE</option>
<option>--soft</option>
<option>--copy</option>
<option>--secure</option>
</arg>
+ <arg choice="plain">
+ <option>-I</option>
+ </arg>
<arg choice="req">
<replaceable>app-name</replaceable>
</arg>
@@ -92,15 +92,15 @@
<arg choice="opt">
<option>--bug-report</option>
</arg>
- <arg choice="plain">
- <option>-U</option>
- </arg>
<arg choice="opt">
<option>-dghusDE</option>
<option>--soft</option>
<option>--copy</option>
<option>--secure</option>
</arg>
+ <arg choice="plain">
+ <option>-U</option>
+ </arg>
<arg choice="req">
<replaceable>app-name</replaceable>
</arg>
@@ -114,9 +114,6 @@
<arg choice="opt">
<option>--bug-report</option>
</arg>
- <arg choice="plain">
- <option>-C</option>
- </arg>
<arg choice="req">
<option>-d</option>
<replaceable>directory</replaceable>
@@ -124,6 +121,9 @@
<arg choice="opt">
<replaceable>--secure</replaceable>
</arg>
+ <arg choice="plain">
+ <option>-C</option>
+ </arg>
<arg choice="req">
<replaceable>app-name</replaceable>
</arg>
@@ -141,8 +141,6 @@
<arg>
<replaceable>app-name</replaceable>
</arg>
- </group>
- <group choice="opt">
<arg>
<replaceable>app-version</replaceable>
</arg>
@@ -156,7 +154,7 @@
</arg>
<arg choice="opt">
<arg choice="req">
- <replaceable>app-version</replaceable>
+ <replaceable>app-name</replaceable>
</arg>
<arg choice="opt">
<replaceable>app-version</replaceable>
@@ -167,6 +165,21 @@
<cmdsynopsis>
<command>webapp-config</command>
<arg choice="plain">
+ <option>--prune-database</option>
+ </arg>
+ <group choice="plain">
+ <arg choice="req">
+ <replaceable>pretend</replaceable>
+ </arg>
+ <arg choice="req">
+ <replaceable>clean</replaceable>
+ </arg>
+ </group>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>webapp-config</command>
+ <arg choice="plain">
<option>--show-installed</option>
</arg>
<group choice="opt">
@@ -182,10 +195,10 @@
<arg choice="plain">
<option>--show-postinst</option>
</arg>
- <arg choice="plain">
+ <arg choice="req">
<replaceable>app-name</replaceable>
</arg>
- <arg choice="plain">
+ <arg choice="req">
<replaceable>app-version</replaceable>
</arg>
</cmdsynopsis>
@@ -193,11 +206,21 @@
<cmdsynopsis>
<command>webapp-config</command>
<group choice="plain">
- <arg>--list-servers</arg>
- <arg>-v</arg>
- <arg>--version</arg>
- <arg>-h</arg>
- <arg>--help</arg>
+ <arg choice="plain">
+ <option>--list-servers</option>
+ </arg>
+ <arg choice="plain">
+ <option>-v</option>
+ </arg>
+ <arg choice="plain">
+ <option>--version</option>
+ </arg>
+ <arg choice="plain">
+ <option>-h</option>
+ </arg>
+ <arg choice="plain">
+ <option>--help</option>
+ </arg>
</group>
</cmdsynopsis>
@@ -264,32 +287,32 @@
<title>Actions</title>
<variablelist>
<varlistentry>
- <term><option>-I</option></term>
- <term><option>--install</option></term>
+ <term><option>-I</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
+ <term><option>--install</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<para>Activate <emphasis>install mode</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-U</option></term>
- <term><option>--upgrade</option></term>
+ <term><option>-U</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
+ <term><option>--upgrade</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<para>Activate <emphasis>upgrade mode</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-C</option></term>
- <term><option>--clean</option></term>
+ <term><option>-C</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
+ <term><option>--clean</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<para>Activate <emphasis>remove mode</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-li</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<term><option>--list-installs</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
- <term><option>--li</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<para>Outputs a list of all the virtual copies of the <replaceable>app-name</replaceable>-<replaceable>app-version</replaceable> package.</para>
<para>If you omit <replaceable>app-name</replaceable> or <replaceable>app-version</replaceable> webapp-config will display all available packages/versions.</para>
@@ -297,16 +320,39 @@
</varlistentry>
<varlistentry>
+ <term><option>-lui</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<term><option>--list-unused-installs</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
- <term><option>--lui</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<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>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-pd</option> <replaceable>action</replaceable></term>
+ <term><option>--prune-database</option> <replaceable>action</replaceable></term>
+ <listitem>
+ <para>Cleans up the installed webapps database for lingering uninstalled webapps. Behavior is determined by the <replaceable>action</replaceable> given.</para>
+ <para><replaceable>action</replaceable> must be one of:</para>
+ <variablelist>
+ <varlistentry>
+ <term>pretend</term>
+ <listitem>
+ <para>Shows output of what would be cleaned from the database</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>clean</term>
+ <listitem>
+ <para>Removes webapp entries that are not installed on the system</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-si</option></term>
<term><option>--show-installed</option></term>
- <term><option>--si</option></term>
<listitem>
<para>Outputs the app-name and app-version of the application installed in <replaceable>directory</replaceable>.</para>
<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>
@@ -314,24 +360,24 @@
</varlistentry>
<varlistentry>
+ <term><option>-spi</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<term><option>--show-postinst</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
- <term><option>--spi</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<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>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-spu</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<term><option>--show-postupgrade</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
- <term><option>--spu</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<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>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-ls</option></term>
<term><option>--list-servers</option></term>
- <term><option>--ls</option></term>
<listitem>
<para>Outputs a list of the web servers that <command>webapp-config</command> currently supports.</para>
<para>Use the <option>-s</option> <replaceable>server</replaceable> switch to change which web-server an install or upgrade should use.</para>
@@ -485,6 +531,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-sf</option></term>
<term><option>--soft</option></term>
<listitem>
<para>Use this option to create the virtual copy using symbolic links.</para>
@@ -493,6 +540,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-c</option></term>
<term><option>--copy</option></term>
<listitem>
<para>Use this option to create the virtual copy by copying the files from the <filename>/usr/share/webapps/</filename> directories.</para>
@@ -501,6 +549,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-S</option></term>
<term><option>--secure</option></term>
<listitem>
<para>Use this option to install into the <filename>htdocs-secure</filename> directory rather than into the <filename>htdocs</filename> directory.</para>
@@ -510,8 +559,8 @@
</varlistentry>
<varlistentry>
- <term><option>--default-dirs</option></term>
- <term><option>--dd</option></term>
+ <term><option>-dd</option> <replaceable>type</replaceable></term>
+ <term><option>--default-dirs</option> <replaceable>type</replaceable></term>
<listitem>
<para><replaceable>type</replaceable> must be one of:</para>
<variablelist>
@@ -538,8 +587,8 @@
</varlistentry>
<varlistentry>
+ <term><option>-vf</option> <replaceable>type</replaceable></term>
<term><option>--virtual-files</option> <replaceable>type</replaceable></term>
- <term><option>--vf</option> <replaceable>type</replaceable></term>
<listitem>
<para><replaceable>type</replaceable> must be one of:</para>
<variablelist>
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [gentoo-commits] proj/webapp-config:master commit in: doc/
2015-07-03 4:55 [gentoo-commits] proj/webapp-config:1.54 " Devan Franchini
@ 2015-07-03 4:50 ` Devan Franchini
0 siblings, 0 replies; 7+ messages in thread
From: Devan Franchini @ 2015-07-03 4:50 UTC (permalink / raw
To: gentoo-commits
commit: 42b434340cf7b3766d892fb07255c490116df2ef
Author: Devan Franchini <twitch153 <AT> gentoo <DOT> org>
AuthorDate: Fri Jul 3 04:04:15 2015 +0000
Commit: Devan Franchini <twitch153 <AT> gentoo <DOT> org>
CommitDate: Fri Jul 3 04:49:34 2015 +0000
URL: https://gitweb.gentoo.org/proj/webapp-config.git/commit/?id=42b43434
webapp-config.8.xml: Updates man page in accordance with command line arg changes
Other changes have been made, including:
* Formatting of command examples
* Changing short-hand flags to show they no longer require two dashes
* Adding information on the --prune-database flag.
* Code cleanup
doc/webapp-config.8.xml | 117 ++++++++++++++++++++++++++++++++++--------------
1 file changed, 83 insertions(+), 34 deletions(-)
diff --git a/doc/webapp-config.8.xml b/doc/webapp-config.8.xml
index 2214d47..13f6baf 100644
--- a/doc/webapp-config.8.xml
+++ b/doc/webapp-config.8.xml
@@ -70,15 +70,15 @@
<arg choice="opt">
<option>--bug-report</option>
</arg>
- <arg choice="plain">
- <option>-I</option>
- </arg>
<arg choice="opt">
<option>-dghusDE</option>
<option>--soft</option>
<option>--copy</option>
<option>--secure</option>
</arg>
+ <arg choice="plain">
+ <option>-I</option>
+ </arg>
<arg choice="req">
<replaceable>app-name</replaceable>
</arg>
@@ -92,15 +92,15 @@
<arg choice="opt">
<option>--bug-report</option>
</arg>
- <arg choice="plain">
- <option>-U</option>
- </arg>
<arg choice="opt">
<option>-dghusDE</option>
<option>--soft</option>
<option>--copy</option>
<option>--secure</option>
</arg>
+ <arg choice="plain">
+ <option>-U</option>
+ </arg>
<arg choice="req">
<replaceable>app-name</replaceable>
</arg>
@@ -114,9 +114,6 @@
<arg choice="opt">
<option>--bug-report</option>
</arg>
- <arg choice="plain">
- <option>-C</option>
- </arg>
<arg choice="req">
<option>-d</option>
<replaceable>directory</replaceable>
@@ -124,6 +121,9 @@
<arg choice="opt">
<replaceable>--secure</replaceable>
</arg>
+ <arg choice="plain">
+ <option>-C</option>
+ </arg>
<arg choice="req">
<replaceable>app-name</replaceable>
</arg>
@@ -141,8 +141,6 @@
<arg>
<replaceable>app-name</replaceable>
</arg>
- </group>
- <group choice="opt">
<arg>
<replaceable>app-version</replaceable>
</arg>
@@ -156,7 +154,7 @@
</arg>
<arg choice="opt">
<arg choice="req">
- <replaceable>app-version</replaceable>
+ <replaceable>app-name</replaceable>
</arg>
<arg choice="opt">
<replaceable>app-version</replaceable>
@@ -167,6 +165,21 @@
<cmdsynopsis>
<command>webapp-config</command>
<arg choice="plain">
+ <option>--prune-database</option>
+ </arg>
+ <group choice="plain">
+ <arg choice="req">
+ <replaceable>pretend</replaceable>
+ </arg>
+ <arg choice="req">
+ <replaceable>clean</replaceable>
+ </arg>
+ </group>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>webapp-config</command>
+ <arg choice="plain">
<option>--show-installed</option>
</arg>
<group choice="opt">
@@ -182,10 +195,10 @@
<arg choice="plain">
<option>--show-postinst</option>
</arg>
- <arg choice="plain">
+ <arg choice="req">
<replaceable>app-name</replaceable>
</arg>
- <arg choice="plain">
+ <arg choice="req">
<replaceable>app-version</replaceable>
</arg>
</cmdsynopsis>
@@ -193,11 +206,21 @@
<cmdsynopsis>
<command>webapp-config</command>
<group choice="plain">
- <arg>--list-servers</arg>
- <arg>-v</arg>
- <arg>--version</arg>
- <arg>-h</arg>
- <arg>--help</arg>
+ <arg choice="plain">
+ <option>--list-servers</option>
+ </arg>
+ <arg choice="plain">
+ <option>-v</option>
+ </arg>
+ <arg choice="plain">
+ <option>--version</option>
+ </arg>
+ <arg choice="plain">
+ <option>-h</option>
+ </arg>
+ <arg choice="plain">
+ <option>--help</option>
+ </arg>
</group>
</cmdsynopsis>
@@ -264,32 +287,32 @@
<title>Actions</title>
<variablelist>
<varlistentry>
- <term><option>-I</option></term>
- <term><option>--install</option></term>
+ <term><option>-I</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
+ <term><option>--install</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<para>Activate <emphasis>install mode</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-U</option></term>
- <term><option>--upgrade</option></term>
+ <term><option>-U</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
+ <term><option>--upgrade</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<para>Activate <emphasis>upgrade mode</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-C</option></term>
- <term><option>--clean</option></term>
+ <term><option>-C</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
+ <term><option>--clean</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<para>Activate <emphasis>remove mode</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-li</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<term><option>--list-installs</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
- <term><option>--li</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<para>Outputs a list of all the virtual copies of the <replaceable>app-name</replaceable>-<replaceable>app-version</replaceable> package.</para>
<para>If you omit <replaceable>app-name</replaceable> or <replaceable>app-version</replaceable> webapp-config will display all available packages/versions.</para>
@@ -297,16 +320,39 @@
</varlistentry>
<varlistentry>
+ <term><option>-lui</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<term><option>--list-unused-installs</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
- <term><option>--lui</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<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>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-pd</option> <replaceable>action</replaceable></term>
+ <term><option>--prune-database</option> <replaceable>action</replaceable></term>
+ <listitem>
+ <para>Cleans up the installed webapps database for lingering uninstalled webapps. Behavior is determined by the <replaceable>action</replaceable> given.</para>
+ <para><replaceable>action</replaceable> must be one of:</para>
+ <variablelist>
+ <varlistentry>
+ <term>pretend</term>
+ <listitem>
+ <para>Shows output of what would be cleaned from the database</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>clean</term>
+ <listitem>
+ <para>Removes webapp entries that are not installed on the system</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-si</option></term>
<term><option>--show-installed</option></term>
- <term><option>--si</option></term>
<listitem>
<para>Outputs the app-name and app-version of the application installed in <replaceable>directory</replaceable>.</para>
<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>
@@ -314,24 +360,24 @@
</varlistentry>
<varlistentry>
+ <term><option>-spi</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<term><option>--show-postinst</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
- <term><option>--spi</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<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>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-spu</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<term><option>--show-postupgrade</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
- <term><option>--spu</option> <replaceable>app-name</replaceable> <replaceable>app-version</replaceable></term>
<listitem>
<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>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-ls</option></term>
<term><option>--list-servers</option></term>
- <term><option>--ls</option></term>
<listitem>
<para>Outputs a list of the web servers that <command>webapp-config</command> currently supports.</para>
<para>Use the <option>-s</option> <replaceable>server</replaceable> switch to change which web-server an install or upgrade should use.</para>
@@ -485,6 +531,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-sf</option></term>
<term><option>--soft</option></term>
<listitem>
<para>Use this option to create the virtual copy using symbolic links.</para>
@@ -493,6 +540,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-c</option></term>
<term><option>--copy</option></term>
<listitem>
<para>Use this option to create the virtual copy by copying the files from the <filename>/usr/share/webapps/</filename> directories.</para>
@@ -501,6 +549,7 @@
</varlistentry>
<varlistentry>
+ <term><option>-S</option></term>
<term><option>--secure</option></term>
<listitem>
<para>Use this option to install into the <filename>htdocs-secure</filename> directory rather than into the <filename>htdocs</filename> directory.</para>
@@ -510,8 +559,8 @@
</varlistentry>
<varlistentry>
- <term><option>--default-dirs</option></term>
- <term><option>--dd</option></term>
+ <term><option>-dd</option> <replaceable>type</replaceable></term>
+ <term><option>--default-dirs</option> <replaceable>type</replaceable></term>
<listitem>
<para><replaceable>type</replaceable> must be one of:</para>
<variablelist>
@@ -538,8 +587,8 @@
</varlistentry>
<varlistentry>
+ <term><option>-vf</option> <replaceable>type</replaceable></term>
<term><option>--virtual-files</option> <replaceable>type</replaceable></term>
- <term><option>--vf</option> <replaceable>type</replaceable></term>
<listitem>
<para><replaceable>type</replaceable> must be one of:</para>
<variablelist>
^ permalink raw reply related [flat|nested] 7+ messages in thread
end of thread, other threads:[~2015-07-03 4:50 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-01-25 3:14 [gentoo-commits] proj/webapp-config:master commit in: doc/ Devan Franchini
-- strict thread matches above, loose matches on Subject: below --
2015-07-03 4:55 [gentoo-commits] proj/webapp-config:1.54 " Devan Franchini
2015-07-03 4:50 ` [gentoo-commits] proj/webapp-config:master " Devan Franchini
2015-07-03 4:10 Devan Franchini
2013-03-29 23:17 Anthony G. Basile
2012-06-28 22:33 Anthony G. Basile
2012-06-28 0:43 Anthony G. Basile
2012-06-28 0:37 Anthony G. Basile
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox