Yuntong:

Your change is an improvement, but really manpages should explain to
the user how to use a program.  The lines you added to the manpage do
inform the user that the --remote and --remote-help arguments exist.
However, they provide little information on how to use them or why
a user would want to use them.  Manpages should explain things like
this.

>      -r option means  send commands to an existing GQview process to 
> control it.
> Like: bash-4.0$ gqview -r -n PID
> All the remote command list in -rh,--remote-help.

The manpage would be improved if it explained the above and provided
an example like you suggest above.  Though the manpage should also
explain why a user would want to do this in the first place.  What
reasons would a user want to control a GQview process remotely?

> Unlucky , the -r option doesn't work on OSOL, already filed a bug for it:
> http://defect.opensolaris.org/bz/show_bug.cgi?id=13358
> 
> Revise the -r option and add -rh,--remote-help option in man page, the 
> functionality  of "-r" option seems  pretty  obvious, should we need an 
> example here?

It is not obvious to me.  I do not use GQview.  Perhaps an experienced
GQview user would find these options obvious, but manpages should be
designed for users of all skill levels.  I think examples help to make
things easier to understand, so I think examples of how to use advanced
features like this are always a good idea.

It might not make sense for Sun to invest energy improving this
particular manpage, but we should at least report the issue as a bug
upstream.  It would be better to fix this issue upstream rather than
us patching the manpage ourselves.

Brian

Reply via email to