Merge pull request #2532 from tcharding/unshare-err

[mirror_lxc.git] / doc / lxc-attach.sgml.in

diff --git a/doc/lxc-attach.sgml.in b/doc/lxc-attach.sgml.in
index 3b103f90bf513512d57aa5740254230e5e924a33..713a30e7fbc921c122e303b3a2f5713f4fe09e46 100644 (file)
--- a/doc/lxc-attach.sgml.in
+++ b/doc/lxc-attach.sgml.in
@@ -50,15 +50,17 @@ 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">-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>
 
@@ -102,6 +104,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>
@@ -238,16 +257,27 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
       <varlistentry>
        <term>
-         <option>-L, --pty-log <replaceable>file</replaceable></option>
+         <option>-v, --set-var <replaceable>variable</replaceable></option>
        </term>
        <listitem>
          <para>
-       Specify a file where the output of <command>lxc-attach</command> will be
-       logged.
+           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>
-           <emphasis>Important:</emphasis>  When a standard file descriptor
-           does not refer to a pty output produced on it will not be logged.
+           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>