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>list</command>
  57                                 </term>
  58
  59                                 <listitem>
  60                                         <para>
  61                                                 The <command>list</command> command will show a list
  62                                                 of all devices that are currently plugged in or active
  63                                                 on the system.
  64                                                 This includes PHYs and serial devices as well.
  65                                         </para>
  66                                 </listitem>
  67                         </varlistentry>
  68
  69                         <varlistentry>
  70                                 <term>
  71                                         <command><replaceable>DEVICE</replaceable> status</command>
  72                                 </term>
  73
  74                                 <listitem>
  75                                         <para>
  76                                                 This will show you very detailed information about the given
  77                                                 device.
  78                                         </para>
  79                                         <para>
  80                                                 This is all about the ethernet parts of the device and
  81                                                 does not contain any IP information as this is defined
  82                                                 as a zone (<citerefentry>
  83                                                         <refentrytitle>network-zone</refentrytitle>
  84                                                         <manvolnum>8</manvolnum>
  85                                                 </citerefentry>).
  86                                         </para>
  87                                 </listitem>
  88                         </varlistentry>
  89
  90                         <varlistentry>
  91                                 <term>
  92                                         <command><replaceable>DEVICE</replaceable> discover</command>
  93                                 </term>
  94
  95                                 <listitem>
  96                                         <para>
  97                                                 Runs a discovery for many hooks on the given device.
  98                                                 This will check if the hook can find for example a DHCP
  99                                                 server or DSLAM and thus predict for what the device
 100                                                 should be used.
 101                                         </para>
 102                                 </listitem>
 103                         </varlistentry>
 104
 105                         <varlistentry>
 106                                 <term>
 107                                         <command><replaceable>DEVICE</replaceable> unlock</command>
 108                                 </term>
 109
 110                                 <listitem>
 111                                         <para>
 112                                                 This command will unlock the SIM card in a modem.
 113                                                 Only serial devices are supported which are the most
 114                                                 UMTS or 3G modems.
 115                                         </para>
 116                                         <para>
 117                                                 For the PIN or PUK code, the user will be prompted.
 118                                         </para>
 119                                 </listitem>
 120                         </varlistentry>
 121
 122                         <varlistentry>
 123                                 <term>
 124                                         <command><replaceable>DEVICE</replaceable> monitor</command>
 125                                 </term>
 126
 127                                 <listitem>
 128                                         <para>
 129                                                 The <command>monitor</command> command is used to
 130                                                 create a monitor interface for wireless modules.
 131                                                 An instance of tcpdump will be started and show
 132                                                 all frames that are sent or received on the 802.11
 133                                                 layer (layer 2) of the wireless network.
 134                                         </para>
 135                                 </listitem>
 136                         </varlistentry>
 137                 </variablelist>
 138         </refsect1>
 139
 140         <refsect1>
 141                 <title>See Also</title>
 142
 143                 <para>
 144                         <citerefentry>
 145                                 <refentrytitle>network</refentrytitle>
 146                                 <manvolnum>8</manvolnum>
 147                         </citerefentry>
 148                 </para>
 149         </refsect1>
 150 </refentry>