1FRONTEND-SPEC(7)                                              FRONTEND-SPEC(7)
2
3
4

NAME

6       frontend-spec - interface between jw and its frontends
7

DESCRIPTION

9       jw(1)  calls  frontends  like frontends/docbook to get the informations
10       specific to a given input format. The frontend knows which  information
11       to  return from the first command line parameter. It gets all necessary
12       data via environment variables ready to use.
13
14       This document describes that command line parameter and those  environ‐
15       ment variables.
16
17       The frontend should return 0 if there weren't any problem, and return a
18       positive value otherwise.
19

VARIABLES

21                 $1
22              The command line  parameter,  specifying  which  information  to
23              return. It can take the following values:
24
25              centralized-catalog
26                     The  frontend  must  return  the DTD-specific centralized
27                     catalog name.  Centralized catalogs  normally  reside  in
28                     /etc/sgml  and  provide  the  location of all the catalog
29                     files useful for handling this input  type  (the  catalog
30                     for the DTD, the catalog for the stylesheets, the catalog
31                     for the entities,
32
33              style-sheet
34                     The frontend must return the filename of the style  sheet
35                     to  be  used  for  this document type and with the chosen
36                     backend.
37
38                 SGML_CATALOGS_DIR
39              The directory where the centralized catalogs reside. It is  nor‐
40              mally /etc/sgml.
41
42              (This  variable  is valid only while determining the centralized
43              catalog to use.)
44
45                 SGML_BASE_DIR
46              The  base  directory  of  the  SGML  system.  It   is   normally
47              /usr/share/sgml.
48
49              (This  variable  is valid only while determining the style sheet
50              to use.)
51
52                 SGML_FILE
53              The name of the file to convert.
54
55              (This variable is valid only while determining  the  centralized
56              catalog to use.)
57
58                 SGML_TYPE
59              The type of the backend to use, whether it produces output files
60              to be displayed online or to be printed out.  It  can  take  the
61              value html or print.
62
63              (This  variable  is valid only while determining the style sheet
64              to use).
65
66                 SGML_STYLESHEETS
67              The desired custom stylesheet type, either none or default.   If
68              none,  the frontend must return the file name of the style sheet
69              provided by the system beneath the docbook-utils.   If  default,
70              the  frontend  must return the custom stylesheet provided by the
71              docbook-utils.
72
73              (This variable is valid only while determining the  style  sheet
74              to use).
75
76                 SGML_XML
77              The metalanguage of the file to convert, either sgml or xml.
78
79              (This  variable  is valid only while determining the centralized
80              catalog to use).
81

FILES

SEE ALSO
84       backend-spec(7)
85

AUTHORS
87       Jochem Huhmann <joh@revier.com>
88
89
90
91                                  24 May 2007                 FRONTEND-SPEC(7)



        

    


            
        

        

            Impressum