← Back to branch summary

~ubuntu-branches/ubuntu/quantal/lxc/quantal-201205292108

« back to all changes in this revision

Viewing changes to doc/lxc-ps.sgml.in

  • Committer: Bazaar Package Importer
  • Author(s): Guido Trotter
  • Date: 2009-07-25 12:24:30 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20090725122430-dxv1wb7ds07fc0sk
Tags: 0.6.3-1
* New Upstream Version
* Remove duplicate build-dependency on autotools-dev
* Build depend on linux-libc-dev
* Disable checking of netlink headers from configure
  (currently fails under sid)
* Upgrade standards-version to 3.8.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/lxc-ps.sgml.in
24
24
 
25
25
-->
26
26
 
27
 
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">
 
27
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
28
 
 
29
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 
30
]>
28
31
 
29
32
<refentry>
30
33
 
45
48
 
46
49
  <refsynopsisdiv>
47
50
    <cmdsynopsis>
48
 
      <command>lxc-ps <replaceable>-n name</replaceable>
 
51
      <command>lxc-ps <optional>--name name</optional>
 
52
        <optional>--lxc</optional>
49
53
        <optional>ps option</optional>
50
54
      </command>
51
55
    </cmdsynopsis>
54
58
  <refsect1>
55
59
    <title>Description</title>
56
60
    <para>
57
 
      <command>lxc-ps</command> list the processes belonging to a
58
 
      specific container.
 
61
      <command>lxc-ps</command> is a wrapper tp ps command
 
62
        to report the name of lxc container associated
 
63
        to reported processes.
 
64
    </para>
 
65
    <para>
 
66
        The cgroup fs must be mounted before container creation,
 
67
        to be able to have <command>lxc-ps</command> to find
 
68
        the container associated to processes.
 
69
    </para>
 
70
    <para>
 
71
        The additionnal specified ps options must not
 
72
        remove the default ps header and the pid information,
 
73
        to be able to have the <command>lxc-ps</command> to find
 
74
        the container associated to processes.
59
75
    </para>
60
76
  </refsect1>
61
77
 
65
81
 
66
82
      <varlistentry>
67
83
        <term>
68
 
          <option><replaceable>-n name</replaceable></option>
69
 
        </term>
70
 
        <listitem>
71
 
          <para>
72
 
            specify the container <replaceable>name</replaceable> to
73
 
            list the processes.
 
84
          <option><replaceable>--name NAME</replaceable></option>
 
85
        </term>
 
86
        <listitem>
 
87
          <para>
 
88
            specify the container <replaceable>NAME</replaceable>
 
89
            to limit the output to the processes belonging 
 
90
            to this container name.         
 
91
          </para>
 
92
        </listitem>
 
93
      </varlistentry>
 
94
 
 
95
      <varlistentry>
 
96
        <term>
 
97
          <option><replaceable>--lxc</replaceable></option>
 
98
        </term>
 
99
        <listitem>
 
100
          <para>
 
101
            limit the output to the processes belonging 
 
102
            to all lxc containers.
74
103
          </para>
75
104
        </listitem>
76
105
      </varlistentry>
92
121
  </refsect1>
93
122
 
94
123
  <refsect1>
95
 
    <title>Examples</title>
 
124
    <title>Example</title>
96
125
    <variablelist>
97
126
      <varlistentry>
98
 
        <term>lxc-ps -n foo --forest</term>
 
127
        <term>lxc-ps --name foo --forest</term>
99
128
        <listitem>
100
129
        <para>
101
130
          list all the processes belonging to container 'foo' and show
103
132
        </para>
104
133
        </listitem>
105
134
      </varlistentry>
106
 
 
107
 
      <varlistentry>
108
 
        <term>lxc-ps -n foo -o pid=</term>
109
 
        <listitem>
110
 
        <para>
111
 
          list all the containers and display the list in one column.
112
 
        </para>
113
 
        </listitem>
114
 
      </varlistentry>
115
 
 
116
135
    </variablelist>
117
136
  </refsect1>
118
137
 
126
145
      </citerefentry>,
127
146
    </simpara>
128
147
 
129
 
 
130
148
  </refsect1>
131
149
 
 
150
  &seealso;
 
151
 
132
152
  <refsect1>
133
153
    <title>Author</title>
134
154
    <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>