From: Stéphane Graber Date: Fri, 8 Feb 2013 23:49:52 +0000 (-0500) Subject: Add missing manpages X-Git-Tag: lxc-0.9.0.alpha3~1^2~5 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4019712d198a7d50b08b326ade17f5ff1666efbb;p=thirdparty%2Flxc.git Add missing manpages This introduces manpages for: - lxc-checkconfig - lxc-device - lxc-info - lxc-netstat - lxc-shutdown (wasn't in Makefile) - lxc-start-ephemeral - lxc-version This commit also sorts configure.ac and Makefile.am. Signed-off-by: Stéphane Graber Acked-by: Serge E. Hallyn --- diff --git a/configure.ac b/configure.ac index eb4b714e3..1dff441b4 100644 --- a/configure.ac +++ b/configure.ac @@ -302,31 +302,39 @@ AC_CONFIG_FILES([ config/Makefile doc/Makefile + doc/legacy/lxc-ls.sgml + doc/lxc-attach.sgml + doc/lxc-cgroup.sgml + doc/lxc-checkconfig.sgml + doc/lxc-checkpoint.sgml doc/lxc-clone.sgml + doc/lxc-console.sgml doc/lxc-create.sgml doc/lxc-destroy.sgml + doc/lxc-device.sgml doc/lxc-execute.sgml - doc/lxc-start.sgml - doc/lxc-checkpoint.sgml - doc/lxc-restart.sgml - doc/lxc-stop.sgml - doc/lxc-console.sgml doc/lxc-freeze.sgml - doc/lxc-unfreeze.sgml - doc/lxc-monitor.sgml - doc/lxc-wait.sgml + doc/lxc-info.sgml + doc/lxc-kill.sgml doc/lxc-ls.sgml + doc/lxc-monitor.sgml + doc/lxc-netstat.sgml doc/lxc-ps.sgml + doc/lxc-restart.sgml + doc/lxc-shutdown.sgml + doc/lxc-start-ephemeral.sgml + doc/lxc-start.sgml + doc/lxc-stop.sgml doc/lxc-top.sgml - doc/lxc-cgroup.sgml - doc/lxc-kill.sgml - doc/lxc-attach.sgml + doc/lxc-unfreeze.sgml + doc/lxc-unshare.sgml + doc/lxc-version.sgml + doc/lxc-wait.sgml + doc/lxc.conf.sgml doc/lxc.sgml doc/common_options.sgml doc/see_also.sgml - doc/legacy/lxc-ls.sgml - doc/lxc-unshare.sgml doc/rootfs/Makefile diff --git a/doc/Makefile.am b/doc/Makefile.am index 750398cd1..df5ad73a5 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -7,31 +7,38 @@ EXTRA_DIST = \ if ENABLE_DOCBOOK man_MANS = \ + lxc-attach.1 \ + lxc-cgroup.1 \ + lxc-checkconfig.1 \ + lxc-checkpoint.1 \ lxc-clone.1 \ + lxc-console.1 \ lxc-create.1 \ lxc-destroy.1 \ lxc-execute.1 \ + lxc-freeze.1 \ + lxc-info.1 \ + lxc-kill.1 \ + lxc-monitor.1 \ + lxc-netstat.1 \ + lxc-ps.1 \ + lxc-restart.1 \ + lxc-shutdown.1 \ lxc-start.1 \ lxc-stop.1 \ - lxc-checkpoint.1 \ - lxc-restart.1 \ - lxc-console.1 \ - lxc-freeze.1 \ lxc-unfreeze.1 \ lxc-unshare.1 \ - lxc-monitor.1 \ + lxc-version.1 \ lxc-wait.1 \ - lxc-ps.1 \ - lxc-cgroup.1 \ - lxc-kill.1 \ - lxc-attach.1 \ \ lxc.conf.5 \ \ lxc.7 if ENABLE_PYTHON + man_MANS += lxc-device.1 man_MANS += lxc-ls.1 + man_MANS += lxc-start-ephemeral.1 else man_MANS += legacy/lxc-ls.1 endif diff --git a/doc/lxc-checkconfig.sgml.in b/doc/lxc-checkconfig.sgml.in new file mode 100644 index 000000000..ec7a4c1b2 --- /dev/null +++ b/doc/lxc-checkconfig.sgml.in @@ -0,0 +1,98 @@ + + + +]> + + + + @LXC_GENERATE_DATE@ + + + lxc-checkconfig + 1 + + + + lxc-checkconfig + + + check the current kernel for lxc support + + + + + + lxc-checkconfig + + + + + Description + + lxc-checkconfig check the current kernel for + lxc support + + + + + Examples + + + lxc-checkconfig + + + check the current kernel. + CONFIG can be set in the environment to an alternate location. + + + + + + + &seealso; + + + Author + Stéphane Graber stgraber@ubuntu.com + + + + diff --git a/doc/lxc-device.sgml.in b/doc/lxc-device.sgml.in new file mode 100644 index 000000000..e7773823e --- /dev/null +++ b/doc/lxc-device.sgml.in @@ -0,0 +1,174 @@ + + + + +]> + + + + @LXC_GENERATE_DATE@ + + + lxc-device + 1 + + + + lxc-device + + + manage deices of running containers + + + + + + lxc-device + -h + -n name + add + DEVICE + NAME + + + + + Description + + lxc-device manages devices in running container. + + + + + Options + + + + + + + + The full command help message. + + + + + + + + + + + The name of the target container. + + + + + + + + + + + What action to perform. Only 'add' is supported at this point. + + + + + + + + + + + The device to add to the container. + It can either be the path to a device under /dev or a network + interface name. + + + + + + + + + + + Name for the device within the container. + + + + + + + + Examples + + + lxc-device -n p1 add /dev/video0 + + + Creates a /dev/video0 device in container p1 based on the matching + device on the host. + + + + + + lxc-device -n p1 add eth0 eth1 + + + Moves eth0 from the host as eth1 in p1. + + + + + + + &seealso; + + + Author + Stéphane Graber stgraber@ubuntu.com + + + + diff --git a/doc/lxc-info.sgml.in b/doc/lxc-info.sgml.in new file mode 100644 index 000000000..03212b01a --- /dev/null +++ b/doc/lxc-info.sgml.in @@ -0,0 +1,164 @@ + + + + +]> + + + + @LXC_GENERATE_DATE@ + + + lxc-info + 1 + + + + lxc-info + + + query information about a container + + + + + + lxc-info + -n name + -s + -p + -t state + + + + + Description + + lxc-info queries and shows information about a + container. + + + + + Options + + + + + + + + + The container name. + + + + + + + + + + + Just print the container's state. + + + + + + + + + + + Just print the container's pid. + + + + + + + + + + + Check whether the container is in the provided state. + + + + + + + &commonoptions; + + + Examples + + + lxc-info -n foo + + + Show information for foo. + + + + + + lxc-info -n foo -t RUNNING + + + exits 0 if foo is RUNNING, 1 otherwise. + + + + + + + + &seealso; + + + Author + Stéphane Graber stgraber@ubuntu.com + + + + diff --git a/doc/lxc-ls.sgml.in b/doc/lxc-ls.sgml.in index 75c70be52..83618e5e8 100644 --- a/doc/lxc-ls.sgml.in +++ b/doc/lxc-ls.sgml.in @@ -197,6 +197,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + &seealso; + Author Stéphane Graber stgraber@ubuntu.com diff --git a/doc/lxc-netstat.sgml.in b/doc/lxc-netstat.sgml.in new file mode 100644 index 000000000..ab475f3ea --- /dev/null +++ b/doc/lxc-netstat.sgml.in @@ -0,0 +1,143 @@ + + + +]> + + + + @LXC_GENERATE_DATE@ + + + lxc-netstat + 1 + + + + lxc-netstat + + + run netstat for the specified container + + + + + + lxc-netstat + --name name + -- netstat option + + + + + Description + + lxc-netstat is a wrapper to the netstat command. + + + + + Options + + + + + + + + + The container name. + + + + + + + + + + + The netstat options must be separated + from lxc-netstat options by + the parameter. + + + + + + + + + + Example + + + lxc-netstat --name foo -- -lnp + + + Call netstat -lnp for container foo. + + + + + + + + See Also + + + + netstat + 1 + , + + + + + &seealso; + + + Author + Stéphane Graber stgraber@ubuntu.com + + + + + diff --git a/doc/lxc-ps.sgml.in b/doc/lxc-ps.sgml.in index fb8e4c7e7..e266ba8af 100644 --- a/doc/lxc-ps.sgml.in +++ b/doc/lxc-ps.sgml.in @@ -58,7 +58,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Description - lxc-ps is a wrapper tp ps command + lxc-ps is a wrapper to the ps command to report the name of lxc container associated to reported processes. diff --git a/doc/lxc-start-ephemeral.sgml.in b/doc/lxc-start-ephemeral.sgml.in new file mode 100644 index 000000000..b753a9bf7 --- /dev/null +++ b/doc/lxc-start-ephemeral.sgml.in @@ -0,0 +1,239 @@ + + + + +]> + + + + @LXC_GENERATE_DATE@ + + + lxc-start-ephemeral + 1 + + + + lxc-start-ephemeral + + + start an ephemeral copy of an existing container + + + + + + lxc-start-ephemeral + -o + -n + -d + --bdir + --user + --key + --union-type + --keep-data + COMMAND + + + + + Description + + lxc-start-ephemeral start an ephemeral copy of an + existing container. + + + + + Options + + + + + + + + Original container name + + + + + + + + + + + Name of the ephemeral container (defaults to a random suffix). + + + + + + + + + + + Start the container in background and print the name and IP. + This option can't be used if a command is passed. + + + + + + + + + + + Directory to bind mount into container. + Can be passed multiple times. + + + + + + + + + + + The user to connect to the container as. + Used when passing a command to lxc-start-ephemeral. + + + + + + + + + + + Copy the provided SSH public key into the container. + + + + + + + + + + + Force a specific union file system. + Can be one of: overlayfs aufs + + + + + + + + + + + Use a persistent backend instead of tmpfs. + With this option, you can lxc-stop and lxc-start the no longer so + ephemeral container (it's still an overlay, but a persistent one). + + + + + + + + + + + Immediately run the provided command in the container. + This currently uses ssh (not attach) and is incompatible + with daemon mode. + + + + + + + + See Also + + + + lxc-start + 1 + , + + + Examples + + + lxc-start-ephemeral -o p1 + + + Simply start an ephemeral container and attach to the console. + This container will be based on existing container "p1". + + + + + + lxc-start-ephemeral -o p1 -n p1-ephemeral -d + + + Start an ephemeral container based on p1 called p1-ephemeral and + print its IP and name to the console instead of attaching. + + + + + + + &seealso; + + + Author + Stéphane Graber stgraber@ubuntu.com + + + + diff --git a/doc/lxc-version.sgml.in b/doc/lxc-version.sgml.in new file mode 100644 index 000000000..3833e9fc7 --- /dev/null +++ b/doc/lxc-version.sgml.in @@ -0,0 +1,96 @@ + + + +]> + + + + @LXC_GENERATE_DATE@ + + + lxc-version + 1 + + + + lxc-version + + + print the currently installed lxc version + + + + + + lxc-version + + + + + Description + + lxc-version print the currently installed lxc version + + + + + Examples + + + lxc-version + + + print the currently installed lxc version. + + + + + + + &seealso; + + + Author + Stéphane Graber stgraber@ubuntu.com + + + +