This is the mail archive of the
docbook-apps@lists.oasis-open.org
mailing list .
[docbook-apps] Problems with tables in reference "man" pages
- From: Mike Cooper <Mike dot Cooper at reshape dot com>
- To: docbook-apps at lists dot oasis-open dot org
- Date: Thu, 19 Feb 2004 14:32:58 -0800
- Subject: [docbook-apps] Problems with tables in reference "man" pages
I've written my first UNIX man page in docbook refence format. It has an
informaltable in it. When I convert it to a formated man ASCII text file using
docbook2man (docbook-utils v0.6.12 and openjade 1.3.1 or 1.3.2), the table is
unreadable.
Here's the sgml:
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!ENTITY mc "<trademark>MagniComp</trademark>">
<!ENTITY si "<trademark>SysInfo</trademark>">
]>
<!-- $Revision$ -->
<refentry id="mcsysinfohcf">
<!-- $Revision$ -->
<refmeta>
<refentrytitle>mcsysinfohcf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>mcsysinfohcf</refname>
<refpurpose>&si; Host access Configuration File (HCF)</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
# Comment
host|snmpCommunity|username|password
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
A Host access Configuration File (HCF) contains data used to access
a host by means of various network protocols such as
<command>telnet</command> and SNMP.
</para>
<para>
Each HCF file consists of one host entry per line.
Each line consists of the following fields which are deliminted by the
<literal>|</literal> (vertical pipe) character:
<informaltable>
<tgroup cols='3'>
<thead>
<row>
<entry>Field #</entry>
<entry>Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry><varname>host</varname></entry>
<entry>The name of the host.</entry>
</row>
<row>
<entry>2</entry>
<entry><varname>snmpCommunity</varname></entry>
<entry>The SNMP community name.</entry>
</row>
<row>
<entry>3</entry>
<entry><varname>userName</varname></entry>
<entry>A username.</entry>
</row>
<row>
<entry>4</entry>
<entry><varname>password</varname></entry>
<entry>A password.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
</refentry>
<!-- Tell xemacs+PSGML where the parent doc is so it can parse this file
Local Variables:
sgml-parent-document: ("RefMan.sgmin" "book" "chapter")
End:
-->
Here is the formated output from docbook2man:
.\" This manpage has been automatically generated by docbook2man
.\" from a DocBook document. This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "MCSYSINFOHCF" "5" "19 February 2004" "" ""
.SH NAME
mcsysinfohcf \- SysInfo\\u\\s-2TM\\s+2\\d Host access Configuration File (HCF)
.SH SYNOPSIS
.nf
# Comment
host|snmpCommunity|username|password
.fi
.SH "DESCRIPTION"
.PP
A Host access Configuration File (HCF) contains data used to access
a host by means of various network protocols such as
\fBtelnet\fR and SNMP.
.PP
Each HCF file consists of one host entry per line.
Each line consists of the following fields which are deliminted by the
| (vertical pipe) character:
Field #NameDescription1hostThe name of the host.2snmpCommunityThe SNMP
community name.3userNameA username.4passwordA password.
Is there a better tool for converting docbook to man which works with tables?
mike
To unsubscribe from this list, send a post to docbook-apps-unsubscribe@lists.oasis-open.org, or visit http://www.oasis-open.org/mlmanage/.