zsh-users
 help / color / mirror / code / Atom feed
From: Juergen Christoffel <Christoffel@gmd.de>
To: zefram@dcs.warwick.ac.uk
Cc: brown@ftms.COM, zsh-users@math.gatech.edu
Subject: Re: Man pages missing
Date: Fri, 31 Jan 1997 13:36:48 +0100	[thread overview]
Message-ID: <199701311236.AA30548@mail2.gmd.de> (raw)
In-Reply-To: <5847.199701311153@stone.dcs.warwick.ac.uk> (message from Zefram on Fri, 31 Jan 1997 11:53:27 +0000 (GMT))

   From: Zefram <zefram@dcs.warwick.ac.uk>
   Date: Fri, 31 Jan 1997 11:53:27 +0000 (GMT)

   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.

Man pages *must* have the complete documentation? I don't think so.
With today's complex commands (which somehow violate the Unix toolbox
philosophy of small tools put together to get work done anyway ;-)
man pages get so big that they tend to be much less useful. They
worked well for the small tools and work less well for the more
complex ones like perl or zsh.

It started with tools like perl; I'm a regular perl user and would not
want to miss it; but I remember the feeling I had when I first saw the
30 or so pages of perl in the early days. And as the man pages grow
larger it gets more difficult to locate a specific section because I
can't browse the whole stuff anymore and to find it with a regexp I
sometimes need two or three approaches to find stuff if I don't
remember the exact wording I'm looking for.

   (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.)

There's no need to print out a manual if you don't want to. Today a
hypertext approach would work for me due to tools like lynx (the vt100
based web browser, so you wouldn't need Netscape or its ilk) or Emacs'
info mode. For me it's much more effective to browse through a well
organized manual with lynx or emacs than it is to page through 60+
pages of man pages with less.

I second Vidiot's suggestion to separate (a set of) terse man page(s)
and a much larger/better manual. I'd even be willing to help in
putting the latter together.

	--jc


  reply	other threads:[~1997-01-31 12:58 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         ` Man " Zefram
1997-01-31 12:36           ` Juergen Christoffel [this message]
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=199701311236.AA30548@mail2.gmd.de \
    --to=christoffel@gmd.de \
    --cc=brown@ftms.COM \
    --cc=zefram@dcs.warwick.ac.uk \
    --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).