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

doc: Update lxc-attach(1)

Browse Source 
* Add undocumented options (-v/--set-var, --keep-var, -f/--rcfile)
* Change order of option in SYNOPSIS (-L that is placed after "command")
* Add long options in SYNOPSIS

Signed-off-by: KATOH Yasufumi <karma@jazz.email.ne.jp>
This commit is contained in:
KATOH Yasufumi 2016-08-12 17:04:15 +09:00
parent d3488f3706
commit 03b03982dd
1 changed files with 53 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
doc/lxc-attach.sgml.in
View File

@ -50,15 +50,18 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>lxc-attach</command> <command>lxc-attach</command>
<arg choice="req">-n <replaceable>name</replaceable></arg> <arg choice="req">-n, --name <replaceable>name</replaceable></arg>
<arg choice="opt">-a <replaceable>arch</replaceable></arg> <arg choice="opt">-f, --rcfile <replaceable>config_file</replaceable></arg>
<arg choice="opt">-e</arg> <arg choice="opt">-a, --arch <replaceable>arch</replaceable></arg>
<arg choice="opt">-s <replaceable>namespaces</replaceable></arg> <arg choice="opt">-e, --elevated-privileges <replaceable>privileges</replaceable></arg>
<arg choice="opt">-R</arg> <arg choice="opt">-s, --namespaces <replaceable>namespaces</replaceable></arg>
<arg choice="opt">-R, --remount-sys-proc</arg>
<arg choice="opt">--keep-env</arg> <arg choice="opt">--keep-env</arg>
<arg choice="opt">--clear-env</arg> <arg choice="opt">--clear-env</arg>
<arg choice="opt">-L, --pty-log <replaceable>file</replaceable></arg>
<arg choice="opt">-v, --set-var <replaceable>variable</replaceable></arg>
<arg choice="opt">--keep-var <replaceable>variable</replaceable></arg>
<arg choice="opt">-- <replaceable>command</replaceable></arg> <arg choice="opt">-- <replaceable>command</replaceable></arg>
<arg choice="opt">-L <replaceable>file</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -102,6 +105,23 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<variablelist> <variablelist>
<varlistentry>
<term>
<option>-f, --rcfile <replaceable>config_file</replaceable></option>
</term>
<listitem>
<para>
Specify the configuration file to configure the virtualization
and isolation functionalities for the container.
</para>
<para>
This configuration file if present will be used even if there is
already a configuration file present in the previously created
container (via lxc-create).
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<option>-a, --arch <replaceable>arch</replaceable></option> <option>-a, --arch <replaceable>arch</replaceable></option>
@ -252,6 +272,33 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term>
<option>-v, --set-var <replaceable>variable</replaceable></option>
</term>
<listitem>
<para>
Set an additional environment variable that is seen by the
attached program in the container. It is specified in the
form of "VAR=VALUE", and can be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--keep-var <replaceable>variable</replaceable></option>
</term>
<listitem>
<para>
Keep a specified environment variable. It can only be
specified in conjunction
with <replaceable>--clear-env</replaceable>, and can be
specified multiple times.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>