Ubuntu Manpage: refdbnd - creates a skeleton document and a Makefile for RefDB

Provided by: refdb-clients_1.0.2-3ubuntu1_amd64

NAME

       refdbnd - creates a skeleton document and a Makefile for RefDB

SYNOPSIS

       Interactive mode:

       refdbnd

       Non-interactive mode:

       refdbnd basename doctype pubtype database style encoding [css-file] [fo-driver]
               [html-driver] [xhtml-driver]

DESCRIPTION

       This script should be the first choice for novices for creating new SGML,XML, or RTF
       documents for use with RefDB(7). If called without arguments, the script runs in a
       novice-friendly interactive mode and collects a few answers about the new document. Based
       on these answers it will create a skeleton document as well as a custom-tailored Makefile
       that performs all necessary steps to create formatted output from the document.

       Alternatively you can call this script from a directory that contains an existing SGML,
       XML, or RTF file. Pass the full name to the script when it asks for a filename, and the
       script will try to guess some of the settings from the existing file.

       The script can create the following document types:

       DocBook SGML
           Versions 3.1, 4.0, 4.1

       DocBook XML
           Versions 4.1.2, 4.2, 4.3, 5.0

       TEI XML
           Versions P4, P5

       Rich Text Format (RTF)
           Version 1.9 (M$ Word 2007 and earlier, OpenOffice, AbiWord, and most other
           contemporary word processors)

       The skeleton documents created by the script contain the appropriate prolog for the
       selected document type. If required (SGML, DTD-based XML), an external entity is declared
       in the internal subset in order to include the bibliography.

OPTIONS

basename
The basename of the document, i.e. sans extension. If you want to end up with foo.pdf,
use foo

doctype
Available options are db31, db40, and db41 for DocBook SGML; db41x, db42x, and db43x
for DocBook XML; teix for TEI XML; rtf for RTF

pubtype
This is one of set, book, or article for DocBook, and TEI.2 for TEI. This argument is
ignored by the other document types, but must be present nonetheless (pass "foo" or
"bar", depending on your mood).

database
The name of the database that contains your references.

style
The name of the bibliography style.

encoding
The character encoding of the document.

css-file
The name of a CSS file for the HTML output. This option is meaningless for RTF
documents and can be left out.

fo-driver
A custom driver file for fo output. Please consult the manual for the requirements of
such a driver. This option is meaningless for RTF documents and can be left out.

html-driver
A custom driver file for html output. Please consult the manual for the requirements
of such a driver. This option is meaningless for RTF documents and can be left out.

xhtml-driver
A custom driver file for xhtml output. Please consult the manual for the requirements
of such a driver. This option is meaningless for RTF documents and can be left out.

MAKEFILE TARGETS

The Makefile is set up to process your document properly depending on its type. The
following targets are available for SGML and XML documents:

html
Creates a set of HTML files.

pdf
Creates a PDF file.

ps
Creates a Postscript file (SGML documents only).

rtf
Creates a RTF file. The Rich Text Format can be edited by most Word Processors.

Note
Not all FO processors offer RTF output, so this target may not work for XML
documents with your setup.

all
This is the default if you call make without specifying a target. It will build all of
the above targets.

htmldist
Creates a .tar.gz archive of the HTML files.

pdfdist
Creates a .tar.gz archive of the PDF file.

ps
Creates a .tar.gz archive of the Postscript file (SGML documents only).

rtf
Creates a .tar.gz archive of the RTF file.

dist
This will build all of the above archives.

clean
This will remove all built files, except for the source document using the full
citation format.

shortclean
This will remove all built files, including the source document using the full
citation format.

For RTF output there is only a default target which you can invoke by running make without
an argument, and the "clean" target which removes generated files.

FILES

       PREFIX/share/refdb/db/examples/Makefile.template

       PREFIX/share/refdb/db/examples/Makefile.rtf.template

       The templates used to create the Makefile.

AUTHOR

       refdbnd was written by Markus Hoenicka <markus@mhoenicka.de>.