From: Richard Coleman <coleman@math.gatech.edu>
To: zsh-workers@math.gatech.edu
Subject: Re: Man pages missing
Date: Thu, 30 Jan 1997 22:04:54 -0500 [thread overview]
Message-ID: <199701310304.WAA16759@redwood.skiles.gatech.edu> (raw)
In-Reply-To: Your message of "Thu, 30 Jan 1997 18:42:44 PST." <199701310242.AA20741@waltz.rahul.net>
> I'm not a fan of yodl. Why? Because I've never heard of it before. And
> because I have heard of other tools that have proven their utility.
>
> I would think that if you didn't find Texinfo suitable, that POD (Plain
> Old Documentation), the documentation format used by the Perl project,
> would satisfy. pod2text(1) and Pod::Text(3) come with the Perl5
> distribution, and there are pod2man(1), pod2html(1), pod2latex(1), and
> pod2fm(1) converters available elsewhere. You can find out more about
> POD by:
You should give us some credit. (When I was maintainer) I researched
this option as well as several other (pod, linux-doc, texinfo, ...)
None of these fit all our criteria, although pod was the closed.
Pod has some limitations. Chief among them is that you cannot
put tags such as bold or italics in code fragments. The zsh man pages
do this in many places in order to illustrate various syntatic things.
Also pod doesn't contain enough information to automatically create
html or texinfo files. There are translators for them, but the output
requires manual changes and additions (I just downloaded the texinfo
files for Perl today, and the README contained with it says exactly
this).
linux-doc is nice for some things, but (at the time) did not have
a translator for man pages. That kills it as a choice.
yodl seems to be a nice tool. Give it a chance before you condemn
it. If it doesn't work out, we can change formats again.
rc
next prev parent reply other threads:[~1997-01-31 3:10 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
1997-01-31 2:42 ead
1997-01-31 3:04 ` Richard Coleman [this message]
[not found] <199701311236.AA30548@mail2.gmd.de>
1997-01-31 13:07 ` Peter Stephenson
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=199701310304.WAA16759@redwood.skiles.gatech.edu \
--to=coleman@math.gatech.edu \
--cc=zsh-workers@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).