[OpenAFS-Doc] new man page: vos_changeaddr

Jason Edgecombe jason@rampaginggeek.com
Fri, 17 Aug 2007 22:42:41 -0400


Russ Allbery wrote:
> Jason Edgecombe <jason@rampaginggeek.com> writes:
>
>   
>> new man page: vos changeloc.pod
>> a small diff against the latest cvs.
>>     
>
> Whoops, thanks for the catch.  I was sorting things and missed that.
>
> Applied with a few changes.  In the SYNOPSIS section:
>
>   
>> B<vos changeloc> S<<< [B<-server>] <I<new server name>> >>>
>>    S<<< [B<-partition>] <I<new partition location>> >>>
>>    S<<< [B<-id>] <I<volume name or ID>> >>>
>>    S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>] [B<-localauth>]
>>    [B<-verbose>] [B<-encrypt>] [B<-help>]
>>     
>
> [] mark optional arguments.  In this case, -server, -partition, and -id
> aren't optional, so they shouldn't be in []s.  Also, when a flag is
> optional, generally its argument is as well, so the []s should enclose the
> whole thing.  For example, [B<-cell> <I<cell name>>] rather than
> [B<-cell>] <I<cell name>>.
>
> The SYNOPSIS should generally be identical to the help output but with the
> POD markup added.
>
>   
ok. I was putting brackets around the -server and other options because 
the "-server" is optional, but the server name is  not.

Jason