'\" t
.\"     Title: refdbjade
.\"    Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 2005-10-17
.\"    Manual: RefDB Manual
.\"    Source: RefDB Manual
.\"  Language: English
.\"
.TH "REFDBJADE" "1" "2005\-10\-17" "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"
refdbjade \- transform SGML and XML documents containing RefDB bibliographies
.SH "SYNOPSIS"
.HP \w'\fBrefdbjade\fR\ 'u
\fBrefdbjade\fR [\fB\-h\fR] [\fB\-I\fR\ \fIname\fR] [\fB\-j\fR\ \fIjade\-args\fR] [\fB\-p\fR\ \fIprefix\fR] [\fB\-s\fR\ \fIstylesheet\fR] [\fB\-t\fR\ \fIformat\fR] [\fB\-v\fR\ \fIvariable[=name]\fR] \fIfile\fR
.SH "DESCRIPTION"
.PP
refdbjade uses the stylesheet driver file that you created with
runbib(1) and feeds it to Jade/OpenJade to transform your DocBook SGML or XML document to one of the supported output formats\&.
.PP
Note: If you prefer to transform your DocBook XML document with the XSL stylesheets as most people do these days, please use
refdbxml(1) instead\&.
.SH "OPTIONS"
.PP
\fB\-h\fR
.RS 4
Prints a command synopsis on the screen and exits
.RE
.PP
\fB\-I\fR \fIname\fR
.RS 4
Change the value of an entity declaration to include marked sections\&. Multiple entries are possible\&. These are passed as
\fB\-i\fR
options to Jade/OpenJade\&.
.RE
.PP
\fB\-j\fR \fIjade\-args\fR
.RS 4
Set additional command line options for Jade/OpenJade
.RE
.PP
\fB\-p\fR \fIprefix\fR
.RS 4
This determines a prefix that is added to all filenames that Jade/OpenJade create\&. This can be useful to avoid filename conflicts if you transform or use several DocBook documents in the same folder\&.
.RE
.PP
\fB\-s\fR \fIstylesheet\fR
.RS 4
This selects the stylesheet driver file\&. This file is generated by refdbib(1) (which in turn is called by runbib(1)) and contains additional formatting information\&.
.RE
.PP
\fB\-t\fR \fIformat\fR
.RS 4
Select an output format with this option\&. Possible values are
\fIhtml\fR,
\fIrtf\fR,
\fIdvi\fR,
\fIpdf\fR,
\fIps\fR,
\fItex\fR, to generate HTML, RTF, DVI, PDF, PostScript, or JadeTeX output, respectively\&. Use
\fItps\fR
and
\fItpdf\fR
to create PostScript or PDF output, respectively, from the intermediate JadeTeX output generated by any of the switches
\fIdvi\fR,
\fIpdf\fR,
\fIps\fR, or
\fItex\fR\&. This is useful if you have to edit the intermediate JadeTeX file, e\&.g\&. to manually shift pagebreaks\&. If your DSSSL engine of choice is OpenJade, you can use
\fIhtmlr\fR
to generate raw HTML output (the same as HTML but without these funny linefeeds in the end tags)\&.
.RE
.PP
\fB\-v\fR \fIvariable[=value]\fR
.RS 4
Change the value of a variable in the stylesheet\&. Multiple entries are possible\&. These are passed as such to Jade/OpenJade\&. The syntax "variable" causes "variable" to be set to "#t"\&. The extended syntax "variable[=value]" sets the variable to the given value\&.
.RE
.PP
\fIfile\fR
.RS 4
The names of one or more SGML or XML files\&. Each document will be processed separately\&.
.RE
.SH "CONFIGURATION"
.PP
Instead of using the command\-line switches, refdbjade can also be configured by means of the refdbjaderc configuration file\&. As with all refdb configuration files, you may maintain a global copy in
/usr/local/etc/refdb/
and one copy per user in
\fB$HOME\fR\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&1.\ \&refdbjaderc
.TS
allbox tab(:);
lB lB lB.
T{
Variable
T}:T{
Default
T}:T{
Comment
T}
.T&
l l l
l l l
l l l
l l l.
T{
jade_includearg
T}:T{
none
T}:T{
Change the value of an entity declaration to include marked sections\&. Multiple entries are possible\&. These are passed as \fB\-i\fR options to Jade/OpenJade\&.
T}
T{
jade_variable
T}:T{
none
T}:T{
Change the value of a variable in the stylesheet\&. Multiple entries are possible\&. These are passed as \fB\-v\fR options to Jade/OpenJade\&. The syntax "variable" causes "variable" to be set to "#t"\&. The extended syntax "variable[=value]" sets the variable to the given value\&.
T}
T{
jadeargs
T}:T{
none
T}:T{
Set additional command line options for Jade/OpenJade\&. Use e\&.g\&. "\-E 0" to disable the maximum error limit
T}
T{
outformat
T}:T{
tex
T}:T{
Set the default output format\&. Supported values are tex, html, rtf, dvi, pdf, ps, tps, and tpdf
T}
.TE
.sp 1
.SH "ENVIRONMENT"
.PP
\fISGML_CATALOG_FILES\fR
.PP
This environment variable is consulted to resolve public identifiers in the SGML source documents\&. It is advisable to keep local copies of the DTD files and add
\fBOVERRIDE YES\fR
to the top of your catalog files\&. This ensures that the local copies are used and avoids unnecessary network traffic\&.
.SH "EXAMPLE"
.PP
Here we\*(Aqll use the files generated in the last example above (see
runbib) and generate a nicely formatted PDF file:
.sp
.if n \{\
.RS 4
.\}
.nf
      ~$ 
      \fBrefdbjade \-d J\&.Biol\&.Chem\&.dsl \-t pdf mypaper\&.sgml\fR
    
.fi
.if n \{\
.RE
.\}
.PP
To obtain HTML output, you just change the output type switch:
.sp
.if n \{\
.RS 4
.\}
.nf
      ~$ 
      \fBrefdbjade \-d J\&.Biol\&.Chem\&.dsl \-t html mypaper\&.sgml\fR
    
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBRefDB\fR
(7),
\fBrefdbib\fR
(1),
\fBrunbib\fR
(1),
\fBrefdbxml\fR
(1)\&.
.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
refdbjade was written by Markus Hoenicka <markus@mhoenicka\&.de>\&.