doc/man/docbook2texi-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 "DOCBOOK2TEXI-SPEC.PL" "1" "11 February 2004" "" ""
   7
   8 .SH NAME
   9 docbook2texi-spec.pl \- convert DocBook Booksto Texinfo documents
  10 .SH SYNOPSIS
  11
  12 \fBsgmlspl\fR \fBdocbook2man-spec.pl\fR
  13
  14
  15 \fBnsgmls\fR [ \fB\fIsgml document\fB\fR ]\fB| sgmlspl\fR \fBdocbook2texi-spec.pl\fR [ \fB\fIbasename\fB\fR ]
  16
  17 .SH "DESCRIPTION"
  18 .PP
  19 \fBdocbook2texi\fR is a sgmlspl spec file that produces
  20 GNU Texinfo documents from DocBook documents.
  21 .PP
  22 The program reads ESIS produced by nsgmls (or other SGML parsers) from
  23 standard input.  Currently the document element must be Book,
  24 otherwise the results are undefined.
  25 .PP
  26 Its output, the converted Texinfo document, is written to standard
  27 output.
  28 .PP
  29 The file \fIbasename.refs\fR will also
  30 be created, which contains all the nodes in the document and their immediate
  31 \&'child' nodes.  As node processing always require forward references,
  32 \fBdocbook2texi\fR must be run twice for each document: the
  33 first time to build the references, and the second to actually generate a valid
  34 document.
  35 .SH "REQUIREMENTS"
  36
  37 The SGMLSpm package from CPAN.  This package includes the sgmlspl script
  38 that is also needed.
  39 .SH "LIMITATIONS"
  40 .PP
  41 Trying \fBdocbook2man\fR on non-DocBook or non-conformant
  42 SGML results in undefined behavior. :-)
  43 .PP
  44 This program is a slow, dodgy Perl script.
  45 .PP
  46 This program does not come close to supporting all the possible markup
  47 in DocBook, and may produce wrong output in some cases with supported
  48 markup.
  49 .SH "TO DO"
  50 .TP 0.2i
  51 \(bu
  52 How the hell do you represent a backslash (\\) in Texinfo!!@?
  53 I've tried \\\\ but TeX complains about it.
  54 .TP 0.2i
  55 \(bu
  56 Fix breakages found in the test documents.
  57 .TP 0.2i
  58 \(bu
  59 Add new element handling and fix existing handling.
  60 Be robust.
  61 .TP 0.2i
  62 \(bu
  63 Make it faster. I think most of the speed problems so far is with parsing
  64 ESIS.  Rewrite \fISGMLS.pm\fR with C and/or get input directly
  65 from \fBSP\fR\&.
  66 .TP 0.2i
  67 \(bu
  68 There are some dependencies on elements occurring when they are actually
  69 optional (according to the DTD).  We need to fix that (preferably) or
  70 prominently state the requirements.
  71 .TP 0.2i
  72 \(bu
  73 Allow other more common document elements.
  74 .TP 0.2i
  75 \(bu
  76 Separate out node referencing to a separate script.  Not only would it
  77 make it faster/easier to maintain because it's separate from the main
  78 code, but also I would like it to evolve into an automatic DocBook
  79 ToC generator.
  80 .SH "COPYRIGHT"
  81 .PP
  82 Copyright (C) 1998-1999 Steve Cheng <steve@ggi-project.org>
  83 .PP
  84 This program is free software; you can redistribute it and/or modify it
  85 under the terms of the GNU General Public License as published by the
  86 Free Software Foundation; either version 2, or (at your option) any
  87 later version.
  88 .PP
  89 You should have received a copy of the GNU General Public License along with
  90 this program; see the file \fICOPYING\fR\&.  If not, please write
  91 to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.