conf/62772: static_routes needs an example in /etc/defaults/rc.conf

[Alain Hoang]

>Number:         62772
>Category:       conf
>Synopsis:       static_routes needs an example in /etc/defaults/rc.conf
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-bugs
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Feb 12 23:20:16 PST 2004
>Closed-Date:
>Last-Modified:
>Originator:     Alain Hoang
>Release:        FreeBSD 5.2.1-RC i386
>Organization:
Doctor M
>Environment:
FreeBSD worcester.kannai.doctorm.jp 5.2.1-RC FreeBSD 5.2.1-RC #0: Sat Jan 31 05:36:22 GMT 2004 root at cypress.btc.adpatec.com:/usr/obj/usr/src/sys/GENERIC i386
>Description:
The documentation for static_routes in /etc/rc.conf is extremely unfriendly to someone
without a background in how the system is supposed to work.   There is no examples
in /etc/defaults/rc.conf that can be used by a newbie to figure out this works
without actually looking at /etc/rc.d/networking and noticing how static_routes
actually works.
>How-To-Repeat:
Find someone who has never configured a static route under FreeBSD and ask them
to figure out how to configure a static route using the /etc/rc.conf manpage and
/etc/defaults/rc.conf file and the Handbook only.
>Fix:
An example in /etc/defaults/rc.conf showing the usage would greatly benefit clarifying
how to setup a static route.

Example snippet:
# Static routes is a list of strings seperated by a space
# Each of these strings will point to a another
# configuration directive labeled route_...
# The following example shows an example of two
# static routes being configured.  They are labeled
# net1 and net2 and point to configuration directives
# route_net1 and route_net2 respectively.
static_routes="net1 net2"
route_net1="-net 192.168.0.0 192.168.0.1"
route_net2="-net 192.168.1.0 192.168.1.1"
>Release-Note:
>Audit-Trail:
>Unformatted: