From 94eab7549f05ea4ef09276f49edf8550e8d00f29 Mon Sep 17 00:00:00 2001 From: Michael Tremer Date: Sun, 1 Nov 2015 01:12:51 +0100 Subject: [PATCH] man: Add a quick start guide Signed-off-by: Michael Tremer --- Makefile.am | 1 + man/network-quick-start.xml | 155 ++++++++++++++++++++++++++++++++++++ man/network.xml | 4 + 3 files changed, 160 insertions(+) create mode 100644 man/network-quick-start.xml diff --git a/Makefile.am b/Makefile.am index bd81906a..19f8e0c3 100644 --- a/Makefile.am +++ b/Makefile.am @@ -335,6 +335,7 @@ MANPAGES = \ man/network-dns-server.8 \ man/network-port-batman-adv.8 \ man/network-port-batman-adv-port.8 \ + man/network-quick-start.8 \ man/network-route.8 \ man/network-settings.8 \ man/network-zone.8 \ diff --git a/man/network-quick-start.xml b/man/network-quick-start.xml new file mode 100644 index 00000000..ea79700f --- /dev/null +++ b/man/network-quick-start.xml @@ -0,0 +1,155 @@ + + + + + + network-quick-start + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-quick-start + 8 + + + + network-quick-start + Network Configuration Control Program + + + + Quick Start Guide + + + The network is a very powerful command that allows + you to configure the entire networking stack. Unfortunately that makes + it quite complicated to use as well. + This guide tries to be a good starting point to set up basic networking + with the network command. + + + + + Add an uplink zone + + + The first step is to create a new uplink zone with name + upl0. + This zone will be of the bridge type which is + the default for all local networks. + + + # network zone new upl0 bridge + + + The zone will be created and brought up immediately. + + + + + Attaching ports + + + To connect the zone to the physical world outside of our box we will need + to attach ports to the zone. + That is done with a single command. + To execute this command, we will need to know which ports are available. + One of the easiest way to find out about that is to use the auto-completion + feature of the shell like this: + + + # network zone upl0 port attach [TAB] [TAB] + + + That will list all not yet attached ports. + The following command will actually attach the port + (which is p0 in this example). + + + # network zone upl0 port attach p0 + + + You can as well get a list of all detected devices, + zones and ports by running: + + + # network device list + + + To a zone of the bridge type you may attach more + than just one port if you wish so. + + + + + IP connectivity + + + After a zone has been created and ports have been attached, you are now + able to add IP connectivity. + The easiest way to do that is using DHCP which can be enabled by this + simple command: + + + # network zone upl0 config new ipv6-dhcp + + + And for IPv4: + + + # network zone upl0 config new ipv4-dhcp + + + + Debugging + + + You may see the current status of the network by running this command: + + + # network status + + + The entire network can be restarted by running: + + + # network restart + + + + See Also + + + + network + 8 + , + + network-config + 8 + , + + network-device + 8 + , + + network-port + 8 + , + + network-zone + 8 + + + + diff --git a/man/network.xml b/man/network.xml index aee5057b..90ab27cf 100644 --- a/man/network.xml +++ b/man/network.xml @@ -330,6 +330,10 @@ network-port 8 , + + network-quick-start + 8 + , network-zone 8 -- 2.39.2