man/network-device.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <refentry id="network-device">
   6         <refentryinfo>
   7                 <title>network-device</title>
   8                 <productname>network</productname>
   9
  10                 <authorgroup>
  11                         <author>
  12                                 <contrib>Developer</contrib>
  13                                 <firstname>Michael</firstname>
  14                                 <surname>Tremer</surname>
  15                                 <email>michael.tremer@ipfire.org</email>
  16                         </author>
  17                 </authorgroup>
  18         </refentryinfo>
  19
  20         <refmeta>
  21                 <refentrytitle>network-device</refentrytitle>
  22                 <manvolnum>8</manvolnum>
  23         </refmeta>
  24
  25         <refnamediv>
  26                 <refname>network-device</refname>
  27                 <refpurpose>Network Configuration Control Program</refpurpose>
  28         </refnamediv>
  29
  30         <refsynopsisdiv>
  31                 <cmdsynopsis>
  32                         <command>network device <arg choice="plain">COMMAND</arg></command>
  33                 </cmdsynopsis>
  34         </refsynopsisdiv>
  35
  36         <refsect1>
  37                 <title>Description</title>
  38
  39                 <para>
  40                         With help of the <command>device</command> subcommands, it is very easy
  41                         to get status information about network devices and to do some more
  42                         things.
  43                 </para>
  44         </refsect1>
  45
  46         <refsect1>
  47                 <title>Commands</title>
  48
  49                 <para>
  50                         The following commands are understood:
  51                 </para>
  52
  53                 <variablelist>
  54                         <varlistentry>
  55                                 <term>
  56                                         <command><replaceable>DEVICE</replaceable> status</command>
  57                                 </term>
  58
  59                                 <listitem>
  60                                         <para>
  61                                                 This will show you very detailed information about the given
  62                                                 device.
  63                                         </para>
  64                                         <para>
  65                                                 This is all about the ethernet parts of the device and
  66                                                 does not contain any IP information as this is defined
  67                                                 as a zone (<citerefentry>
  68                                                         <refentrytitle>network-zone</refentrytitle>
  69                                                         <manvolnum>8</manvolnum>
  70                                                 </citerefentry>).
  71                                         </para>
  72                                 </listitem>
  73                         </varlistentry>
  74
  75                         <varlistentry>
  76                                 <term>
  77                                         <command><replaceable>DEVICE</replaceable> discover</command>
  78                                 </term>
  79
  80                                 <listitem>
  81                                         <para>
  82                                                 Runs a discovery for many hooks on the given device.
  83                                                 This will check if the hook can find for example a DHCP
  84                                                 server or DSLAM and thus predict for what the device
  85                                                 should be used.
  86                                         </para>
  87                                 </listitem>
  88                         </varlistentry>
  89
  90                         <varlistentry>
  91                                 <term>
  92                                         <command><replaceable>DEVICE</replaceable> unlock</command>
  93                                 </term>
  94
  95                                 <listitem>
  96                                         <para>
  97                                                 This command will unlock the SIM card in a modem.
  98                                                 Only serial devices are supported which are the most
  99                                                 UMTS or 3G modems.
 100                                         </para>
 101                                         <para>
 102                                                 For the PIN or PUK code, the user will be prompted.
 103                                         </para>
 104                                 </listitem>
 105                         </varlistentry>
 106                 </variablelist>
 107         </refsect1>
 108
 109         <refsect1>
 110                 <title>See Also</title>
 111
 112                 <para>
 113                         <citerefentry>
 114                                 <refentrytitle>network</refentrytitle>
 115                                 <manvolnum>8</manvolnum>
 116                         </citerefentry>
 117                 </para>
 118         </refsect1>
 119 </refentry>