diff --git a/doc/plinth.xml b/doc/plinth.xml index e2f97d090..4563c2940 100644 --- a/doc/plinth.xml +++ b/doc/plinth.xml @@ -40,6 +40,14 @@ SERVER_DIR + + + application + + + + application + @@ -71,9 +79,9 @@ Options - - - + + + This the URL fragment under which Plinth will provide its services. By default the value from plinth.config is used. Plinth is @@ -85,30 +93,63 @@ available, plinth.config from current directory is used. In source directory, this has the default value of /. - - + + - - - - Enable debug mode. Turn off Django security features. - Print extra debug messages. Monitor source files for - changes and restart Plinth on modifications. Turn on - Django debug mode to show details on error pages. Die if - there is an error during module initialization. - - + + + + Enable debug mode. Turn off Django security features. + Print extra debug messages. Monitor source files for + changes and restart Plinth on modifications. Turn on + Django debug mode to show details on error pages. Die if + there is an error during module initialization. + + - - - + + + If provided, Plinth loads modules, performs initialization but does start the web server. Instead it runs diagnostic tests on each module and exits. - - + + + + + + + + Perform application setup operations and exit. Setting up + an application involves installing packages required for + that application and performing pre and post install + configuration setups. If no application is provided, + setup all applications which describe themselves as + essential. If a list of applications is provided, setup + only those applications. + + + + + + + + Same as but no new Debian + packages are installed during setup. When a package needs + to be installed, a check is done to make sure the package + is already installed. If the package is already + installed, no upgrade is performed and setup skips this + step and proceeds to next operation. If the package is + not installed an error is raised and setup process halts. + This is option is useful for running setup during post + installation script of a Debian package. Essential + packages are added as dependencies for the Debian package + and then setup process is executed from post install + script of the Debian package. + + @@ -145,7 +186,7 @@ under and set it to /plinth. - + Bugs @@ -160,8 +201,8 @@ Author - Plinth Developers - Original author + Plinth Developers + Original author