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