<HTML
><HEAD
><TITLE
>Linux Man Page Howto</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="NEXT"
TITLE="A few thoughts on documentation"
HREF="q1.html"></HEAD
><BODY
CLASS="ARTICLE"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="ARTICLE"
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="TITLE"
><A
NAME="AEN2"
></A
>Linux Man Page Howto</H1
><H3
CLASS="AUTHOR"
><A
NAME="AEN4"
> Jens Schweikhardt</A
></H3
><DIV
CLASS="AFFILIATION"
><DIV
CLASS="ADDRESS"
><P
CLASS="ADDRESS"
><TT
CLASS="EMAIL"
><<A
HREF="mailto:howto@schweikhardt.net"
>howto@schweikhardt.net</A
>></TT
></P
></DIV
></DIV
><P
CLASS="OTHERCREDIT"
><B
>Pradeep Padala - </B
><SPAN
CLASS="CONTRIB"
>Conversion from HTML to DocBook v4.1.</SPAN
></P
><P
CLASS="PUBDATE"
>v0.1, 2002-09-07<BR></P
><DIV
CLASS="REVHISTORY"
><TABLE
WIDTH="100%"
BORDER="0"
><TR
><TH
ALIGN="LEFT"
VALIGN="TOP"
COLSPAN="3"
><B
>Revision History</B
></TH
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 0.1</TD
><TD
ALIGN="LEFT"
>2002-09-07</TD
><TD
ALIGN="LEFT"
>Revised by: ppadala</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Conversion from HTML to Docbook v4.1</TD
></TR
></TABLE
></DIV
><DIV
><DIV
CLASS="ABSTRACT"
><A
NAME="AEN21"
></A
><P
></P
><P
>$Id: Man-Page.sgml,v 1.2 2002/12/15 17:51:43 schweikh Exp schweikh $</P
><P
> <EM
>This HOWTO explains what you should bear in mind when you are
going to write on-line documentation -- a so-called man page --
that you want to make accessible via the <TT
CLASS="LITERAL"
>man</TT
>(1)
command. Throughout this HOWTO, a manual entry is simply referred
to as a man page, regardless of actual length and without sexist
intention.
</EM
>
</P
><P
></P
></DIV
></DIV
><HR></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
>1. <A
HREF="q1.html"
>A few thoughts on documentation</A
></DT
><DT
>2. <A
HREF="q2.html"
>How are man pages accessed?</A
></DT
><DT
>3. <A
HREF="q3.html"
>How should a formatted man page look?</A
></DT
><DT
>4. <A
HREF="q4.html"
>How do I document several programs/functions in a
single man page?</A
></DT
><DT
>5. <A
HREF="q5.html"
>Which macro package should I
use?</A
></DT
><DT
>6. <A
HREF="q6.html"
>What preprocessors may I
use?</A
></DT
><DT
>7. <A
HREF="q7.html"
>Should I distribute source
and/or already formatted documentation?</A
></DT
><DT
>8. <A
HREF="q8.html"
>What are the font
conventions?</A
></DT
><DT
>9. <A
HREF="q9.html"
>Polishing your man
page</A
></DT
><DT
>10. <A
HREF="q10.html"
>How do I get a plain text man
page without all that ^H^_ stuff?</A
></DT
><DT
>11. <A
HREF="q11.html"
>How do I get a high quality
PostScript man page?</A
></DT
><DT
>12. <A
HREF="q12.html"
>How do I get `apropos' and `whatis' to work?</A
></DT
><DT
>13. <A
HREF="copying.html"
>Copying conditions</A
></DT
><DT
>14. <A
HREF="acknowledgements.html"
>Acknowledgements</A
></DT
><DT
>15. <A
HREF="changelog.html"
>Changelog</A
></DT
></DL
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
> </TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
> </TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="q1.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
> </TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
> </TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>A few thoughts on documentation</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
