[OpenAFS-Doc] small manpage updates

Russ Allbery rra@stanford.edu
Mon, 11 Jun 2007 20:48:32 -0700


Lars Wilke <lw@lwilke.de> writes:

> +    S<<< [B<-readonly> <I<read only fileserver>>] >>>
>      S<<< [B<-hr> <I<number of hours between refreshing the host cps>>] >>>
>      [B<-busyat> <I<< redirect clients when queue > n >>>]
> +    S<<< [B<-nobusy> <I<no VBUSY before a volume is attached>>] >>>
>      S<<< [B<-rxpck> <I<number of rx extra packets>>] >>>
> -    [B<-rxdbg>] [B<-rxdbge>] S<<< [B<-m> <I<min percentage spare in partition>>] >>>
> +    S<<< [B<-rxdbg> <I<enable rx debugging>>] >>>
> +    S<<< [B<-rxdbge> <I<enable rx event debugging>>] >>>
> +    S<<< [B<-rxmaxmtu> <I<bytes>>] >>>
> +    S<<< [B<-rxbind> <I<bind the Rx socket to one address>>] >>>
> +    S<<< [B<-vattachpar> <I<number of volume attach threads>>] >>>
> +    S<<< [B<-m> <I<min percentage spare in partition>>] >>>
>      [B<-lock>] [B<-L>] [B<-S>] S<<< [B<-k> <I<stack size>>] >>>
>      S<<< [B<-realm> <I<Kerberos realm name>>] >>>
>      S<<< [B<-udpsize> <I<size of socket buffer in bytes>>] >>>
> +    S<<< [B<-sendsize> <I<size of send buffer in bytes>>] >>>
> +    S<<< [B<-abortthreshold> <I<abort threshold>>] >>>
>      [B<-enable_peer_stats>] [B<-enable_process_stats>] [B<-help>]

In a few places here, you misunderstood the format of the synopsis section
of the man page.  Unless an argument takes an argument, you shouldn't list
an argument there.  The <> bits in the rendered page are arguments, not
general descriptions of the argument.  For example, the change here to
-rxdbg is incorrect.

Applied with some modifications.

-- 
Russ Allbery (rra@stanford.edu)             <http://www.eyrie.org/~eagle/>