doc/man/backend-spec.7

   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 "BACKEND-SPEC" "7" "11 February 2004" "" ""
   7
   8 .SH NAME
   9 backend-spec \- interface between jw and its backends
  10 .SH "DESCRIPTION"
  11 .PP
  12 \fBjw\fR(1) calls backends like
  13 \fIbackends/html\fR to do the "real" conversion
  14 work. The backend gets all necessary data delivered
  15 via environment variables ready to use.
  16 .PP
  17 This documentation describes those environment variables.
  18 .PP
  19 The backend is run in the directory where the output
  20 files are to be created. It should return 0 if there weren't any problem,
  21 and return a positive value otherwise.
  22 .SH "VARIABLES"
  23 .TP
  24 \fB          SGML_FILE_NAME \fR
  25 The bare name of the source file
  26 .PP
  27 .TP
  28 \fB          SGML_FILE \fR
  29 The full name and path of the source file
  30 .PP
  31 .TP
  32 \fB          SGML_JADE \fR
  33 The name of the parser (usually
  34 \fBJade\fR or
  35 \fBOpenJade\fR)
  36 .PP
  37 .TP
  38 \fB          SGML_ARGUMENTS \fR
  39 The full argument-string for
  40 \fBJade\fR or
  41 \fBOpenJade\fR
  42 .PP
  43 .TP
  44 \fB          SGML_CATALOG_FILES \fR
  45 The list of catalog files needed by
  46 \fBJade\fR or
  47 \fBOpenJade\fR
  48 .PP
  49 .TP
  50 \fB          SGML_STYLESHEET \fR
  51 The style sheet to use
  52 .PP
  53 .TP
  54 \fB          SGML_BASE_DIR \fR
  55 The base directory of the SGML system (default is
  56 \fI/usr/share/sgml\fR)
  57 .SH "FILES"
  58 .PP
  59 .SH "SEE ALSO"
  60 .PP
  61 \fBfrontend-spec\fR(7)
  62 .SH "AUTHORS"
  63 .PP
  64 Jochem Huhmann <joh@revier.com>