/usr/share/doc/docbook-utils/html/frontend-spec.html is in docbook-utils 0.6.14-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>frontend-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="backend-spec"
HREF="backend-spec.html"><LINK
REL="NEXT"
TITLE="sgmldiff"
HREF="intro-sgmldiff.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="backend-spec.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="intro-sgmldiff.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="FRONTEND-SPEC"
></A
>frontend-spec</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN918"
></A
><H2
>Name</H2
>frontend-spec -- interface between jw and its frontends</DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN921"
></A
><H2
>Description</H2
><P
><SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>jw</SPAN
>(1)</SPAN
> calls frontends like
<TT
CLASS="FILENAME"
>frontends/docbook</TT
> to get the informations
specific to a given input format. The frontend knows which information
to return from the first command line parameter. It gets all necessary
data via environment variables ready to use.</P
><P
>This document describes that command line parameter and those
environment variables.</P
><P
>The frontend should return 0 if there weren't any problem,
and return a positive value otherwise.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN930"
></A
><H2
>Variables</H2
><DIV
CLASS="GLOSSLIST"
><DL
><DT
><B
> <CODE
CLASS="ENVAR"
>$1</CODE
>
</B
></DT
><DD
><P
>The command line parameter, specifying which information
to return. It can take the following values:
<P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>centralized-catalog</DT
><DD
><P
>The frontend must return the DTD-specific
centralized catalog name. Centralized catalogs normally
reside in <TT
CLASS="FILENAME"
>/etc/sgml</TT
> and provide the
location of all the catalog files useful for handling
this input type (the catalog for the DTD, the catalog
for the stylesheets, the catalog for the entities,
...)</P
></DD
><DT
>style-sheet</DT
><DD
><P
>The frontend must return the filename
of the style sheet to be used for this document type and
with the chosen backend.</P
></DD
></DL
></DIV
>
</P
></DD
></DL
></DIV
><P
></P
><DIV
CLASS="GLOSSLIST"
><DL
><DT
><B
> <CODE
CLASS="ENVAR"
>SGML_CATALOGS_DIR</CODE
>
</B
></DT
><DD
><P
>The directory where the centralized catalogs reside. It is normally
<TT
CLASS="FILENAME"
>/etc/sgml</TT
>.</P
><P
>(This variable is valid only while determining
the centralized catalog 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. It is normally
<TT
CLASS="FILENAME"
>/usr/share/sgml</TT
>.</P
><P
>(This variable is valid only while determining
the style sheet to use.)</P
></DD
></DL
></DIV
><P
></P
><DIV
CLASS="GLOSSLIST"
><DL
><DT
><B
> <CODE
CLASS="ENVAR"
>SGML_FILE</CODE
>
</B
></DT
><DD
><P
>The name of the file to convert.</P
><P
>(This variable is valid only while determining
the centralized catalog to use.)</P
></DD
></DL
></DIV
><P
></P
><DIV
CLASS="GLOSSLIST"
><DL
><DT
><B
> <CODE
CLASS="ENVAR"
>SGML_TYPE</CODE
>
</B
></DT
><DD
><P
>The type of the backend to use, whether it produces output
files to be displayed online or to be printed out.
It can take the value <CODE
CLASS="CONSTANT"
>html</CODE
> or
<CODE
CLASS="CONSTANT"
>print</CODE
>.</P
><P
>(This variable is valid only while determining
the style sheet to use).</P
></DD
></DL
></DIV
><P
></P
><DIV
CLASS="GLOSSLIST"
><DL
><DT
><B
> <CODE
CLASS="ENVAR"
>SGML_STYLESHEETS</CODE
>
</B
></DT
><DD
><P
>The desired custom stylesheet type, either <CODE
CLASS="CONSTANT"
>none</CODE
>
or <CODE
CLASS="CONSTANT"
>default</CODE
>.
If <CODE
CLASS="CONSTANT"
>none</CODE
>, the frontend must return the file name of
the style sheet provided by the system beneath the docbook-utils.
If <CODE
CLASS="CONSTANT"
>default</CODE
>, the frontend must return the custom
stylesheet provided by the docbook-utils.</P
><P
>(This variable is valid only while determining
the style sheet to use).</P
></DD
></DL
></DIV
><DIV
CLASS="GLOSSLIST"
><DL
><DT
><B
> <CODE
CLASS="ENVAR"
>SGML_XML</CODE
>
</B
></DT
><DD
><P
>The metalanguage of the file to convert, either <CODE
CLASS="CONSTANT"
>sgml</CODE
>
or <CODE
CLASS="CONSTANT"
>xml</CODE
>.</P
><P
>(This variable is valid only while determining
the centralized catalog to use).</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1005"
></A
><H2
>Files</H2
><P
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1008"
></A
><H2
>See also</H2
><P
><SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>backend-spec</SPAN
>(7)</SPAN
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1014"
></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="backend-spec.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="intro-sgmldiff.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>backend-spec</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="api.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>sgmldiff</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
|