On Tue, 2009-11-10 at 18:06 -0600, Brian Cameron wrote:
> Jeff:
> 
> > I add 'attributes' section and the ARC comment based on the version of
> > the community.
> 
> seahorse-agent.1:
> 
>  >     seahorse-agent [ OPTION... ]
> 
> The Solaris manpage style guide suggests that the options be spelled
> out.  See other manpages for examples.
Fixed.
> 
>  >     This is the agent program for seahorse which  keeps  a  tem-
>  >     porary  secure  storage  of your pass phrases. It also works
>  >     with the SSH agent to prompt you for SSH passphrases.
> 
> It isn't clear what a "temporary secure storage of your pass phrases"
> really means.  It would be good to provide more detail.  What is
> meant by "keep".  Where is it stored, for example.

What I understand is to keep the passphrases in the secure memory for
temporary storage.
> 
>  >          Print variables in for a C type shell.
> 
> This is bad grammar.  I'd remove the word "in".  What variables are
> printed?
> 
>  >          Don't try to make sure requests only come  from  the  X
>  >          display on which seahorse-agent was started.
> 
> The Solaris manpage style guide suggests that you do not use 
> contractions (such as Don't or can't or won't) in manpages.
> I would say "Do not" instead of "Don't".
> 
> Also, "Do not try to make sure" is not very good English.  I would
> say "Do not make sure that requests..."

Ok.
> 
>  >           Display variables instead of editing gpg.conf.
> 
> What variables?
GPG_AGENT_INFO
> 
>  >  Additional options
>  >     In addition, the usual GTK+ and GNOME command  line  options
>  >     apply. See the output of --help for details.
> 
> All other GNOME manpages refer to "gnome-std-options" instead of
> providing the above.  I'd update to make this more similar to
> our other manpages.  Refer to "man totem" for an example.
> 
>  > SEE ALSO
>  >     seahorse-tool(1), seahorse-daemon(1)
> 
> I'd add seahorse(1)
> 
> seahorse-tool.1:
> 
>  >  Help options
>  >  Application options

> 
> No other manpages separate options like this.  Instead we normally
> just put the options in alphabetical order.

Will Remove them.
> 
>  >     -i FILE, --import FILE
> 
> On Solaris, we use lower case for options so this should be:
> 
> -i <replaceable>file</replaceable>,
> --import <replaceable>file</replaceable>

Will change the style as Solaris. But since this is in roff format, the
grammar will be different.
> 
>  >          Import keys from the FILE.
> 
> This should also be <replaceable>file</replaceable>.


> 
> Ditto for other options.
> 
>  >     -T, --uri-list
>  >          Read list of URIs on standard in.
> 
> What is this used for.  Perhaps an example in the EXAMPLES section
> would clarify.

Not sure for now. I will change it a while later.
> 
>  >  Additional options
>  >     In addition, the usual GTK+ and GNOME command  line  options
>  >     apply. See the output of --help for details.
> 
> Again, we should refer to gnome-std-options.
> 
>  > VERSION
>  >     This man page describes seahorse version 0.9.
> 
> I'd remove this section.
ok.
> 
>  > SEE ALSO
>  >     seahorse-daemon(1)
> 
> I'd add seahorse(1) and seahorse-agent(1).
ok

Attached the updated version.

Thanks

Jeff
> 
> ---
> 
> Brian
> 
> 
>     -i <r

-------------- next part --------------
A non-text attachment was scrubbed...
Name: seahorse-agent.1
Type: text/troff
Size: 2250 bytes
Desc: not available
URL: 
<http://mail.opensolaris.org/pipermail/jds-review/attachments/20091111/856e8522/attachment.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: seahorse-tool.1
Type: text/troff
Size: 2399 bytes
Desc: not available
URL: 
<http://mail.opensolaris.org/pipermail/jds-review/attachments/20091111/856e8522/attachment-0001.bin>

Reply via email to