<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <HTML ><HEAD ><TITLE >backend-spec</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK REL="HOME" TITLE="DocBook Utils" HREF="index.html"><LINK REL="UP" TITLE="Application programming interface" HREF="api.html"><LINK REL="PREVIOUS" TITLE="Application programming interface" HREF="api.html"><LINK REL="NEXT" TITLE="frontend-spec" HREF="frontend-spec.html"></HEAD ><BODY CLASS="REFENTRY" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >DocBook Utils</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="api.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="frontend-spec.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="BACKEND-SPEC" ></A >backend-spec</H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN825" ></A ><H2 >Name</H2 >backend-spec -- interface between jw and its backends</DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN828" ></A ><H2 >Description</H2 ><P ><SPAN CLASS="CITEREFENTRY" ><SPAN CLASS="REFENTRYTITLE" >jw</SPAN >(1)</SPAN > calls backends like <TT CLASS="FILENAME" >backends/html</TT > to do the "real" conversion work. The backend gets all necessary data delivered via environment variables ready to use.</P ><P >This documentation describes those environment variables.</P ><P >The backend is run in the directory where the output files are to be created. It should return 0 if there weren't any problem, and return a positive value otherwise.</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN837" ></A ><H2 >Variables</H2 ><DIV CLASS="GLOSSLIST" ><DL ><DT ><B > <CODE CLASS="ENVAR" >SGML_FILE_NAME</CODE > </B ></DT ><DD ><P >The bare name of the source file</P ></DD ></DL ></DIV ><P ></P ><DIV CLASS="GLOSSLIST" ><DL ><DT ><B > <CODE CLASS="ENVAR" >SGML_FILE</CODE > </B ></DT ><DD ><P >The full name and path of the source file</P ></DD ></DL ></DIV ><P ></P ><DIV CLASS="GLOSSLIST" ><DL ><DT ><B > <CODE CLASS="ENVAR" >SGML_JADE</CODE > </B ></DT ><DD ><P >The name of the parser (usually <SPAN CLASS="APPLICATION" >Jade</SPAN > or <SPAN CLASS="APPLICATION" >OpenJade</SPAN >)</P ></DD ></DL ></DIV ><P ></P ><DIV CLASS="GLOSSLIST" ><DL ><DT ><B > <CODE CLASS="ENVAR" >SGML_ARGUMENTS</CODE > </B ></DT ><DD ><P >The full argument-string for <SPAN CLASS="APPLICATION" >Jade</SPAN > or <SPAN CLASS="APPLICATION" >OpenJade</SPAN ></P ></DD ></DL ></DIV ><P ></P ><DIV CLASS="GLOSSLIST" ><DL ><DT ><B > <CODE CLASS="ENVAR" >SGML_CATALOG_FILES</CODE > </B ></DT ><DD ><P >The list of catalog files needed by <SPAN CLASS="APPLICATION" >Jade</SPAN > or <SPAN CLASS="APPLICATION" >OpenJade</SPAN ></P ></DD ></DL ></DIV ><P ></P ><DIV CLASS="GLOSSLIST" ><DL ><DT ><B > <CODE CLASS="ENVAR" >SGML_STYLESHEET</CODE > </B ></DT ><DD ><P >The style sheet to use</P ></DD ></DL ></DIV ><P ></P ><DIV CLASS="GLOSSLIST" ><DL ><DT ><B > <CODE CLASS="ENVAR" >SGML_BASE_DIR</CODE > </B ></DT ><DD ><P >The base directory of the SGML system (default is <TT CLASS="FILENAME" >/usr/share/sgml</TT >)</P ></DD ></DL ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN894" ></A ><H2 >Files</H2 ><P ></P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN897" ></A ><H2 >See also</H2 ><P ><SPAN CLASS="CITEREFENTRY" ><SPAN CLASS="REFENTRYTITLE" >frontend-spec</SPAN >(7)</SPAN ></P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN903" ></A ><H2 >Authors</H2 ><P >Jochem Huhmann <CODE CLASS="EMAIL" ><<A HREF="mailto:joh@revier.com" >joh@revier.com</A >></CODE ></P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="api.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="frontend-spec.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >Application programming interface</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="api.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >frontend-spec</TD ></TR ></TABLE ></DIV ></BODY ></HTML >