Chris:
> Attached is the manpage for gegl,please help to review
You put the SYNOPSIS section after the DESCRIPTION section. It should
go before.
In DESCRIPTION you say:
GEGL provides infrastructure to do demand based cached non
destructive image editing on larger than RAM buffers.
I'd say "gegl" not GEGL.
I would say "to do demand-based, cached, non-destructive image
editing"
Adding commas and "-" characters makes reading the text more clear.
Through babl it provides support for a wide range of color
models and pixel storage formats for input and output.
I would more simply say gegl uses the libbabl-0.0 library
to provide"
Note I made the same comments as above about the libgegl-0.0 manpage
you sent for review, so I was surprised to see the same problems here.
GEGL provides a commandline tool called gegl, for working
I would just say "The gegl commandline tool is used for working..."
It is not necessary ot say GEGL provides this in the gegl man page.
It seems redundant.
Why does the OPTIONS section specify options (like -r) which are not
in the SYNOPSIS?
-r Send a running Player a command.
Shouldn't this be -r <replaceable>command</replaceable>? I'd guess
this option would take an argument. Also, it isn't clear to me what
this option does. What is a Player? You should describe such terms
in the DESCRIPTION section.
Likewise the --file, --output options look like should take an argument.
So the SYNOPSIS and OPTIONS section should reflect this.
Note the gnome-terminal manpage looks like this in the SYNOPSIS section
for describing options.
-e, --command command
-x, --execute command
Your man page looks like this:
--help,-h
Please be consistent here, and use the standard as in the gnome-terminal
example. Single-dash arguments are first. A space after the comma.
--dot output a graphviz graph description
You should explain what graphviz is and how gegl uses it in the
description if you are going to refer to it in the OPTIONS section.
The manpage should also refer to the graphviz manpage in the "SEE
ALSO" section. However we do not have a graphviz manpage yet. I'd ask
Dermot about this since he owns graphviz. You'll need to coordinate
with him so when the graphviz manpage is added, you add a reference t
the "SEE ALSO" section
-p (increment frame counters of various ele-
ments when processing is done.)
Remove the parens. What does this option do? Why would a user
want to increment frame counters of various elements when processing
is done? The manpage should make it clear why a user would want to
use an option.
Note the description of -s says "Send a running..." while the
description of "--file,-i" says "read xml from named file". Please
capitalize the first word in the description consistently. Also
"xml" should be "XML".
-X output the XML that was read in
Ending a sentence with a preposition is bad grammar. Perhaps
say "Output the XML that was loaded." You should capitalize output.
Also how is -X different than -o? I assume the difference is that
-X sends the output to stdout? If so, you should say so.
Brian
> ------------------------------------------------------------------------
>
> %commonents; %booktitles; ]> gegl1 25 Feb 2009 &man1; &release; generic
> &suncopy; gegl GEGL commandline tool geglGEGL commandline tool GEGL
> provides infrastructure to do demand based cached non destructive image
> editing on larger than RAM buffers. Through babl it provides support for
> a wide range of color models and pixel storage formats for input and
> output. GEGL provides a commandline tool called gegl, for working with
> the XML data model from file, stdin or the commandline. It can display
> the result of processing the layer tree or save it to file. &cmd; -help
> -file -xml -dot -output -verbose The following options are supported: -r
> Send a running Player a command. -help,-h Print the command line
> options. -file,-i read xml from named file -xml,-x use xml provided in
> next argument -dot output a graphviz graph description -output,-o output
> generated image to named file (file is saved in PNG format) -p
> (increment frame counters of various elements when processing is done.)
> -X output the XML that was read in -verbose,-v print diagnostics while
> running The following files are used by this library: /usr/bin/&cmd;
> GEGL commandline tool See attributes5 for descriptions of the following
> attributes: ATTRIBUTE TYPEATTRIBUTE VALUE AvailabilitySUNWgegl Interface
> stabilityVolatile libgegl-0.03 Online documentation:
> http://www.gegl.org/#_gegl Written by Chris Wang, Sun Microsystems Inc.,
> 2009.
