[OpenAFS-Doc] small manpage updates

[Lars Wilke]

Hi,

i just added a few missing arguments, which are visible via -help,
to the pod8/fileserver.pod file. I am going to check the other libexec
stuff, too, as time permits. I also did take a look into the src file
src/viced/viced.c, and found a few more arguments, i.e. -syslog and
-saneacls, with which i do not know what to do. Are the args not listed
on purpose or are these just forgotten and should they be added to the
pod file?

Another patch is to the help output from fs, which IMHO makes it more
clear what type of server is meant in setserverprefs.

Any comment is welcome, thanks

--lars

[Russ Allbery]

i just added a few missing arguments, which are visible via -help, to
the pod8/fileserver.pod file. I am going to check the other libexec
stuff, too, as time permits. I also did take a look into the src file
src/viced/viced.c, and found a few more arguments, i.e. -syslog and
-saneacls, with which i do not know what to do. Are the args not listed
on purpose or are these just forgotten and should they be added to the
pod file?

There are no arguments left unlisted on purpose as far as I'm concerned.
We should document everything, even if we include "NEVER USE THIS"
comments in the documentation for things end users shouldn't be using.

Another patch is to the help output from fs, which IMHO makes it more
clear what type of server is meant in setserverprefs.
Any comment is welcome, thanks

Thank you for the patches! I'll try to get these reviewed and committed
very soon.

[Russ Allbery]

Post by Lars Wilke
Another patch is to the help output from fs, which IMHO makes it more
clear what type of server is meant in setserverprefs.

I think this patch is incorrect (someone may have already mentioned this).
fs setserverprefs can set the preferences for either type of server,
depending on its arguments.

[Russ Allbery]

+ 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.

[Lars Wilke]

Post by Russ Allbery
Applied with some modifications.

Ok thanks!

--lars