Debian Codegraph @

doc/lxc-device.sgml.in

raw
1 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
2
3 <!DOCTYPE refentry PUBLIC @docdtd@ [
4
5 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
6 ]>
7
8 <refentry>
9
10 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
11
12 <refmeta>
13 <refentrytitle>lxc-device</refentrytitle>
14 <manvolnum>1</manvolnum>
15 </refmeta>
16
17 <refnamediv>
18 <refname>lxc-device</refname>
19
20 <refpurpose>
21 manage devices of running containers
22 </refpurpose>
23 </refnamediv>
24
25 <refsynopsisdiv>
26 <cmdsynopsis>
27 <command>lxc-device</command>
28 <arg choice="opt">-h</arg>
29 <arg choice="opt">-n <replaceable>name</replaceable></arg>
30 <arg choice="opt">add</arg>
31 <arg choice="opt">DEVICE</arg>
32 <arg choice="opt">NAME</arg>
33 </cmdsynopsis>
34 </refsynopsisdiv>
35
36 <refsect1>
37 <title>Description</title>
38 <para>
39 <command>lxc-device</command> manages devices in running container.
40 </para>
41 </refsect1>
42
43 <refsect1>
44 <title>Options</title>
45 <variablelist>
46 <varlistentry>
47 <term>
48 <option>-h</option>
49 </term>
50 <listitem>
51 <para>
52 The full command help message.
53 </para>
54 </listitem>
55 </varlistentry>
56
57 <varlistentry>
58 <term><option>-n, --name=<replaceable>NAME</replaceable></option></term>
59 <listitem>
60 <para>
61 The name of the target container.
62 </para>
63 </listitem>
64 </varlistentry>
65
66 <varlistentry>
67 <term>
68 <option>action</option>
69 </term>
70 <listitem>
71 <para>
72 What action to perform. Only 'add' is supported at this point.
73 </para>
74 </listitem>
75 </varlistentry>
76
77 <varlistentry>
78 <term>
79 <option>DEVICE</option>
80 </term>
81 <listitem>
82 <para>
83 The device to add to the container.
84 It can either be the path to a device under /dev or a network
85 interface name.
86 </para>
87 </listitem>
88 </varlistentry>
89
90 <varlistentry>
91 <term>
92 <option><optional>NAME</optional></option>
93 </term>
94 <listitem>
95 <para>
96 Name for the device within the container.
97 </para>
98 </listitem>
99 </varlistentry>
100 </variablelist>
101 </refsect1>
102
103 <refsect1>
104 <title>Examples</title>
105 <variablelist>
106 <varlistentry>
107 <term>lxc-device -n p1 add /dev/video0</term>
108 <listitem>
109 <para>
110 Creates a /dev/video0 device in container p1 based on the matching
111 device on the host.
112 </para>
113 </listitem>
114 </varlistentry>
115
116 <varlistentry>
117 <term>lxc-device -n p1 add eth0 eth1</term>
118 <listitem>
119 <para>
120 Moves eth0 from the host as eth1 in p1.
121 </para>
122 </listitem>
123 </varlistentry>
124 </variablelist>
125 </refsect1>
126
127 &seealso;
128 </refentry>
129
130 <!-- Keep this comment at the end of the file
131 Local variables:
132 mode: sgml
133 sgml-omittag:t
134 sgml-shorttag:t
135 sgml-minimize-attributes:nil
136 sgml-always-quote-attributes:t
137 sgml-indent-step:2
138 sgml-indent-data:t
139 sgml-parent-document:nil
140 sgml-default-dtd-file:nil
141 sgml-exposed-tags:nil
142 sgml-local-catalogs:nil
143 sgml-local-ecat-files:nil
144 End:
145 -->