'\" t
.\"     Title: refdbnd
.\"    Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 2005-10-16
.\"    Manual: RefDB Manual
.\"    Source: RefDB Manual
.\"  Language: English
.\"
.TH "REFDBND" "1" "2005\-10\-16" "RefDB Manual" "RefDB Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
refdbnd \- creates a skeleton document and a Makefile for RefDB
.SH "SYNOPSIS"
.PP
Interactive mode:
.HP \w'\fBrefdbnd\fR\ 'u
\fBrefdbnd\fR
.PP
Non\-interactive mode:
.HP \w'\fBrefdbnd\fR\ 'u
\fBrefdbnd\fR \fIbasename\fR \fIdoctype\fR \fIpubtype\fR \fIdatabase\fR \fIstyle\fR \fIencoding\fR [\fIcss\-file\fR] [\fIfo\-driver\fR] [\fIhtml\-driver\fR] [\fIxhtml\-driver\fR]
.SH "DESCRIPTION"
.PP
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\&.
.PP
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\&.
.PP
The script can create the following document types:
.PP
\fBDocBook SGML\fR
.RS 4
Versions 3\&.1, 4\&.0, 4\&.1
.RE
.PP
\fBDocBook XML\fR
.RS 4
Versions 4\&.1\&.2, 4\&.2, 4\&.3, 5\&.0
.RE
.PP
\fBTEI XML\fR
.RS 4
Versions P4, P5
.RE
.PP
\fBRich Text Format (RTF)\fR
.RS 4
Version 1\&.9 (M$ Word 2007 and earlier, OpenOffice, AbiWord, and most other contemporary word processors)
.RE
.PP
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\&.
.SH "OPTIONS"
.PP
\fIbasename\fR
.RS 4
The basename of the document, i\&.e\&. sans extension\&. If you want to end up with
\fIfoo\&.pdf\fR, use
\fIfoo\fR
.RE
.PP
\fIdoctype\fR
.RS 4
Available options are
\fIdb31\fR,
\fIdb40\fR, and
\fIdb41\fR
for DocBook SGML;
\fIdb41x\fR,
\fIdb42x\fR, and
\fIdb43x\fR
for DocBook XML;
\fIteix\fR
for TEI XML;
\fIrtf\fR
for RTF
.RE
.PP
\fIpubtype\fR
.RS 4
This is one of
\fIset\fR,
\fIbook\fR, or
\fIarticle\fR
for DocBook, and
\fITEI\&.2\fR
for TEI\&. This argument is ignored by the other document types, but must be present nonetheless (pass "foo" or "bar", depending on your mood)\&.
.RE
.PP
\fIdatabase\fR
.RS 4
The name of the database that contains your references\&.
.RE
.PP
\fIstyle\fR
.RS 4
The name of the bibliography style\&.
.RE
.PP
\fIencoding\fR
.RS 4
The character encoding of the document\&.
.RE
.PP
\fIcss\-file\fR
.RS 4
The name of a CSS file for the HTML output\&. This option is meaningless for RTF documents and can be left out\&.
.RE
.PP
\fIfo\-driver\fR
.RS 4
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\&.
.RE
.PP
\fIhtml\-driver\fR
.RS 4
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\&.
.RE
.PP
\fIxhtml\-driver\fR
.RS 4
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\&.
.RE
.SH "MAKEFILE TARGETS"
.PP
The Makefile is set up to process your document properly depending on its type\&. The following targets are available for SGML and XML documents:
.PP
\fIhtml\fR
.RS 4
Creates a set of HTML files\&.
.RE
.PP
\fIpdf\fR
.RS 4
Creates a PDF file\&.
.RE
.PP
\fIps\fR
.RS 4
Creates a Postscript file (SGML documents only)\&.
.RE
.PP
\fIrtf\fR
.RS 4
Creates a RTF file\&. The Rich Text Format can be edited by most Word Processors\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
Not all FO processors offer RTF output, so this target may not work for XML documents with your setup\&.
.sp .5v
.RE
.RE
.PP
\fIall\fR
.RS 4
This is the default if you call
\fBmake\fR
without specifying a target\&. It will build all of the above targets\&.
.RE
.PP
\fIhtmldist\fR
.RS 4
Creates a
\&.tar\&.gz
archive of the HTML files\&.
.RE
.PP
\fIpdfdist\fR
.RS 4
Creates a
\&.tar\&.gz
archive of the PDF file\&.
.RE
.PP
\fIps\fR
.RS 4
Creates a
\&.tar\&.gz
archive of the Postscript file (SGML documents only)\&.
.RE
.PP
\fIrtf\fR
.RS 4
Creates a
\&.tar\&.gz
archive of the RTF file\&.
.RE
.PP
\fIdist\fR
.RS 4
This will build all of the above archives\&.
.RE
.PP
\fIclean\fR
.RS 4
This will remove all built files, except for the source document using the full citation format\&.
.RE
.PP
\fIshortclean\fR
.RS 4
This will remove all built files, including the source document using the full citation format\&.
.RE
.PP
For RTF output there is only a default target which you can invoke by running
\fBmake\fR
without an argument, and the "clean" target which removes generated files\&.
.SH "FILES"
.PP
PREFIX/share/refdb/db/examples/Makefile\&.template
.PP
PREFIX/share/refdb/db/examples/Makefile\&.rtf\&.template
.PP
The templates used to create the Makefile\&.
.SH "SEE ALSO"
.PP
\fBRefDB\fR
(7)\&.
.PP
\fIRefDB manual (local copy) \fR
PREFIX/share/doc/refdb\-<version>/refdb\-manual/index\&.html
.PP
\fIRefDB manual (web) \fR
<\m[blue]\fBhttp://refdb\&.sourceforge\&.net/manual/index\&.html\fR\m[]>
.PP
\fIRefDB on the web \fR
<\m[blue]\fBhttp://refdb\&.sourceforge\&.net/\fR\m[]>
.SH "AUTHOR"
.PP
refdbnd was written by Markus Hoenicka <markus@mhoenicka\&.de>\&.