proxmox-mirrors/mirror_lxc
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_lxc synced 2025-08-10 18:47:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix manpage typo

Browse Source 
Fix and clarify some parts of the lxc.conf man page.

Signed-off-by: Daniel Lezcano <dlezcano@fr.ibm.com>
This commit is contained in:
Paul Fee 2010-01-05 13:11:27 +01:00 committed by Daniel Lezcano
parent e892973e39
commit 23a92fad75
1 changed files with 46 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
doc/lxc.conf.sgml.in
View File

@ -71,7 +71,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<para> <para>
Each option in the configuration file has the form <command>key Each option in the configuration file has the form <command>key
= value</command> fitting in one line. The '#' caracter means = value</command> fitting in one line. The '#' character means
the line is a comment. the line is a comment.
</para> </para>
@ -101,11 +101,11 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<title>Network</title> <title>Network</title>
<para> <para>
The network section defines how the network is virtualized in The network section defines how the network is virtualized in
the container. The network virtualization acts at the layer the container. The network virtualization acts at layer
two, so in order to use the network, a few information should two. In order to use the network virtualization, parameters
be specified to define the network interfaces to be used by must be specified to define the network interfaces of the
the container. Several virtual interfaces can be assigned and container. Several virtual interfaces can be assigned and used
used in a container either if the system has only one physical in a container even if the system has only one physical
network interface. network interface.
</para> </para>
<variablelist> <variablelist>
@ -118,29 +118,28 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
specify what kind of network virtualization to be used specify what kind of network virtualization to be used
for the container. Each time for the container. Each time
a <option>lxc.network.type</option> field is found a new a <option>lxc.network.type</option> field is found a new
round of network configuration begins. By this way round of network configuration begins. In this way,
several network virtualization can be specified for the several network virtualization types can be specified
same container, as well as assigning several network for the same container, as well as assigning several
interfaces for one container. The different network interfaces for one container. The different
virtualization types can be: virtualization types can be:
</para> </para>
<para> <para>
<option>empty:</option> a new network stack is created <option>empty:</option> will create only the loopback
for the container, but it will not contain any network
interface. interface.
</para> </para>
<para> <para>
<option>veth:</option> a new network stack is created, a <option>veth:</option> a peer network device is created
peer network device is created with one side assigned to with one side assigned to the container and the other
the container and the other side is attached to a bridge side is attached to a bridge specified by
specified by the <option>lxc.network.link</option>. If the <option>lxc.network.link</option>. If the bridge is
the bridge is not specified, then the veth pair device not specified, then the veth pair device will be created
will be created but not attached to any but not attached to any bridge. Otherwise, the bridge
bridge. Otherwise, the bridge has to be setup before on has to be setup before on the
the system, <command>lxc</command> won't handle system, <command>lxc</command> won't handle any
any configuration outside of the container. By configuration outside of the container. By
default <command>lxc</command> choose a name for the default <command>lxc</command> choose a name for the
network device belonging to the outside of the network device belonging to the outside of the
container, this name is handled container, this name is handled
@ -151,17 +150,16 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</para> </para>
<para> <para>
<option>vlan:</option> a new network stack is created, a <option>vlan:</option> a vlan interface is linked with
vlan interface is linked with the interface specified by the interface specified by
the <option>lxc.network.link</option> and assigned to the <option>lxc.network.link</option> and assigned to
the container. The vlan identifier is specified with the the container. The vlan identifier is specified with the
option <option>lxc.network.vlan.id</option>. option <option>lxc.network.vlan.id</option>.
</para> </para>
<para> <para>
<option>macvlan:</option> a new network stack is <option>macvlan:</option> a macvlan interface is linked
created, a macvlan interface is linked with the with the interface specified by
interface specified by
the <option>lxc.network.link</option> and assigned to the <option>lxc.network.link</option> and assigned to
the container. the container.
<option>lxc.network.macvlan.mode</option> specifies the <option>lxc.network.macvlan.mode</option> specifies the
@ -189,10 +187,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</para> </para>
<para> <para>
<option>phys:</option> a new network stack is created <option>phys:</option> an already existing interface
and an already existing interface specified by specified by the <option>lxc.network.link</option> is
the <option>lxc.network.link</option> is assigned to the assigned to the container.
container.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -230,8 +227,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</term> </term>
<listitem> <listitem>
<para> <para>
the interface name is dynamically allocated, but if an the interface name is dynamically allocated, but if
other name is needed because the configuration files another name is needed because the configuration files
being used by the container use a generic name, being used by the container use a generic name,
eg. eth0, this option will rename the interface in the eg. eth0, this option will rename the interface in the
container. container.
@ -246,9 +243,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<listitem> <listitem>
<para> <para>
the interface mac address is dynamically allocated by the interface mac address is dynamically allocated by
default to the virtual interface, but in some case, this default to the virtual interface, but in some cases,
is needed to resolve a mac address conflict or to have this is needed to resolve a mac address conflict or to
always the same link-locak ipv6 address. always have the same link-local ipv6 address
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -315,10 +312,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
inittab file is setup to launch a getty on the ttys. This inittab file is setup to launch a getty on the ttys. This
option will specify the number of ttys to be available for the option will specify the number of ttys to be available for the
container. The number of getty in the inittab file of the container. The number of getty in the inittab file of the
container and the number of tty specified in this container should not be greater than the number of ttys
configuration file should be equal, otherwise the getty will specified in this configuration file, otherwise the excess
die and respawn indefinitly giving annoying messages on the getty sessions will die and respawn indefinitly giving
console. annoying messages on the console.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -399,9 +396,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<para> <para>
The control group section contains the configuration for the The control group section contains the configuration for the
different subsystem. <command>lxc</command> does not check the different subsystem. <command>lxc</command> does not check the
correctness of the subsystem name. This has the inconvenient correctness of the subsystem name. This has the disadvantage
to have the error being detected at runtime, but the advantage of not detecting configuration errors until the container is
to support any future subsystem. started, but has the advantage of permitting any future
subsystem.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -410,9 +408,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</term> </term>
<listitem> <listitem>
<para> <para>
specify the control group value to be set. This field is specify the control group value to be set. The
the identifier to tell the following keyword is the subsystem name is the literal name of the control group
literal name of the control group subsystem, subsystem. The permitted names and the syntax of their
values is not dictated by LXC, instead it depends on the
features of the Linux kernel running at the time the
container is started,
eg. <option>lxc.cgroup.cpuset.cpus</option> eg. <option>lxc.cgroup.cpuset.cpus</option>
</para> </para>
</listitem> </listitem>