Dominik Vogt wrote:
> >
> > Putting a command summary up at the top will point users to which
> > command(s) they should be looking at, rather than forcing them to scan
> > thru the entire doc.
>
> Hm. How would you structure this summary? Just the command name
> and a brief description?
I think a command summary in the man page would be not that helpful. The
problem is that the fvwm2 man page is just too big and the requirements
to the man page are too various. Sometimes one is looking for a special
command, an other time one looks for some certain behavior and next time
one is browsing through the man page just to get a new idea, without
actually knowing what to look for ;-)
Regarding this, one needs three (or even more) man pages for one
application or one really big man page containing a lot of redundancy.
And even then some people might not find what they are looking for.
Maybe a set of html-files could provide a more comfortable way the get
the required information. I like the html documentation for java
provided by the javadoc program. (javadoc produces a set of html pages.
I think actually there three frames one for chapters (java packages),
one for sections (class names) and for the text.) Maybe you guys could
do a similar documentation for fvwm2.
Another way could be providing a setup/configuration tool which comes
with fvwm2. A tool which interacts with fvwm2 would provide much more
help as a good documentation can do. (But it cannot replace the doc.) I
know there are some people working on a config tool, but none of the
tools is supported by fvwm2 and none, which really works, does interact
with fvwm2.
Uwe
--
Visit the official FVWM web page at <URL: http://www.fvwm.org/>.
To unsubscribe from the list, send "unsubscribe fvwm" in the body of a
message to majordomo_at_fvwm.org.
To report problems, send mail to fvwm-owner_at_fvwm.org.
Received on Tue Jan 29 2002 - 02:13:03 GMT