Sat, 24 Sep 2016 12:12:03 +1000 Jonathan Gray <j...@jsg.id.au>
> Sync the option list with reality.  Don't document the internal
> -I and -P options that set the instance number and title on
> purpose.

Hi Jonathan,

I think undocumented and/or intentionally non synchronised options
contradicts with the idea of "correct option" definition anywhere.

Kind regards,
Anton

> Index: switchd.8
> ===================================================================
> RCS file: /cvs/src/usr.sbin/switchd/switchd.8,v
> retrieving revision 1.1
> diff -u -p -r1.1 switchd.8
> --- switchd.8 19 Jul 2016 16:54:26 -0000      1.1
> +++ switchd.8 16 Sep 2016 11:01:27 -0000
> @@ -22,13 +22,52 @@
>  .Nd software-defined networking (SDN) sflow controller
>  .Sh SYNOPSIS
>  .Nm switchd
> -.Op Fl 6dnSTtv
> +.Op Fl dnv
> +.Op Fl c Ar cachesize
>  .Op Fl D Ar macro Ns = Ns Ar value
>  .Op Fl f Ar file
> +.Op Fl t Ar timeout
>  .Sh DESCRIPTION
>  .Nm
>  is an controller for software-defined networking (SDN) and is
>  compatible with the OpenFlow protocol.
> +.Pp
> +The options are as follows:
> +.Bl -tag -width Dssmacro=value
> +.It Fl D Ar macro Ns = Ns Ar value
> +Set a
> +.Ar macro
> +to a
> +.Ar value .
> +Macros can be referenced in the configuration files.
> +.It Fl c Ar cachesize
> +Number of MAC addresses to cache.
> +The default is 4096.
> +.It Fl d
> +Debug mode.
> +Don't detach or become a daemon.
> +This allows for easy monitoring of
> +.Nm .
> +.It Fl f Ar file
> +Specifies the configuration file.
> +The default is
> +.Pa /etc/switchd.conf .
> +.It Fl n
> +Check that the configuration is valid, but don't start the daemon.
> +.It Fl t Ar timeout
> +Timeout in seconds for learned MAC addresses.
> +The default is 240 seconds.
> +.It Fl v
> +Verbose mode.
> +Multiple
> +.Fl v
> +options increase the verbosity.
> +.El
> +.Sh FILES
> +.Bl -tag -width "/etc/switchd.conf" -compact
> +.It Pa /etc/switchd.conf
> +Default configuration file.
> +.El
>  .Sh STANDARDS
>  .Rs
>  .%A Open Networking Foundation (ONF)
> 

Reply via email to