doc/lxc-device.sgml.in

   1
   2 <!--
   3
   4 (C) Copyright Canonical Ltd. 2013
   5
   6 Authors:
   7 Stéphane Graber <stgraber@ubuntu.com>
   8
   9 This library is free software; you can redistribute it and/or
  10 modify it under the terms of the GNU Lesser General Public
  11 License as published by the Free Software Foundation; either
  12 version 2.1 of the License, or (at your option) any later version.
  13
  14 This library is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 Lesser General Public License for more details.
  18
  19 You should have received a copy of the GNU Lesser General Public
  20 License along with this library; if not, write to the Free Software
  21 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  22
  23 -->
  24
  25 <!DOCTYPE refentry PUBLIC @docdtd@ [
  26
  27 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  28 ]>
  29
  30 <refentry>
  31
  32   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  33
  34   <refmeta>
  35     <refentrytitle>lxc-device</refentrytitle>
  36     <manvolnum>1</manvolnum>
  37   </refmeta>
  38
  39   <refnamediv>
  40     <refname>lxc-device</refname>
  41
  42     <refpurpose>
  43       manage devices of running containers
  44     </refpurpose>
  45   </refnamediv>
  46
  47   <refsynopsisdiv>
  48     <cmdsynopsis>
  49       <command>lxc-device</command>
  50       <arg choice="opt">-h</arg>
  51       <arg choice="opt">-n <replaceable>name</replaceable></arg>
  52       <arg choice="opt">add</arg>
  53       <arg choice="opt">DEVICE</arg>
  54       <arg choice="opt">NAME</arg>
  55     </cmdsynopsis>
  56   </refsynopsisdiv>
  57
  58   <refsect1>
  59     <title>Description</title>
  60     <para>
  61       <command>lxc-device</command> manages devices in running container.
  62     </para>
  63   </refsect1>
  64
  65   <refsect1>
  66     <title>Options</title>
  67     <variablelist>
  68       <varlistentry>
  69         <term>
  70           <option>-h</option>
  71         </term>
  72         <listitem>
  73           <para>
  74             The full command help message.
  75           </para>
  76         </listitem>
  77       </varlistentry>
  78
  79       <varlistentry>
  80         <term><option>-n, --name=<replaceable>NAME</replaceable></option></term>
  81         <listitem>
  82           <para>
  83              The name of the target container.
  84           </para>
  85         </listitem>
  86       </varlistentry>
  87
  88       <varlistentry>
  89         <term>
  90           <option>action</option>
  91         </term>
  92         <listitem>
  93           <para>
  94             What action to perform. Only 'add' is supported at this point.
  95           </para>
  96         </listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term>
 101           <option>DEVICE</option>
 102         </term>
 103         <listitem>
 104           <para>
 105             The device to add to the container.
 106             It can either be the path to a device under /dev or a network
 107             interface name.
 108           </para>
 109         </listitem>
 110       </varlistentry>
 111
 112       <varlistentry>
 113         <term>
 114           <option><optional>NAME</optional></option>
 115         </term>
 116         <listitem>
 117           <para>
 118             Name for the device within the container.
 119           </para>
 120         </listitem>
 121       </varlistentry>
 122     </variablelist>
 123   </refsect1>
 124
 125   <refsect1>
 126     <title>Examples</title>
 127     <variablelist>
 128       <varlistentry>
 129         <term>lxc-device -n p1 add /dev/video0</term>
 130         <listitem>
 131         <para>
 132           Creates a /dev/video0 device in container p1 based on the matching
 133           device on the host.
 134         </para>
 135         </listitem>
 136       </varlistentry>
 137
 138       <varlistentry>
 139         <term>lxc-device -n p1 add eth0 eth1</term>
 140         <listitem>
 141         <para>
 142            Moves eth0 from the host as eth1 in p1.
 143         </para>
 144         </listitem>
 145       </varlistentry>
 146     </variablelist>
 147   </refsect1>
 148
 149   &seealso;
 150
 151   <refsect1>
 152     <title>Author</title>
 153     <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
 154   </refsect1>
 155 </refentry>
 156
 157 <!-- Keep this comment at the end of the file
 158 Local variables:
 159 mode: sgml
 160 sgml-omittag:t
 161 sgml-shorttag:t
 162 sgml-minimize-attributes:nil
 163 sgml-always-quote-attributes:t
 164 sgml-indent-step:2
 165 sgml-indent-data:t
 166 sgml-parent-document:nil
 167 sgml-default-dtd-file:nil
 168 sgml-exposed-tags:nil
 169 sgml-local-catalogs:nil
 170 sgml-local-ecat-files:nil
 171 End:
 172 -->