Hi,
The question about the default options in the man pages' synopses is resolved:
We should change the man pages to conform to regular man page style, namely:
- Reserve <replaceable> in synopses for placeholders.
- Replace all deafult values in synopses with placeholders.
- State the default in the description.
Please let me know if you have any questions.
Regards,
-Paul
-------- Original Message --------
Subject: Re: Question about displaying defualt option values in usage-text
Date: Wed, 18 Apr 2007 15:43:08 -0700
From: Jane Young <Jane.Young_at_Sun.COM>
To: Don Cragun <don.cragun_at_sun.com>
CC: cli-guidelines_at_sun.com, Paul-Martin.Davies_at_Sun.COM
References: <200704182139.l3ILdaGV002879_at_spartan.SFBay.Sun.COM>
Don,
Thanks for the prompt response.
We'll need to change the usage-text/synopsis in AppServer's CLI.
Jane
Hi Don,
Thanks for your reqponse
Don Cragun wrote:
>Hi Jane,
> Default value information is usually included as part of the
>description of the option in the OPTIONS section of the man page; not
>in the SYNOPSIS section. Short help message
> If I remember correctly, Usage messages should pretty much
>match SYNOPSIS sections from the man page. More extensive Help
>messages could also include default values for unspecified options as
>part of the description of how to use subcommand options. From the
>CLIP spec, you should provide usage messages for commands of the form:
> command_name --help
> or command_name -'?'
>and more extensive Help message for commands of the form:
> command_name subcommand --help
> or command_name subcommand -'?'
>
> Cheers,
> Don
>
>
>
>>Date: Tue, 17 Apr 2007 01:02:58 -0700
>>From: Jane Young <Jane.Young_at_sun.com>
>>
>>Hi CLIP Experts,
>>
>>Shoud default option values be displayed in the usage-text or manpage
>>synopsis?
>>In AppServer CLI, the usage text displays the default value for port
>>option; eg [--port 4848].
>>For options that do not have default values, an option variable is
>>given; eg. [--user admin_user] where admin_user is the variable.
>>
>>I want to know what is the correct convention in displaying the option
>>values in the usage-text. CLIP Specificataion
>><http://sac.eng.sun.com/Archives/CaseLog/arc/PSARC/1999/645/really.committed.ma
>>
>>
>terials/clip.pdf>
>
>
>>is not very clear on this.
>>
>>Thanks,
>>Jane
>>
>>
>
>
>
--
Paul Davies, Senior Technical Writer, Sun Microsystems, Inc.
http://blogs.sun.com/techscribe/