utils/docbook2man/docbook2man-spec.pl.1

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "DOCBOOK2MAN-SPEC.PL" "1" "27 June 2002" "" ""
   7 .SH NAME
   8 docbook2man-spec.pl \- convert DocBook RefEntries to man pages
   9 .SH SYNOPSIS
  10
  11 \fBsgmlspl\fR \fBdocbook2man-spec.pl\fR
  12
  13
  14 \fBnsgmls\fR [ \fB\fIsgml document\fB\fR ]\fB| sgmlspl\fR \fBdocbook2man-spec.pl\fR
  15
  16 .SH "DESCRIPTION"
  17 .PP
  18 \fBdocbook2man\fR is a sgmlspl spec file that produced man
  19 pages (using the -man macros) from DocBook RefEntry markup.
  20 .PP
  21 The program reads ESIS produced by nsgmls (or other SGML parsers) from
  22 standard input.  Markup not found in RefEntry is discarded.
  23 .PP
  24 Its output, the converted man pages, are written to the current directory.  If
  25 RefMeta information is not specified in a
  26 RefEntry, then the man page will be written to standard
  27 output.
  28 .PP
  29 The file \fImanpage.links\fR will also be created, which contains
  30 any aliases of the manpages generated.  This file is in the format:
  31
  32 .nf
  33 \fI<man page>\fR \fI<alias
  34 manpage>\fR
  35 .fi
  36 .PP
  37 The \fImanpage.refs\fR file keeps track of
  38 XRef references.  Note that if the input document has any
  39 forward references, then \fBdocbook2man\fR may have to be
  40 invoked twice (the first time updating \fImanpage.refs\fR) to
  41 resolve them.
  42 .SH "REQUIREMENTS"
  43
  44 The SGMLSpm package from CPAN.  This package includes the sgmlspl script
  45 that is also needed.
  46 .SH "LIMITATIONS"
  47 .PP
  48 Trying \fBdocbook2man\fR on non-DocBook or non-conformant
  49 SGML results in undefined behavior. :-)
  50 .PP
  51 This program is a slow, dodgy Perl script.
  52 .PP
  53 This program does not come close to supporting all the possible markup
  54 in DocBook, and may produce wrong output in some cases with supported
  55 markup.
  56 .SH "TO DO"
  57 .PP
  58 Obvious stuff:
  59 .TP 0.2i
  60 \(bu
  61 Fix \fBdocbook2man\fR breakages found in
  62 the test documents, especially
  63 \fIweird.sgml\fR.
  64 .TP 0.2i
  65 \(bu
  66 Add new element handling and fix existing handling.
  67 Be robust.
  68 .TP 0.2i
  69 \(bu
  70 Produce cleanest, readable man output as possible (unlike some
  71 other converters).  Follow Linux
  72 \fBman\fR(7)
  73 convention.  As conversion to man pages is usually not done very often, it is
  74 better to be slower/more complicated than to produce wrong output.  Also if
  75 someone wants to give up using DocBook for whatever reason, the last-converted
  76 man pages can then be maintained manually.
  77 .TP 0.2i
  78 \(bu
  79 Make it faster. I think most of the speed problems so far is with parsing
  80 ESIS.  Rewrite \fISGMLS.pm\fR with C and/or get input directly
  81 from \fBSP\fR.
  82 .TP 0.2i
  83 \(bu
  84 Support other (human) languages.  But what to do with non-ASCII charsets?
  85 SGMLSpm doesn't report them and \fBroff\fR does not grok them.
  86 [Comment: text after enclosed lists (and SS blocks) will break docbook2man]
  87 If we do this, more people can use DocBook.
  88 .SH "COPYRIGHT"
  89 .PP
  90 Copyright (C) 1998-1999 Steve Cheng <steve@ggi-project.org>
  91 .PP
  92 This program is free software; you can redistribute it and/or modify it
  93 under the terms of the GNU General Public License as published by the
  94 Free Software Foundation; either version 2, or (at your option) any
  95 later version.
  96 .PP
  97 You should have received a copy of the GNU General Public License along with
  98 this program; see the file \fICOPYING\fR.  If not, please write
  99 to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.