Hi Brian and Alan,

Updated man page according to your comments.

Thanks,
-Simon

Brian Cameron wrote:
>
> Simon:
>
>> Because man pages in GPM tarball are in Debian system format, I update
>> them for Solaris. Attach man page for 3 applications.
>>
>> Please review or comment. 
>
> - I think the DESCRIPTION could explain more about what each program
>   does.  A description like "gnome-power-statistics is the gui
>   program for the gnome power management infrastructure." just doesn't
>   tell me much about this program.  Likewise the description for
>   gnome-power-preferences doesn't tell me much about what preferences
>   I can change.
>
> - Are there other power manager related kernel programs that should
>   be mentioned in SEE ALSO?
>
> One thing I notice about these manpages is that your <variablelist> are
> not making good use of the termlength element.  Note this:
>
> ---
>
>      --help                          Show summary of options.
>
>      --verbose                       Show extra debugging.
>
>      --no-daemon                     Do not  detach  gnome-power-
>                                      manager  into the background
>                                      so that error messages  will
>                                      be displayed on console.
>
>      --debug                         Only show specific debugging
>                                      options. Useful for develop-
>                                      ers only.
>
> ---
>
> The spacing is a little ugly because there is a lot of white
> space between the arguments and the explanation.  Note that in
> the variablelist tag, you can specify the termlength element
> to control the spacing,  Try some of these:
>
>    <variablelist termlength="wide">
>    <variablelist termlength="narrow">
>    <variablelist termlength="xtranarrow">
>    <variablelist termlength="medium">
>    <variablelist termlength="xtranarrow">
>    <variablelist termlength="fullscreen">
>
> See which looks best.  I think the FILES sections are using an
> especially bad termlength value.
>
> I also agree with Alan that there is no need for two trivial examples.
> Just have one trivial example.

-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: gnome-power-manager.1.txt
URL: 
<http://mail.opensolaris.org/pipermail/docs-discuss/attachments/20080219/5ac73da0/attachment.txt>
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: gnome-power-preferences.1.txt
URL: 
<http://mail.opensolaris.org/pipermail/docs-discuss/attachments/20080219/5ac73da0/attachment-0001.txt>
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: gnome-power-statistics.1.txt
URL: 
<http://mail.opensolaris.org/pipermail/docs-discuss/attachments/20080219/5ac73da0/attachment-0002.txt>

Reply via email to