On Fri, Mar 02, 2018 at 12:07:24PM +0100, Landry Breuil wrote:
> Hi,
>
> crude attempt at documenting -n in netstart, the wording can probably be
> improved.
>
> Landry
>
> Index: netstart.8
> ===================================================================
> RCS file: /cvs/src/share/man/man8/netstart.8,v
> retrieving revision 1.21
> diff -u -r1.21 netstart.8
> --- netstart.8 5 Sep 2016 12:58:17 -0000 1.21
> +++ netstart.8 2 Mar 2018 11:05:24 -0000
> @@ -33,6 +33,7 @@
> .Nd command script for network startup
> .Sh SYNOPSIS
> .Nm /etc/netstart
> +.Op Fl n
> .Op Ar interface ...
> .Sh DESCRIPTION
> .Nm
> @@ -49,6 +50,17 @@
> extent by variables defined in
> .Xr rc.conf 8 ,
> which specifies which daemons and services are to be run.
> +.Pp
> +If
> +option
> +.Fl n
> +is used
> +.Po
> +along an interface argument
> +.Pc ,
> +.Nm
> +will print the commands that it would run to configure the given
> +interface.
> .Pp
> During the system boot,
> .Nm
>
morning.
- i think -n should be grouped with "interface"
- i would document it further down, after the page has finished
explaining what happens if arguments are given to netstart
i nicked the wording somewhat from fw_update(8) and changed USAGE->usage
while at it.
so sth like:
Index: etc/netstart
===================================================================
RCS file: /cvs/src/etc/netstart,v
retrieving revision 1.195
diff -u -r1.195 netstart
--- etc/netstart 21 Feb 2018 19:57:21 -0000 1.195
+++ etc/netstart 2 Mar 2018 12:57:53 -0000
@@ -200,7 +200,7 @@
_rc_parse_conf
PRINT_ONLY=false
-USAGE="USAGE: ${0##*/} [-n] [interface ...]"
+USAGE="usage: ${0##*/} [[-n] interface ...]"
V4_DHCPCONF=false
V6_AUTOCONF=false
Index: share/man/man8/netstart.8
===================================================================
RCS file: /cvs/src/share/man/man8/netstart.8,v
retrieving revision 1.21
diff -u -r1.21 netstart.8
--- share/man/man8/netstart.8 5 Sep 2016 12:58:17 -0000 1.21
+++ share/man/man8/netstart.8 2 Mar 2018 12:57:53 -0000
@@ -33,7 +33,7 @@
.Nd command script for network startup
.Sh SYNOPSIS
.Nm /etc/netstart
-.Op Ar interface ...
+.Op Oo Fl n Oc Ar interface ...
.Sh DESCRIPTION
.Nm
is the command script that is invoked by
@@ -93,6 +93,11 @@
is the interface or bridge name:
.Pp
.D1 # sh /etc/netstart foo0
+.Pp
+Using the
+.Fl n
+option reports the steps that would be taken,
+without actually configuring the interface.
.Sh MULTICAST ROUTING
To enable
.Xr multicast 4
