docs/92653: document carp in ifconfig.8 (patch provided)

[Jeremy C. Reed]

>Number:         92653
>Category:       docs
>Synopsis:       document carp in ifconfig.8 (patch provided)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          sw-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Feb 01 01:00:13 GMT 2006
>Closed-Date:
>Last-Modified:
>Originator:     Jeremy C. Reed
>Release:        
>Organization:
Puget Sound Technology
>Environment:
>Description:
ifconfig(8) does not document carp(4) arguments.
The following patch will also help with PR docs/81776.
>How-To-Repeat:
              man ifconfig
>Fix:
Please review and commit the following. This is very brief. More details
should be added to carp.4.

--- /archive/FreeBSD-current/src/sbin/ifconfig/ifconfig.8	2005-12-27 05:03:43.000000000 -0800
+++ ifconfig.8	2006-01-31 16:46:51.000000000 -0800
@@ -1289,6 +1289,30 @@
 argument is useless and hence deprecated.
 .El
 .Pp
+The following parameters are specific to
+.Xr carp 4
+interfaces:
+.Bl -tag -width indent
+.It Cm advbase Ar seconds
+Specifies the base of the advertisement interval in seconds.
+The acceptable values are 1 to 255.
+The default value is 1.
+.\" The default value is CARP_DFLTINTV.
+.It Cm advskew Ar interval
+Specifies the skew to add to the base advertisement interval to
+make one host advertise slower than another host.
+It is specified in 1/256 of seconds.
+The acceptable values are 1 to 254.
+The default value is 0.
+.It Cm pass Ar phrase
+Set the authentication key to
+.Ar phrase .
+.It Cm vhid Ar n
+Set the virtual host ID.
+This is a required setting.
+Acceptable values are 1 to 255.
+.El
+.Pp
 The
 .Nm
 utility displays the current configuration for a network interface

>Release-Note:
>Audit-Trail:
>Unformatted: