summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormiod <miod@openbsd.org>2002-02-21 02:36:09 +0000
committermiod <miod@openbsd.org>2002-02-21 02:36:09 +0000
commit313075d76c6be1fd17bc8b1c7364d3d3aabbf582 (patch)
treed9d41397abeb20a3b5879def1ac26130f5795339
parentChange the network components initialization order. (diff)
downloadwireguard-openbsd-313075d76c6be1fd17bc8b1c7364d3d3aabbf582.tar.xz
wireguard-openbsd-313075d76c6be1fd17bc8b1c7364d3d3aabbf582.zip
With the recent changes to /etc/netstart, split the part of rc.8 covering
it into a full-blown manual page, and document the new behaviour, in particular, what I forgot to add in the previous commit message. Add more Xrefs to network-related configuration files in netstart.8. There is still room for improvement: multicast routing ought to be documented in netstart.8 now, and afterboot.8 modified accordingly. ok chris@
-rw-r--r--share/man/man8/Makefile6
-rw-r--r--share/man/man8/netstart.8101
-rw-r--r--share/man/man8/rc.89
3 files changed, 107 insertions, 9 deletions
diff --git a/share/man/man8/Makefile b/share/man/man8/Makefile
index cf01a5a8534..88eedac9758 100644
--- a/share/man/man8/Makefile
+++ b/share/man/man8/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.36 2001/10/04 23:42:20 miod Exp $
+# $OpenBSD: Makefile,v 1.37 2002/02/21 02:36:09 miod Exp $
# $NetBSD: Makefile,v 1.13 1996/03/28 21:36:40 mark Exp $
# @(#)Makefile 8.1 (Berkeley) 6/5/93
@@ -6,13 +6,13 @@ MAN= afterboot.8 compat_bsdos.8 compat_freebsd.8 compat_ibcs2.8 \
compat_linux.8 compat_sunos.8 compat_svr4.8 compat_ultrix.8 crash.8 \
dhcp.8 diskless.8 intro.8 rc.8 rc.conf.8 rc.shutdown.8 ssl.8 \
starttls.8 sticky.8 update.8 yp.8 boot_config.8 vpn.8 release.8 \
- security.8 genassym.sh.8
+ security.8 genassym.sh.8 netstart.8
SUBDIR= man8.alpha man8.amiga man8.hp300 man8.i386 man8.mac68k man8.mvme68k \
man8.macppc man8.sparc man8.sparc64 man8.sun3 man8.vax
MLINKS= afterboot.8 faq.8 \
boot_config.8 UKC.8 \
- rc.8 rc.local.8 rc.8 rc.securelevel.8 rc.8 netstart.8 \
+ rc.8 rc.local.8 rc.8 rc.securelevel.8 \
rc.conf.8 rc.conf.local.8
.include <bsd.prog.mk>
diff --git a/share/man/man8/netstart.8 b/share/man/man8/netstart.8
new file mode 100644
index 00000000000..a5a31c47b23
--- /dev/null
+++ b/share/man/man8/netstart.8
@@ -0,0 +1,101 @@
+.\" $OpenBSD: netstart.8,v 1.1 2002/02/21 02:36:09 miod Exp $
+.\"
+.\" Copyright (c) 2002, Miodrag Vallat.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. The name of the author may not be used to endorse or promote products
+.\" derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.\" @(#)rc.8 8.2 (Berkeley) 12/11/93
+.\"
+.Dd February 20, 2002
+.Dt NETSTART 8
+.Os
+.Sh NAME
+.Nm netstart
+.Nd command scripts for network startup
+.Sh SYNOPSIS
+.Nm /etc/netstart
+.Op interface ...
+.Sh DESCRIPTION
+.Nm netstart
+is the command script that is invoked by
+.Xr rc 8
+during an automatic reboot and after single user mode is exited;
+it performs network initialization.
+.Pp
+The
+.Nm netstart
+script can also be used to start newly-created bridges or interfaces,
+or reset existing interfaces to their default state.
+The behaviour of this script is (or can be) controlled to some
+extent by variables defined in
+.Nm rc.conf ,
+which specifies which daemons and services are to be run.
+.Pp
+During the system boot,
+.Nm
+is executed.
+.Nm netstart
+will perform the following operations:
+.Bl -bullet -compact
+.It
+Set the machine's name.
+.It
+Configure the loopback interface.
+.It
+Configure all the physical interfaces.
+.It
+Initialize the routing table and setup the default routes.
+.It
+Configure all the
+.Xr gif 4
+and
+.Xr gre 4
+interfaces.
+.It
+Configure all the bridges.
+.El
+.Pp
+After the system is completely initialized, it is possible to start a
+newly-created interface or
+.Xr bridge 4 ,
+or reset an existing interface to its default state, by invoking
+.Bd -literal -compact
+sh /etc/netstart foo0
+.Ed
+where
+.Ar foo0
+is the interface or bridge name.
+.Sh SEE ALSO
+.Xr bridge 4 ,
+.Xr bridgename.if 5 ,
+.Xr gif 4 ,
+.Xr gre 4 ,
+.Xr hostname.if 5 ,
+.Xr rc.conf 8 ,
+.Xr rc 8
+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.0 .
diff --git a/share/man/man8/rc.8 b/share/man/man8/rc.8
index 73e7a33be8b..bb8cab801fd 100644
--- a/share/man/man8/rc.8
+++ b/share/man/man8/rc.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: rc.8,v 1.18 2001/12/28 16:21:04 millert Exp $
+.\" $OpenBSD: rc.8,v 1.19 2002/02/21 02:36:09 miod Exp $
.\"
.\" Copyright (c) 1980, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -114,12 +114,8 @@ generated as a result of a system crash, with
Before
.Nm rc
starts most system daemons,
-.Nm netstart
+.Xr netstart 8
is executed.
-.Nm netstart
-defines the machine's name, configures various network interfaces
-and system features, initializes the routing table, and numerous
-other tasks.
.Pp
.Nm rc.securelevel
is executed by
@@ -193,6 +189,7 @@ login class as described in
.Xr login.conf 5 ,
.Xr sysctl.conf 5 ,
.Xr init 8 ,
+.Xr netstart 8 ,
.Xr rc.conf 8 ,
.Xr rc.shutdown 8 ,
.Xr reboot 8 ,