------- Forwarded Message
Date: Wed, 31 Oct 2001 07:46:56 -0500
Message-Id: <[EMAIL PROTECTED]>
From: "Eric S. Raymond" <[EMAIL PROTECTED]>
To: [EMAIL PROTECTED]
Subject: Errors in the epic.1 manual page
I'm working on a program that automatically translates manual page sources
to DocBook markup. You can find out more about this program at
http://www.tuxedo.org/~esr/doclifter/
If you are not already considering it, please think about moving your
documentation masters to DocBook (or some format from which you can
generate DocBook). Tools to generate man pages (docbook2man) HTML
(docbook2html) and PostScript (docbook2ps) from DocBook files are
open source and generally available. My program, doclifter, should
make moving your masters to DocBook a pretty painless process.
Many major open source projects (including the Linux Documentation
Project, GNOME, KDE, and FreeBSD) have moved to DocBook or are in the
process of doing so. The format has many advantages over man, info,
texinfo, or HTML; by moving everybody to it, we should be able to
support unified browsing of all system documentation with Web-like
hypertext capabilities, automatic indexing, and rich search facilities.
In the process of debugging doclifter, I have discovered many bugs in
man page layout. These are significant because they make automated
translation to DocBook more difficult, and often confuse other document-
mining tools (such as indexers).
I have found some markup bugs on a manual page you maintain. There
are non-Mdoc macro calls scattered through it. The folowing patch
cleans them up:
--- epic.1 2001/10/31 12:17:25 1.1
+++ epic.1 2001/10/31 12:42:45
@@ -55,7 +55,6 @@
Force the startup file to be loaded immediately rather than waiting until a
connection to a server is established.
.It Fl c Ar chan
Join the specified channel the first time you successfully connect to a server.
-.TP
.It Fl d
Operate in
.Dq dumb mode.
@@ -75,7 +74,6 @@
However, you will not have hardware flow control.
.It Fl h
Display a moderately concise help message and exit immediately.
-.TP
.It Fl H Ar hostname
Use the IP address of the specified hostname as your default IP address.
This can be used if you have multiple IP addresses on the same machine and you want
to use an address other than the default address.
@@ -138,12 +136,11 @@
.Ev IRCNICK
environment variable.
If all else fails, then the client uses your login name as the default nickname.
-.TP
.It server,[server]
After the nickname, a list of one or more server specifications can be listed.
Unless you specify the -a option, this will replace your default server list!
The -a option forces any servers listed here to be appended to the default server
list.
-.IP
+.El
The format for server specifications is:
.sp
.Dl hostname:port:password:nick
@@ -206,7 +203,6 @@
If you're totaly stumped and trying to get on undernet, try this.
.It Nm "epic nickname irc.dal.net"
If you're totaly stumped and trying to get on dalnet, try this.
-.TP
.Sh "FILES"
.Bl -tag -width "/usr/local/share/epic"
.It Nm /usr/local/bin/epic
@@ -233,18 +229,14 @@
There are a bazillion commands and a multitude of nuances that will take a few months
to get down pat.
But once you do, you will be so firmly addicted to irc that your wife will divorce
you, your kids will leave you, your dog will run away, and you'll flunk all your
classes, and be left to sing the blues.
.Sh "USEFUL WEB RESOURCES"
-.Tp
-.Pp
-.Pa <http://www.epicsol.org/>
+.Bl -tag -width "<http://www.epicsol.org/>"
+.It Pa <http://www.epicsol.org/>
The EPIC home page
-.Tp
-.Pp
-.Pa <http://help.epicsol.org/>
+.It Pa <http://help.epicsol.org/>
The Online EPIC Help Pages
-.Tp
-.Pp
-.Pa <http://www.irchelp.org/>
+.It Pa <http://www.irchelp.org/>
Lots of great help for new irc users.
+.El
.Sh "SIGNALS"
.Nm epic
handles the following signals gracefully
@@ -262,7 +254,6 @@
, or
.Pa ~/.login
file:
-.TP
.Bl -tag -width "IRCSERVER"
.It Ev IRCNICK
The user's default IRC nickname
Please apply this patch in your next release.
--
<a href="http://www.tuxedo.org/~esr/";>Eric S. Raymond</a>
Certainly one of the chief guarantees of freedom under any government,
no matter how popular and respected, is the right of the citizens to
keep and bear arms. [...] the right of the citizens to bear arms is
just one guarantee against arbitrary government and one more safeguard
against a tyranny which now appears remote in America, but which
historically has proved to be always possible.
-- Hubert H. Humphrey, 1960
------- End of Forwarded Message
_______________________________________________
List mailing list
[EMAIL PROTECTED]
http://epicsol.org/mailman/listinfo/list
