Skip to content

Commit

Permalink
doc: Update lxc-attach(1)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
tenforward committed Aug 12, 2016
1 parent d3488f3 commit 03b0398
Showing 1 changed file with 53 additions and 6 deletions.
59 changes: 53 additions & 6 deletions doc/lxc-attach.sgml.in
Expand Up @@ -50,15 +50,18 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<refsynopsisdiv>
<cmdsynopsis>
<command>lxc-attach</command>
<arg choice="req">-n <replaceable>name</replaceable></arg>
<arg choice="opt">-a <replaceable>arch</replaceable></arg>
<arg choice="opt">-e</arg>
<arg choice="opt">-s <replaceable>namespaces</replaceable></arg>
<arg choice="opt">-R</arg>
<arg choice="req">-n, --name <replaceable>name</replaceable></arg>
<arg choice="opt">-f, --rcfile <replaceable>config_file</replaceable></arg>
<arg choice="opt">-a, --arch <replaceable>arch</replaceable></arg>
<arg choice="opt">-e, --elevated-privileges <replaceable>privileges</replaceable></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">--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">-L <replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

Expand Down Expand Up @@ -102,6 +105,23 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

<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>
<term>
<option>-a, --arch <replaceable>arch</replaceable></option>
Expand Down Expand Up @@ -252,6 +272,33 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
</listitem>
</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>

</refsect1>
Expand Down

0 comments on commit 03b0398

Please sign in to comment.