batman-adv: Add documentation.

[people/ms/network.git] / man / network.8.in

.TH network 8 "31 May 2012" "@VERSION@" "network man page"

.SH NAME
network \- Network Configuration Control Program

.SH SYNOPSIS
\fBnetwork [--debug|-d] command\fR

.SH DESCRIPTION
The network command is a tool which configures the network on every IPFire
system. It is a fast and versatile way to create, edit and remove
configurations, review the status of the network and it is working in the
background of the system making sure that things are running smoothly.
.PP

.SH OPTIONS
\fB\-\-debug\fR
(short \fB\-d\fR)
.RS 4
The \fB\-\-debug\fR switch enabled the debugging mode. In this mode, there
will be debug output in the console and written to the log files.
.PP
The debugging mode can be permanently enabled by running
\fBnetwork config DEBUG=1\fR.
.RE
.PP

The \fBnetwork\fR command offers various commands:

\fBstart [zone-name ...]\fR
.RS 4
The \fBstart\fR command starts a zone. That means the network zone will be created
and brought up.
If one or more names of zones are passed to the command, only those will be started.
.PP
The startup of the zones itself is dispatches to \fBsystemd\fR(8).
.RE
.PP

\fBstop [zone-name ...]\fR
.RS 4
The \fBstop\fR command stops a zone. This is the inverse of the \fBstart\fR command.
.RE
.PP

\fBrestart [zone-name ...]\fR
.RS 4
The \fBrestart\fR command will stop and start all given zones or all.
.RE
.PP

\fBstatus [zone-name ...]\fR
.RS 4
The \fBstatus\fR command will show a human-readable overview of the status of the
network zones.
.RE
.PP

\fBzone ...\fR
.RS 4
The \fBzone\fR command is the most used command. It can configure zones.
Read more about that in \fBnetwork-zone\fR(8).
.RE
.PP

\fBport ...\fR
.RS 4
The \fBport\fR command is used to create, remove and configure ports.
Read more about that in \fBnetwork-port\fR(8).
.RE
.PP

\fBdevice ...\fR
.RS 4
The \fBdevice\fR command is used to read status information about
devices. Detailed information is to be found in \fBnetwork-device\fR(8).
.RE
.PP

\fBconfig [KEY=VALUE ...]\fR
.RS 4
The \fBconfig\fR command will return you are list of the global configuration
parameters of the network command.
.PP
You may set them by appending a new setting to the command line.
.RE
.PP

\fBhelp [<type> <hook>]\fR
.RS 4
Running "network help" without any arguments will show you this man page.
.PP
You may optionally give two arguments, to view the help of a certain hook.
The type of the hook (\fB<type>\fR) needs to be passed as well as the
name of the hook (\fB<hook>\fR).
.RE
.PP

\fBhostname [new-hostname]\fR
.RS 4
The \fBhostname\fR command will return the currently configured hostname of the system.
.PP
If a new hostname is added to the command line, it will be configured, but will be set
after the next reboot.
.RE
.PP

\fBdns-server ...\fR
.RS 4
The \fBdns-server\fR command will help you configuring the local DNS servers.
.RE
.PP

\fBreset\fR
.RS 4
The \fBreset\fR command will reset all network configuration. That means all zone configurations
will be removed and there will be no networking at the next reboot.
.RE
.PP

.SH EXIT CODES
The \fBnetwork\fR command will normally exit with code 0. If there has been a problem
and the requested action could not be done, the exit code is unequal to zero.

.SH BUGS
Please report all bugs to the official bugtracker at http://bugs.ipfire.org/.

.SH SEE ALSO
network-config(8),
network-device(8),
network-dns-server(8),
network-port(8),
network-zone(8)

.SH AUTHOR
Michael Tremer (michael.tremer@ipfire.org)