doc/refentry/backend-spec.sgml

   1 <refentry id="backend-spec">
   2   <docinfo>
   3     <author>
   4       <firstname>Jochem</firstname> <surname>Huhmann</surname>
   5       <affiliation>
   6         <address><email>joh@revier.com</email></address>
   7       </affiliation>
   8     </author>
   9   </docinfo>
  10   <refmeta>
  11     <refentrytitle>backend-spec</refentrytitle>
  12     <manvolnum>7</manvolnum>
  13   </refmeta>
  14
  15   <refnamediv>
  16     <refname>backend-spec</refname>
  17     <refpurpose>interface between jw and its backends</refpurpose>
  18   </refnamediv>
  19
  20   <refsect1>
  21     <title>Description</title>
  22
  23     <para><citerefentry> <refentrytitle>jw</refentrytitle>
  24     <manvolnum>1</manvolnum> </citerefentry> calls backends like
  25     <filename>backends/html</filename> to do the "real" conversion
  26     work. The backend gets all necessary data delivered
  27     via environment variables ready to use.</para>
  28
  29     <para>This documentation describes those environment variables.</para>
  30
  31     <para>The backend is run in the directory where the output
  32     files are to be created. It should return 0 if there weren't any problem,
  33     and return a positive value otherwise.</para>
  34
  35   </refsect1>
  36
  37   <refsect1>
  38     <title>Variables</title>
  39
  40     <glosslist>
  41       <glossentry>
  42         <glossterm>
  43           <envar>SGML_FILE_NAME</envar>
  44         </glossterm>
  45         <glossdef>
  46           <para>The bare name of the source file</para>
  47         </glossdef>
  48       </glossentry>
  49     </glosslist>
  50
  51     <para></para>
  52
  53     <glosslist>
  54       <glossentry>
  55         <glossterm>
  56           <envar>SGML_FILE</envar>
  57         </glossterm>
  58         <glossdef>
  59           <para>The full name and path of the source file</para>
  60         </glossdef>
  61       </glossentry>
  62     </glosslist>
  63
  64     <para></para>
  65
  66     <glosslist>
  67       <glossentry>
  68         <glossterm>
  69           <envar>SGML_JADE</envar>
  70         </glossterm>
  71         <glossdef>
  72           <para>The name of the parser (usually
  73           <application>Jade</application> or
  74           <application>OpenJade</application>)</para>
  75         </glossdef>
  76       </glossentry>
  77     </glosslist>
  78
  79     <para></para>
  80
  81     <glosslist>
  82       <glossentry>
  83         <glossterm>
  84           <envar>SGML_ARGUMENTS</envar>
  85         </glossterm>
  86         <glossdef>
  87           <para>The full argument-string for
  88           <application>Jade</application> or
  89           <application>OpenJade</application></para>
  90         </glossdef>
  91       </glossentry>
  92     </glosslist>
  93
  94     <para></para>
  95
  96     <glosslist>
  97       <glossentry>
  98         <glossterm>
  99           <envar>SGML_CATALOG_FILES</envar>
 100         </glossterm>
 101         <glossdef>
 102           <para>The list of catalog files needed by
 103           <application>Jade</application> or
 104           <application>OpenJade</application></para>
 105         </glossdef>
 106       </glossentry>
 107     </glosslist>
 108
 109     <para></para>
 110
 111     <glosslist>
 112       <glossentry>
 113         <glossterm>
 114           <envar>SGML_STYLESHEET</envar>
 115         </glossterm>
 116         <glossdef>
 117           <para>The style sheet to use</para>
 118         </glossdef>
 119       </glossentry>
 120     </glosslist>
 121
 122     <para></para>
 123
 124     <glosslist>
 125       <glossentry>
 126         <glossterm>
 127           <envar>SGML_BASE_DIR</envar>
 128         </glossterm>
 129         <glossdef>
 130           <para>The base directory of the SGML system (default is
 131           <filename>/usr/share/sgml</filename>)</para>
 132         </glossdef>
 133       </glossentry>
 134     </glosslist>
 135
 136   </refsect1>
 137
 138   <refsect1>
 139     <title>Files</title>
 140
 141   <para></para>
 142
 143   </refsect1>
 144
 145   <refsect1>
 146     <title>See also</title>
 147
 148     <para><citerefentry> <refentrytitle>frontend-spec</refentrytitle>
 149     <manvolnum>7</manvolnum> </citerefentry></para>
 150
 151   </refsect1>
 152
 153   <refsect1>
 154     <title>Authors</title>
 155
 156     <para>Jochem Huhmann <email>joh@revier.com</email></para>
 157
 158   </refsect1>
 159
 160
 161 </refentry>
 162