Skip to content

L
lxc
Commit 10fba81b by Michel Normand Committed by Daniel Lezcano
Options

change man pages to use a common file for common options

the common options of lxc commands are now described in one file "common_options.sgml.in" Signed-off-by: 's avatarMichel Normand <normand@fr.ibm.com> Signed-off-by: 's avatarDaniel Lezcano <dlezcano@fr.ibm.com>
parent 99e4008c
Showing with 30 additions and 166 deletions
configure.ac
...@@ -78,6 +78,7 @@ AC_CONFIG_FILES([ ...@@ -78,6 +78,7 @@ AC_CONFIG_FILES([
doc/lxc-cgroup.sgml doc/lxc-cgroup.sgml
doc/lxc.conf.sgml doc/lxc.conf.sgml
doc/lxc.sgml doc/lxc.sgml
doc/common_options.sgml
doc/see_also.sgml doc/see_also.sgml
scripts/Makefile scripts/Makefile
......
doc/Makefile.am
...@@ -31,7 +31,7 @@ man_MANS = \ ...@@ -31,7 +31,7 @@ man_MANS = \
%.7 : %.sgml %.7 : %.sgml
docbook2man -w all $< docbook2man -w all $<
lxc-%.sgml : see_also.sgml lxc-%.sgml : common_options.sgml see_also.sgml
clean-local: clean-local:
$(RM) manpage.* *.7 *.5 *.1 *.sgml $(man_MANS) $(RM) manpage.* *.7 *.5 *.1 *.sgml $(man_MANS)
......
doc/lxc-cgroup.sgml.in
...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]> ]>
...@@ -76,17 +77,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -76,17 +77,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<varlistentry> <varlistentry>
<term> <term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name associated with a control group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option><replaceable>subsystem</replaceable></option> <option><replaceable>subsystem</replaceable></option>
</term> </term>
<listitem> <listitem>
...@@ -111,6 +101,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -111,6 +101,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
&commonoptions;
<refsect1> <refsect1>
<title>Examples</title> <title>Examples</title>
<variablelist> <variablelist>
......
doc/lxc-console.sgml.in
...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]> ]>
...@@ -83,17 +84,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -83,17 +84,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<varlistentry> <varlistentry>
<term> <term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name to open a console.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-t <optional>ttynum</optional></option> <option>-t <optional>ttynum</optional></option>
</term> </term>
<listitem> <listitem>
...@@ -108,6 +98,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -108,6 +98,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
&commonoptions;
<refsect1> <refsect1>
<title>Diagnostic</title> <title>Diagnostic</title>
......
doc/lxc-create.sgml.in
...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]> ]>
...@@ -84,17 +85,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -84,17 +85,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<varlistentry> <varlistentry>
<term> <term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name to be created.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-f <replaceable>config_file</replaceable></option> <option>-f <replaceable>config_file</replaceable></option>
</term> </term>
<listitem> <listitem>
...@@ -109,6 +99,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -109,6 +99,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
&commonoptions;
<refsect1> <refsect1>
<title>Diagnostic</title> <title>Diagnostic</title>
......
doc/lxc-destroy.sgml.in
...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]> ]>
...@@ -63,24 +64,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -63,24 +64,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
<refsect1> &commonoptions;
<title>Options</title>
<variablelist>
<varlistentry>
<term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name to be destroyed.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1> <refsect1>
<title>Diagnostic</title> <title>Diagnostic</title>
......
doc/lxc-execute.sgml.in
...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]> ]>
...@@ -91,17 +92,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -91,17 +92,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<varlistentry> <varlistentry>
<term> <term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name to be executed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-f <replaceable>config_file</replaceable></option> <option>-f <replaceable>config_file</replaceable></option>
</term> </term>
<listitem> <listitem>
...@@ -116,6 +106,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -116,6 +106,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
&commonoptions;
<refsect1> <refsect1>
<title>Diagnostic</title> <title>Diagnostic</title>
......
doc/lxc-freeze.sgml.in
...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]> ]>
...@@ -65,24 +66,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -65,24 +66,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
<refsect1> &commonoptions;
<title>Options</title>
<variablelist>
<varlistentry>
<term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name to be frozen.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1> <refsect1>
<title>Diagnostic</title> <title>Diagnostic</title>
......
doc/lxc-monitor.sgml.in
...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]> ]>
...@@ -64,25 +65,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -64,25 +65,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
<refsect1> &commonoptions;
<title>Options</title>
<variablelist>
<varlistentry>
<term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name to be monitored. This option
can be a regular expression conforming POSIX2.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1> <refsect1>
<title>Examples</title> <title>Examples</title>
......
doc/lxc-start.sgml.in
...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]> ]>
...@@ -73,24 +74,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -73,24 +74,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
<refsect1> &commonoptions;
<title>Options</title>
<variablelist>
<varlistentry>
<term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name to be started.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1> <refsect1>
<title>Diagnostic</title> <title>Diagnostic</title>
......
doc/lxc-stop.sgml.in
...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]> ]>
...@@ -63,24 +64,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -63,24 +64,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
<refsect1> &commonoptions;
<title>Options</title>
<variablelist>
<varlistentry>
<term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name to be stopped.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1> <refsect1>
<title>Diagnostic</title> <title>Diagnostic</title>
......
doc/lxc-unfreeze.sgml.in
...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -25,6 +25,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]> ]>
...@@ -62,24 +63,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -62,24 +63,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
<refsect1> &commonoptions;
<title>Options</title>
<variablelist>
<varlistentry>
<term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name to be frozen.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1> <refsect1>
<title>Diagnostic</title> <title>Diagnostic</title>
......
doc/lxc-wait.sgml.in
...@@ -26,6 +26,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -26,6 +26,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]> ]>
...@@ -68,17 +69,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -68,17 +69,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<varlistentry> <varlistentry>
<term> <term>
<option>-n <replaceable>name</replaceable></option>
</term>
<listitem>
<para>
Specify the container name to be waited.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-s <replaceable>states</replaceable></option> <option>-s <replaceable>states</replaceable></option>
</term> </term>
<listitem> <listitem>
...@@ -93,6 +83,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -93,6 +83,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
&commonoptions;
<refsect1> <refsect1>
<title>Examples</title> <title>Examples</title>
<variablelist> <variablelist>
...@@ -106,7 +98,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -106,7 +98,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>lxc-wait -n 'RUNNING|STOPPED'</term> <term>lxc-wait -n foo -s 'RUNNING|STOPPED'</term>
<listitem> <listitem>
<para> <para>
exits when 'RUNNING' or 'STOPPED' state is reached. exits when 'RUNNING' or 'STOPPED' state is reached.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment