zsh-users
 help / color / mirror / code / Atom feed
From: Zefram <zefram@dcs.warwick.ac.uk>
To: brown@ftms.COM (Vidiot)
Cc: zsh-users@math.gatech.edu
Subject: Re: Man pages missing
Date: Fri, 31 Jan 1997 11:53:27 +0000 (GMT)	[thread overview]
Message-ID: <5847.199701311153@stone.dcs.warwick.ac.uk> (raw)
In-Reply-To: <199701310547.XAA05940@ftms.ftms.com> from "Vidiot" at Jan 30, 97 11:47:24 pm

Vidiot wrote:
>I commented to RC separately about the documentation.  Personally I think
>the man pages and the manual should be separated.  The man pages should be
>very brief, to the point that the zsh man page could be only a couple of
>pages long.

No!  man pages are the primary form of online documentation for Unix
programs; they *must* have complete information.  I regularly look
things up in the man page, and would be severely inconvenienced if I
had to log in to a graphical terminal and fire up ghostview (or
whatever) to get authoritative information.

(Nor would I want to print out the manual.  That would cost me money,
and waste paper, and be less convenient than online documentation, and
it would be difficult to keep up with each new release.)

>The main manual should be done using a package like Framemaker, which would
>allow for easier WYSIWYG editing and formatting.

Ease of editing is not really a significant consideration for most of
us, I suspect.  I've never yet seen a WYSIWYG system that was as good
as the WYGIWYG systems running on the same computers.

>                           Zsh needs a decent manual.  What we have now
>are the man pages without the nroff/man-page-looking-format.

And what do you have against man pages?

-zefram


  parent reply	other threads:[~1997-01-31 12:15 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
1997-01-30 22:32 Vidiot
1997-01-30 23:14 ` Richard Coleman
1997-01-30 23:28 ` Zefram
1997-01-31  4:18   ` Vidiot
1997-01-31  4:57     ` Hrvoje Niksic
1997-01-31  5:47       ` Vidiot
1997-01-31  7:18         ` Hrvoje Niksic
1997-01-31 15:26           ` Vidiot
1997-01-31 16:10             ` James B. Crigler
1997-01-31 16:15             ` Bruce Stephens
1997-02-01 10:09             ` Hrvoje Niksic
1997-02-26 18:51             ` Juergen Erhard
1997-02-26 18:09               ` Uli Zappe
1997-02-27  0:11               ` man " Duncan Sargeant
1997-01-31 11:53         ` Zefram [this message]
1997-01-31 12:36           ` Man " Juergen Christoffel
1997-01-31 12:51             ` Zefram
1997-01-31 13:16               ` Bruce Stephens
1997-01-31 18:33               ` Juergen Christoffel
1997-02-01 10:03               ` Hrvoje Niksic
1997-01-31 16:11           ` Vidiot
1997-01-31 16:55             ` Zefram
1997-01-31 11:45     ` Zefram
1997-01-31 16:02       ` Vidiot
1997-01-31 16:18       ` Lee Eakin
1997-01-31 17:24 Karl E. Vogel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5847.199701311153@stone.dcs.warwick.ac.uk \
    --to=zefram@dcs.warwick.ac.uk \
    --cc=brown@ftms.COM \
    --cc=zsh-users@math.gatech.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.vuxu.org/mirror/zsh/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).