doc/lxc-netstat.sgml.in

   1 <!--
   2
   3 (C) Copyright Canonical Ltd. 2013
   4
   5 Authors:
   6 Stéphane Graber <stgraber@ubuntu.com>
   7
   8 This library is free software; you can redistribute it and/or
   9 modify it under the terms of the GNU Lesser General Public
  10 License as published by the Free Software Foundation; either
  11 version 2.1 of the License, or (at your option) any later version.
  12
  13 This library is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 Lesser General Public License for more details.
  17
  18 You should have received a copy of the GNU Lesser General Public
  19 License along with this library; if not, write to the Free Software
  20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21
  22 -->
  23
  24 <!DOCTYPE refentry PUBLIC @docdtd@ [
  25
  26 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  27 ]>
  28
  29 <refentry>
  30
  31   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  32
  33   <refmeta>
  34     <refentrytitle>lxc-netstat</refentrytitle>
  35     <manvolnum>1</manvolnum>
  36   </refmeta>
  37
  38   <refnamediv>
  39     <refname>lxc-netstat</refname>
  40
  41     <refpurpose>
  42       run netstat for the specified container
  43     </refpurpose>
  44   </refnamediv>
  45
  46   <refsynopsisdiv>
  47     <cmdsynopsis>
  48       <command>lxc-netstat</command>
  49       <arg choice="opt">--name <replaceable>name</replaceable></arg>
  50       <arg choice="opt">-- netstat option</arg>
  51     </cmdsynopsis>
  52   </refsynopsisdiv>
  53
  54   <refsect1>
  55     <title>Description</title>
  56     <para>
  57       <command>lxc-netstat</command> is a wrapper to the netstat command.
  58     </para>
  59   </refsect1>
  60
  61   <refsect1>
  62     <title>Options</title>
  63     <variablelist>
  64
  65       <varlistentry>
  66         <term>
  67           <option>-n, --name <replaceable>name</replaceable></option>
  68         </term>
  69         <listitem>
  70           <para>
  71             The container name.
  72           </para>
  73         </listitem>
  74       </varlistentry>
  75
  76       <varlistentry>
  77         <term>
  78           <option><optional>netstat options</optional></option>
  79         </term>
  80         <listitem>
  81           <para>
  82             The <command>netstat</command> options must be separated
  83             from <command>lxc-netstat</command> options by
  84             the <option>--</option> parameter.
  85           </para>
  86         </listitem>
  87       </varlistentry>
  88
  89     </variablelist>
  90
  91   </refsect1>
  92
  93   <refsect1>
  94     <title>Example</title>
  95     <variablelist>
  96       <varlistentry>
  97         <term>lxc-netstat --name foo -- -lnp</term>
  98         <listitem>
  99         <para>
 100           Call netstat -lnp for container foo.
 101         </para>
 102         </listitem>
 103       </varlistentry>
 104     </variablelist>
 105   </refsect1>
 106
 107   <refsect1>
 108     <title>See Also</title>
 109
 110     <simpara>
 111       <citerefentry>
 112         <refentrytitle>netstat</refentrytitle>
 113         <manvolnum>1</manvolnum>
 114       </citerefentry>,
 115     </simpara>
 116
 117   </refsect1>
 118
 119   &seealso;
 120
 121   <refsect1>
 122     <title>Author</title>
 123     <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
 124   </refsect1>
 125
 126 </refentry>
 127
 128 <!-- Keep this comment at the end of the file
 129 Local variables:
 130 mode: sgml
 131 sgml-omittag:t
 132 sgml-shorttag:t
 133 sgml-minimize-attributes:nil
 134 sgml-always-quote-attributes:t
 135 sgml-indent-step:2
 136 sgml-indent-data:t
 137 sgml-parent-document:nil
 138 sgml-default-dtd-file:nil
 139 sgml-exposed-tags:nil
 140 sgml-local-catalogs:nil
 141 sgml-local-ecat-files:nil
 142 End:
 143 -->