man/network.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">
   6         <refentryinfo>
   7                 <title>network</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</refentrytitle>
  22                 <manvolnum>8</manvolnum>
  23         </refmeta>
  24
  25         <refnamediv>
  26                 <refname>network</refname>
  27                 <refpurpose>Network Configuration Control Program</refpurpose>
  28         </refnamediv>
  29
  30         <refsynopsisdiv>
  31                 <cmdsynopsis>
  32                         <command>network</command>
  33                         <arg choice="opt" rep="repeat">OPTIONS</arg>
  34                         <arg choice="plain">COMMAND</arg>
  35                 </cmdsynopsis>
  36         </refsynopsisdiv>
  37
  38         <refsect1>
  39                 <title>Description</title>
  40
  41                 <para>
  42                         The <command>network</command> command is a tool which configures
  43                         the network on every IPFire system. It is a fast and versatile
  44                         way to create, edit and remove configurations, review the status
  45                         of the network and it is working in the background of the system
  46                         making sure that things are running smoothly.
  47                 </para>
  48         </refsect1>
  49
  50         <refsect1>
  51                 <title>Options</title>
  52
  53                 <para>
  54                         The following options are understood:
  55                 </para>
  56
  57                 <variablelist>
  58                         <varlistentry>
  59                                 <term>
  60                                         <option>-d</option>
  61                                 </term>
  62                                 <term>
  63                                         <option>--debug</option>
  64                                 </term>
  65
  66                                 <listitem>
  67                                         <para>
  68                                                 Enables the debugging mode.
  69                                                 In this mode, there will be debug output on
  70                                                 the console and written to the log.
  71                                         </para>
  72                                         <para>
  73                                                 The debugging mode can be permanently enabled by setting
  74                                                 <varname>DEBUG=1</varname>
  75                                         </para>
  76                                 </listitem>
  77                         </varlistentry>
  78                 </variablelist>
  79         </refsect1>
  80
  81         <refsect1>
  82                 <title>Commands</title>
  83
  84                 <para>
  85                         The following commands are understood:
  86                 </para>
  87
  88                 <variablelist>
  89                         <varlistentry>
  90                                 <term>
  91                                         <command>start <replaceable>ZONE-NAME</replaceable>...</command>
  92                                 </term>
  93
  94                                 <listitem>
  95                                         <para>
  96                                                 Starts a zone. That means the network zone will be created
  97                                                 and brought up.
  98                                                 If one or more zone names are passed to the command, only
  99                                                 these will be started.
 100                                         </para>
 101                                 </listitem>
 102                         </varlistentry>
 103
 104                         <varlistentry>
 105                                 <term>
 106                                         <command>stop <replaceable>ZONE-NAME</replaceable>...</command>
 107                                 </term>
 108
 109                                 <listitem>
 110                                         <para>
 111                                                 Stops a zone. This is the inverse of the <command>start</command>
 112                                                 command.
 113                                         </para>
 114                                 </listitem>
 115                         </varlistentry>
 116
 117                         <varlistentry>
 118                                 <term>
 119                                         <command>restart <replaceable>ZONE-NAME</replaceable>...</command>
 120                                 </term>
 121
 122                                 <listitem>
 123                                         <para>
 124                                                 Restarts a zone.
 125                                         </para>
 126                                 </listitem>
 127                         </varlistentry>
 128
 129                         <varlistentry>
 130                                 <term>
 131                                         <command>status <replaceable>ZONE-NAME</replaceable>...</command>
 132                                 </term>
 133
 134                                 <listitem>
 135                                         <para>
 136                                                 Shows a human-readable overview of the status
 137                                                 of the network zone.
 138                                         </para>
 139                                 </listitem>
 140                         </varlistentry>
 141
 142                         <varlistentry>
 143                                 <term>
 144                                         <command>zone ...</command>
 145                                 </term>
 146
 147                                 <listitem>
 148                                         <para>
 149                                                 Configure a zone or show status information.
 150                                                 See <citerefentry>
 151                                                         <refentrytitle>network-zone</refentrytitle>
 152                                                         <manvolnum>8</manvolnum>
 153                                                 </citerefentry> for details.
 154                                         </para>
 155                                 </listitem>
 156                         </varlistentry>
 157
 158                         <varlistentry>
 159                                 <term>
 160                                         <command>port ...</command>
 161                                 </term>
 162
 163                                 <listitem>
 164                                         <para>
 165                                                 Configure a port or show status information.
 166                                                 See <citerefentry>
 167                                                         <refentrytitle>network-port</refentrytitle>
 168                                                         <manvolnum>8</manvolnum>
 169                                                 </citerefentry> for details.
 170                                         </para>
 171                                 </listitem>
 172                         </varlistentry>
 173
 174                         <varlistentry>
 175                                 <term>
 176                                         <command>device ...</command>
 177                                 </term>
 178
 179                                 <listitem>
 180                                         <para>
 181                                                 Show status information about network devices.
 182                                                 See <citerefentry>
 183                                                         <refentrytitle>network-device</refentrytitle>
 184                                                         <manvolnum>8</manvolnum>
 185                                                 </citerefentry> for details.
 186                                         </para>
 187                                 </listitem>
 188                         </varlistentry>
 189
 190                         <varlistentry>
 191                                 <term>
 192                                         <command>config <replaceable><varname>KEY=VALUE</varname></replaceable></command>
 193                                 </term>
 194
 195                                 <listitem>
 196                                         <para>
 197                                                 Shows and alters global configuration parameters.
 198                                                 See <citerefentry>
 199                                                         <refentrytitle>network-settings</refentrytitle>
 200                                                         <manvolnum>8</manvolnum>
 201                                                 </citerefentry> for details.
 202                                         </para>
 203                                 </listitem>
 204                         </varlistentry>
 205
 206                         <varlistentry>
 207                                 <term>
 208                                         <command>help [<replaceable>TYPE</replaceable>
 209                                                 <replaceable>HOOK</replaceable>|<replaceable>TYPE</replaceable> list-hooks]</command>
 210                                 </term>
 211
 212                                 <listitem>
 213                                         <para>
 214                                                 Calling <command>network help</command> without any
 215                                                 arguments will show you this man page.
 216                                         </para>
 217                                         <para>
 218                                                 <command>network help <replaceable>TYPE</replaceable> list-hooks</command>
 219                                                 will print a list of all hooks of <replaceable>TYPE</replaceable>.
 220                                         </para>
 221                                         <para>
 222                                                 You may optionally pass two arguments, to view the help
 223                                                 of a certain hook.
 224                                                 The type of the hook <replaceable>TYPE</replaceable>
 225                                                 needs to be passed as well as the name of the hook
 226                                                 <replaceable>HOOK</replaceable>.
 227                                         </para>
 228                                 </listitem>
 229                         </varlistentry>
 230
 231                         <varlistentry>
 232                                 <term>
 233                                         <command>hostname <replaceable>HOSTNAME</replaceable></command>
 234                                 </term>
 235
 236                                 <listitem>
 237                                         <para>
 238                                                 The <command>hostname</command> command will return the
 239                                                 currently configured hostname of the system.
 240                                         </para>
 241                                         <para>
 242                                                 If a new hostname is added to the command line,
 243                                                 it will be configured, but will be set after the next
 244                                                 reboot.
 245                                         </para>
 246                                 </listitem>
 247                         </varlistentry>
 248
 249                         <varlistentry>
 250                                 <term>
 251                                         <command>dns-server ...</command>
 252                                 </term>
 253
 254                                 <listitem>
 255                                         <para>
 256                                                 The <command>dns-server</command> command will help you
 257                                                 configuring the local DNS servers.
 258                                                 See <citerefentry>
 259                                                         <refentrytitle>network-dns-server</refentrytitle>
 260                                                         <manvolnum>8</manvolnum>
 261                                                 </citerefentry> for details.
 262                                         </para>
 263                                 </listitem>
 264                         </varlistentry>
 265
 266                         <varlistentry>
 267                                 <term>
 268                                         <command>route ...</command>
 269                                 </term>
 270
 271                                 <listitem>
 272                                         <para>
 273                                                 The <command>route</command> command allows managing static routes.
 274                                                 See <citerefentry>
 275                                                         <refentrytitle>network-route</refentrytitle>
 276                                                         <manvolnum>8</manvolnum>
 277                                                 </citerefentry> for details.
 278                                         </para>
 279                                 </listitem>
 280                         </varlistentry>
 281
 282                         <varlistentry>
 283                                 <term>
 284                                         <command>vpn ...</command>
 285                                 </term>
 286
 287                                 <listitem>
 288                                         <para>
 289                                                 The <command>vpn</command> allows managing VPN connections.
 290                                                 See <citerefentry>
 291                                                         <refentrytitle>network-vpn</refentrytitle>
 292                                                         <manvolnum>8</manvolnum>
 293                                                 </citerefentry> for details.
 294                                         </para>
 295                                 </listitem>
 296                         </varlistentry>
 297
 298                         <varlistentry>
 299                                 <term>
 300                                         <command>reset</command>
 301                                 </term>
 302
 303                                 <listitem>
 304                                         <para>
 305                                                 The <command>reset</command> command will reset all
 306                                                 network configuration. That means all zone configurations
 307                                                 will be removed and there will be no networking after the
 308                                                 next reboot.
 309                                         </para>
 310                                 </listitem>
 311                         </varlistentry>
 312                 </variablelist>
 313         </refsect1>
 314
 315         <refsect1>
 316                 <title>Exit Codes</title>
 317
 318                 <para>
 319                         The <command>network</command> command will normally exit with code 0.
 320                         If there has been a problem and the requested action could not be done,
 321                         the exit code is unequal to zero.
 322                 </para>
 323         </refsect1>
 324
 325         <refsect1>
 326                 <title>Bugs</title>
 327
 328                 <para>
 329                         Please report all bugs to the official bugtracker at
 330                         http://bugs.ipfire.org/.
 331                 </para>
 332         </refsect1>
 333
 334         <refsect1>
 335                 <title>See Also</title>
 336
 337                 <para>
 338                         <citerefentry>
 339                                 <refentrytitle>network-settings</refentrytitle>
 340                                 <manvolnum>8</manvolnum>
 341                         </citerefentry>,
 342                         <citerefentry>
 343                                 <refentrytitle>network-device</refentrytitle>
 344                                 <manvolnum>8</manvolnum>
 345                         </citerefentry>,
 346                         <citerefentry>
 347                                 <refentrytitle>network-dns-server</refentrytitle>
 348                                 <manvolnum>8</manvolnum>
 349                         </citerefentry>,
 350                         <citerefentry>
 351                                 <refentrytitle>network-performance-tuning</refentrytitle>
 352                                 <manvolnum>8</manvolnum>
 353                         </citerefentry>,
 354                         <citerefentry>
 355                                 <refentrytitle>network-port</refentrytitle>
 356                                 <manvolnum>8</manvolnum>
 357                         </citerefentry>,
 358                         <citerefentry>
 359                                 <refentrytitle>network-quick-start</refentrytitle>
 360                                 <manvolnum>8</manvolnum>
 361                         </citerefentry>,
 362                         <citerefentry>
 363                                 <refentrytitle>network-zone</refentrytitle>
 364                                 <manvolnum>8</manvolnum>
 365                         </citerefentry>
 366                 </para>
 367         </refsect1>
 368 </refentry>