bug-guile
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: More missing options for guile/doc/guile.1


From: Mark Harig
Subject: Re: More missing options for guile/doc/guile.1
Date: Thu, 27 Jan 2011 14:25:35 -0500

Here are some other language interpreters that have manual pages:

   awk, bash, bc, clisp, dc, emacs, make

"emacs" and "make" follow the terse approach, while the others do not.
These can be examined to help decide whether you would prefer for those
programs to have a terse manual page or not.

Although my preferred documentation format is "info," requiring new
users to learn info or emacs before learning guile is another barrier
to adoption, it seems to me.  If the terse approach is adopted, the
manual page should at least include a reference to the on-line manual.
(kept scrupulously up to date for each release, for example
version 1.9.14 is *not* available here
http://www.gnu.org/software/guile/docs/master/guile.html/index.html).

Speaking of on-line manuals, I would like to point to Org-mode's manual,
which has melded info and HTML together so that info keyboard
commands can be used to move through the manual (that is, some
commands, such as 'n', 'p', 'u', 't', '1', '2', but not all), while still allowing
mouse users to click on links.

http://orgmode.org/guide/index.html

This is something I would like to see all GNU online manuals that
are derived from texinfo files aspire to.  Can a guile version of
http://orgmode.org/org-keys.js be written?

---



reply via email to

[Prev in Thread] Current Thread [Next in Thread]