nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-05-13 10:30:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update man page to add setup operations

Browse Source
This commit is contained in:
Sunil Mohan Adapa 2016-09-09 20:01:25 +05:30 committed by James Valleroy
parent 155ad8db15
commit 1e3060900b
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
1 changed files with 64 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/plinth.xml
View File

@ -40,6 +40,14 @@
<arg><option>--server_dir</option><arg choice="req">SERVER_DIR</arg></arg> <arg><option>--server_dir</option><arg choice="req">SERVER_DIR</arg></arg>
<arg><option>--debug</option></arg> <arg><option>--debug</option></arg>
<arg><option>--diagnose</option></arg> <arg><option>--diagnose</option></arg>
<arg>
<option>--setup</option>
<arg choice="opt" rep="repeat">application</arg>
</arg>
<arg>
<option>--setup-no-repeat</option>
<arg choice="opt" rep="repeat">application</arg>
</arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -110,6 +118,39 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--setup</option></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--setup-no-install</option></term>
<listitem>
<para>
Same as <option>--setup</option> 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.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>