From df3415e02282317348bbd5f9ce66d03e1c81eeec Mon Sep 17 00:00:00 2001 From: Serge Hallyn Date: Tue, 17 Dec 2013 11:02:44 -0600 Subject: [PATCH] add manpages for lxc-user-nic Signed-off-by: Serge Hallyn --- configure.ac | 2 + doc/Makefile.am | 2 + doc/lxc-user-nic.sgml.in | 184 +++++++++++++++++++++++++++++++++++++++ doc/lxc-usernet.sgml.in | 159 +++++++++++++++++++++++++++++++++ 4 files changed, 347 insertions(+) create mode 100644 doc/lxc-user-nic.sgml.in create mode 100644 doc/lxc-usernet.sgml.in diff --git a/configure.ac b/configure.ac index c8a08a9c5..cd200b03c 100644 --- a/configure.ac +++ b/configure.ac @@ -498,10 +498,12 @@ AC_CONFIG_FILES([ doc/lxc-top.sgml doc/lxc-unfreeze.sgml doc/lxc-unshare.sgml + doc/lxc-user-nic.sgml doc/lxc-version.sgml doc/lxc-wait.sgml doc/lxc.conf.sgml + doc/lxc-usernet.sgml doc/lxc.sgml doc/common_options.sgml doc/see_also.sgml diff --git a/doc/Makefile.am b/doc/Makefile.am index 033a80ca1..e327a4650 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -35,10 +35,12 @@ man_MANS = \ lxc-stop.1 \ lxc-unfreeze.1 \ lxc-unshare.1 \ + lxc-user-nic.1 \ lxc-version.1 \ lxc-wait.1 \ \ lxc.conf.5 \ + lxc-usernet.5 \ \ lxc.7 diff --git a/doc/lxc-user-nic.sgml.in b/doc/lxc-user-nic.sgml.in new file mode 100644 index 000000000..8d404bc4a --- /dev/null +++ b/doc/lxc-user-nic.sgml.in @@ -0,0 +1,184 @@ + + + + +]> + + + + @LXC_GENERATE_DATE@ + + + lxc-user-nic + 1 + + + + lxc-user-nic + + + Create and attach a nic to another network namespace. + + + + + + lxc-user-nic + pid + type + bridge + nicname + + + + + Description + + + lxc-user-nic is a setuid-root program with which + unprivileged users may create network interfaces for use by a lxc container. + + + It will consult the configuration file @LXC_USERNIC_CONF@ + to determine number of interfaces which the calling user is allowed to + create, and which bridge he may attach them to. It tracks the + number of interfaces each user has created using the file + @LXC_USERNIC_DB@. It ensures that the calling + user is privileged over the network namespace to which the interface + will be attached. + + + + + + + Options + + + + + + + + + + The process id for the task to whose network namespace the interface + should be attached. + + + + + + + + + + + The network interface type to attach. Currently only veth is + supported. With this type, two interfaces representing each + tunnel endpoint are created. One endpoint will be attached + to the specified bridge, while the other will be passed into + the container. + + + + + + + + + + + The bridge to which to attach the network interface, for + instance lxcbr0. + + + + + + + + + + + The desired interface name in the container. This will be + eth0 if unspecified. + + + + + + + + + &commonoptions; + + + See Also + + + + lxc + 1 + , + + + lxc-start + 1 + , + + + lxc-usernet.conf + 5 + + + + + + Author + Daniel Lezcano daniel.lezcano@free.fr + + + + + diff --git a/doc/lxc-usernet.sgml.in b/doc/lxc-usernet.sgml.in new file mode 100644 index 000000000..856523806 --- /dev/null +++ b/doc/lxc-usernet.sgml.in @@ -0,0 +1,159 @@ + + + +]> + + + + @LXC_GENERATE_DATE@ + + + lxc-usernet + 5 + + + + lxc-usernet + + + unprivileged user network administration file. + + + + + Description + + + @LXC_USERNIC_CONF@ controls the limits which the + program lxc-user-nic places on network interfaces + which an unprivileged user may create. + + + + Configuration + + This file consists of multiple entries, one per line, of the form: + + + + user type bridge number + + + Where + + + + + + + + + + + is the username to whom this entry applies. + + + + + + + + + + + is the type of network interface being allowed. Only veth + is currently supported. + + + + + + + + + + + is the bridge to which the network interfaces may be attached, for + instance lxcbr0. + + + + + + + + + + + is the number of network interfaces of the given type which the + given user may attach to the given bridge, for instance 2. + + + + + + + + + + See Also + + + lxc + 1 + , + + lxc-user-nic + 1 + + + + + + Author + Daniel Lezcano daniel.lezcano@free.fr + + + + +