man/network.8.in

   1 .TH network 8 "31 May 2012" "@VERSION@" "network man page"
   2
   3 .SH NAME
   4 network \- Network Configuration Control Program
   5
   6 .SH SYNOPSIS
   7 \fBnetwork [--debug|-d] command\fR
   8
   9 .SH DESCRIPTION
  10 The network command is a tool which configures the network on every IPFire
  11 system. It is a fast and versatile way to create, edit and remove
  12 configurations, review the status of the network and it is working in the
  13 background of the system making sure that things are running smoothly.
  14 .PP
  15
  16 .SH OPTIONS
  17 \fB\-\-debug\fR
  18 (short \fB\-d\fR)
  19 .RS 4
  20 The \fB\-\-debug\fR switch enabled the debugging mode. In this mode, there
  21 will be debug output in the console and written to the log files.
  22 .PP
  23 The debugging mode can be permanently enabled by running
  24 \fBnetwork config DEBUG=1\fR.
  25 .RE
  26 .PP
  27
  28 The \fBnetwork\fR command offers various commands:
  29
  30 \fBstart [zone-name ...]\fR
  31 .RS 4
  32 The \fBstart\fR command starts a zone. That means the network zone will be created
  33 and brought up.
  34 If one or more names of zones are passed to the command, only those will be started.
  35 .PP
  36 The startup of the zones itself is dispatches to \fBsystemd\fR(8).
  37 .RE
  38 .PP
  39
  40 \fBstop [zone-name ...]\fR
  41 .RS 4
  42 The \fBstop\fR command stops a zone. This is the inverse of the \fBstart\fR command.
  43 .RE
  44 .PP
  45
  46 \fBrestart [zone-name ...]\fR
  47 .RS 4
  48 The \fBrestart\fR command will stop and start all given zones or all.
  49 .RE
  50 .PP
  51
  52 \fBstatus [zone-name ...]\fR
  53 .RS 4
  54 The \fBstatus\fR command will show a human-readable overview of the status of the
  55 network zones.
  56 .RE
  57 .PP
  58
  59 \fBzone ...\fR
  60 .RS 4
  61 The \fBzone\fR command is the most used command. It can configure zones.
  62 Read more about that in \fBnetwork-zone\fR(8).
  63 .RE
  64 .PP
  65
  66 \fBport ...\fR
  67 .RS 4
  68 The \fBport\fR command is used to create, remove and configure ports.
  69 Read more about that in \fBnetwork-port\fR(8).
  70 .RE
  71 .PP
  72
  73 \fBdevice ...\fR
  74 .RS 4
  75 The \fBdevice\fR command is used to read status information about
  76 devices. Detailed information is to be found in \fBnetwork-device\fR(8).
  77 .RE
  78 .PP
  79
  80 \fBconfig [KEY=VALUE ...]\fR
  81 .RS 4
  82 The \fBconfig\fR command will return you are list of the global configuration
  83 parameters of the network command.
  84 .PP
  85 You may set them by appending a new setting to the command line.
  86 .RE
  87 .PP
  88
  89 \fBhelp [<type> <hook>]\fR
  90 .RS 4
  91 Running "network help" without any arguments will show you this man page.
  92 .PP
  93 You may optionally give two arguments, to view the help of a certain hook.
  94 The type of the hook (\fB<type>\fR) needs to be passed as well as the
  95 name of the hook (\fB<hook>\fR).
  96 .RE
  97 .PP
  98
  99 \fBhostname [new-hostname]\fR
 100 .RS 4
 101 The \fBhostname\fR command will return the currently configured hostname of the system.
 102 .PP
 103 If a new hostname is added to the command line, it will be configured, but will be set
 104 after the next reboot.
 105 .RE
 106 .PP
 107
 108 \fBdns-server ...\fR
 109 .RS 4
 110 The \fBdns-server\fR command will help you configuring the local DNS servers.
 111 .RE
 112 .PP
 113
 114 \fBreset\fR
 115 .RS 4
 116 The \fBreset\fR command will reset all network configuration. That means all zone configurations
 117 will be removed and there will be no networking at the next reboot.
 118 .RE
 119 .PP
 120
 121 .SH EXIT CODES
 122 The \fBnetwork\fR command will normally exit with code 0. If there has been a problem
 123 and the requested action could not be done, the exit code is unequal to zero.
 124
 125 .SH BUGS
 126 Please report all bugs to the official bugtracker at http://bugs.ipfire.org/.
 127
 128 .SH SEE ALSO
 129 network-config(8),
 130 network-device(8),
 131 network-dns-server(8),
 132 network-port(8),
 133 network-zone(8)
 134
 135 .SH AUTHOR
 136 Michael Tremer (michael.tremer@ipfire.org)