doc/HTML/install-catalog.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <HTML
   3 ><HEAD
   4 ><TITLE
   5 >install-catalog</TITLE
   6 ><META
   7 NAME="GENERATOR"
   8 CONTENT="Modular DocBook HTML Stylesheet Version 1.54"><LINK
   9 REL="HOME"
  10 TITLE="SGML-common"
  11 HREF="index.html"><LINK
  12 REL="UP"
  13 TITLE="Introduction"
  14 HREF="introduction.html"><LINK
  15 REL="PREVIOUS"
  16 TITLE="Introduction"
  17 HREF="introduction.html"><LINK
  18 REL="NEXT"
  19 TITLE="GNU Free Documentation License"
  20 HREF="fdl.html"></HEAD
  21 ><BODY
  22 CLASS="REFENTRY"
  23 BGCOLOR="#FFFFFF"
  24 TEXT="#000000"
  25 LINK="#0000FF"
  26 VLINK="#840084"
  27 ALINK="#0000FF"
  28 ><DIV
  29 CLASS="NAVHEADER"
  30 ><TABLE
  31 WIDTH="100%"
  32 BORDER="0"
  33 CELLPADDING="0"
  34 CELLSPACING="0"
  35 ><TR
  36 ><TH
  37 COLSPAN="3"
  38 ALIGN="center"
  39 >SGML-common</TH
  40 ></TR
  41 ><TR
  42 ><TD
  43 WIDTH="10%"
  44 ALIGN="left"
  45 VALIGN="bottom"
  46 ><A
  47 HREF="introduction.html"
  48 >Prev</A
  49 ></TD
  50 ><TD
  51 WIDTH="80%"
  52 ALIGN="center"
  53 VALIGN="bottom"
  54 ></TD
  55 ><TD
  56 WIDTH="10%"
  57 ALIGN="right"
  58 VALIGN="bottom"
  59 ><A
  60 HREF="fdl.html"
  61 >Next</A
  62 ></TD
  63 ></TR
  64 ></TABLE
  65 ><HR
  66 ALIGN="LEFT"
  67 WIDTH="100%"></DIV
  68 ><H1
  69 ><A
  70 NAME="INSTALL-CATALOG"
  71 >install-catalog</A
  72 ></H1
  73 ><DIV
  74 CLASS="REFNAMEDIV"
  75 ><A
  76 NAME="AEN33"
  77 ></A
  78 ><H2
  79 >Name</H2
  80 >install-catalog&nbsp;--&nbsp;Manage a SGML or XML centralized catalog</DIV
  81 ><DIV
  82 CLASS="REFSYNOPSISDIV"
  83 ><A
  84 NAME="AEN36"
  85 ></A
  86 ><H2
  87 >Synopsis</H2
  88 ><P
  89 ><B
  90 CLASS="COMMAND"
  91 >install-catalog</B
  92 >  [option <I
  93 ><A
  94 HREF="install-catalog.html#OPTION"
  95 >(1)</A
  96 ></I
  97 >] {action <I
  98 ><A
  99 HREF="install-catalog.html#ACTION"
 100 >(2)</A
 101 ></I
 102 >...}<P
 103 ><A
 104 NAME="OPTION"
 105 >(1)</A
 106 >&nbsp;[<TT
 107 CLASS="OPTION"
 108 >-d</TT
 109 > | <TT
 110 CLASS="OPTION"
 111 >--delegate</TT
 112 >]</P
 113 ><P
 114 ><A
 115 NAME="ACTION"
 116 >(2)</A
 117 >&nbsp;[<TT
 118 CLASS="OPTION"
 119 >-a</TT
 120 > <TT
 121 CLASS="REPLACEABLE"
 122 ><I
 123 >centralized</I
 124 ></TT
 125 > <TT
 126 CLASS="REPLACEABLE"
 127 ><I
 128 >ordinary</I
 129 ></TT
 130 > | <TT
 131 CLASS="OPTION"
 132 >--add</TT
 133 > <TT
 134 CLASS="REPLACEABLE"
 135 ><I
 136 >centralized</I
 137 ></TT
 138 > <TT
 139 CLASS="REPLACEABLE"
 140 ><I
 141 >ordinary</I
 142 ></TT
 143 ><BR> | <TT
 144 CLASS="OPTION"
 145 >-r</TT
 146 > <TT
 147 CLASS="REPLACEABLE"
 148 ><I
 149 >centralized</I
 150 ></TT
 151 > <TT
 152 CLASS="REPLACEABLE"
 153 ><I
 154 >ordinary</I
 155 ></TT
 156 > | <TT
 157 CLASS="OPTION"
 158 >--remove</TT
 159 > <TT
 160 CLASS="REPLACEABLE"
 161 ><I
 162 >centralized</I
 163 ></TT
 164 > <TT
 165 CLASS="REPLACEABLE"
 166 ><I
 167 >ordinary</I
 168 ></TT
 169 ><BR> | <TT
 170 CLASS="OPTION"
 171 >-h</TT
 172 > | <TT
 173 CLASS="OPTION"
 174 >--help</TT
 175 ><BR> | <TT
 176 CLASS="OPTION"
 177 >-v</TT
 178 > | <TT
 179 CLASS="OPTION"
 180 >--version</TT
 181 >]</P
 182 ></P
 183 ></DIV
 184 ><DIV
 185 CLASS="REFSECT1"
 186 ><A
 187 NAME="AEN78"
 188 ></A
 189 ><H2
 190 >Description</H2
 191 ><P
 192 >This shell script allows to handle a centralized catalog
 193     referencing other "ordinary" SGML or XML Open Catalogs.</P
 194 ><P
 195 >An <I
 196 CLASS="FIRSTTERM"
 197 >Open Catalog</I
 198 > contains
 199     a set of directives defined by OASIS, mostly used
 200     for defining equivalences between FPIs (Formal Public
 201     Identifiers) and real file names (see TR9401:1997 on <A
 202 HREF="http://www.oasis-open.org"
 203 TARGET="_top"
 204 >http://www.oasis-open.org</A
 205 >).
 206     The Open Catalogs usually reside in
 207     <TT
 208 CLASS="FILENAME"
 209 >/usr/share/sgml</TT
 210 >.</P
 211 ><P
 212 >A <I
 213 CLASS="FIRSTTERM"
 214 >centralized catalog</I
 215 > is a special
 216     Open Catalog that includes only comments and CATALOG directives
 217     pointing to other catalogs (or DELEGATE directives if supported). The
 218     centralized catalog can be the key to all other SGML resources. It
 219     usually resides in <TT
 220 CLASS="FILENAME"
 221 >/etc/sgml</TT
 222 >.</P
 223 ><P
 224 >The centralized catalog can be edited manually or through the
 225     <SPAN
 226 CLASS="APPLICATION"
 227 >install-catalog</SPAN
 228 > script to add or remove
 229     references to other ordinary catalogs. This script is mainly destined
 230     to software package post-installation scripts.</P
 231 ><P
 232 >An example of a typical call to install-catalog is:
 233
 234       <PRE
 235 CLASS="SCREEN"
 236 >      install-catalog --add \
 237         /usr/share/sgml/docbook/dsssl-stylesheets-1.54/catalog \
 238         /etc/sgml/sgml-docbook-4.0.cat
 239       </PRE
 240 >
 241     </P
 242 ><P
 243 >This call will install in
 244     <TT
 245 CLASS="FILENAME"
 246 >/etc/sgml/sgml-docbook-4.0.cat</TT
 247 > a reference to
 248     <TT
 249 CLASS="FILENAME"
 250 >/usr/share/sgml/docbook/dsssl-stylesheets-1.54/catalog</TT
 251 >.</P
 252 ></DIV
 253 ><DIV
 254 CLASS="REFSECT1"
 255 ><A
 256 NAME="AEN95"
 257 ></A
 258 ><H2
 259 >Options</H2
 260 ><P
 261 >Here is the list of options that can influence the way
 262     <SPAN
 263 CLASS="APPLICATION"
 264 >install-catalog</SPAN
 265 > works:</P
 266 ><DIV
 267 CLASS="GLOSSLIST"
 268 ><DL
 269 ><DT
 270 ><B
 271 >          <P
 272 >[<TT
 273 CLASS="OPTION"
 274 >-d</TT
 275 > | <TT
 276 CLASS="OPTION"
 277 >--delegate</TT
 278 >]</P
 279 >
 280         </B
 281 ></DT
 282 ><DD
 283 ><P
 284 >Use DELEGATE instead of CATALOG directives to specify a pointer</P
 285 ></DD
 286 ></DL
 287 ></DIV
 288 ></DIV
 289 ><DIV
 290 CLASS="REFSECT1"
 291 ><A
 292 NAME="AEN110"
 293 ></A
 294 ><H2
 295 >Actions</H2
 296 ><P
 297 >Here is the list of actions that can be requested to
 298     <SPAN
 299 CLASS="APPLICATION"
 300 >install-catalog</SPAN
 301 >:</P
 302 ><DIV
 303 CLASS="GLOSSLIST"
 304 ><DL
 305 ><DT
 306 ><B
 307 >          <P
 308 >[<TT
 309 CLASS="OPTION"
 310 >-a</TT
 311 > <TT
 312 CLASS="REPLACEABLE"
 313 ><I
 314 >centralized</I
 315 ></TT
 316 > <TT
 317 CLASS="REPLACEABLE"
 318 ><I
 319 >ordinary</I
 320 ></TT
 321 > | <TT
 322 CLASS="OPTION"
 323 >--add</TT
 324 > <TT
 325 CLASS="REPLACEABLE"
 326 ><I
 327 >centralized</I
 328 ></TT
 329 > <TT
 330 CLASS="REPLACEABLE"
 331 ><I
 332 >ordinary</I
 333 ></TT
 334 >]</P
 335 >
 336         </B
 337 ></DT
 338 ><DD
 339 ><P
 340 >Declare a new SGML package.</P
 341 ></DD
 342 ><DT
 343 ><B
 344 >          <P
 345 >[<TT
 346 CLASS="OPTION"
 347 >-r</TT
 348 > <TT
 349 CLASS="REPLACEABLE"
 350 ><I
 351 >centralized</I
 352 ></TT
 353 > <TT
 354 CLASS="REPLACEABLE"
 355 ><I
 356 >ordinary</I
 357 ></TT
 358 > | <TT
 359 CLASS="OPTION"
 360 >--remove</TT
 361 > <TT
 362 CLASS="REPLACEABLE"
 363 ><I
 364 >centralized</I
 365 ></TT
 366 > <TT
 367 CLASS="REPLACEABLE"
 368 ><I
 369 >ordinary</I
 370 ></TT
 371 >]</P
 372 >
 373         </B
 374 ></DT
 375 ><DD
 376 ><P
 377 >Remove a previously installed SGML package.</P
 378 ></DD
 379 ><DT
 380 ><B
 381 >          <P
 382 >[<TT
 383 CLASS="OPTION"
 384 >-h</TT
 385 > | <TT
 386 CLASS="OPTION"
 387 >--help</TT
 388 >]</P
 389 >
 390         </B
 391 ></DT
 392 ><DD
 393 ><P
 394 >Print a short help message and exit</P
 395 ></DD
 396 ><DT
 397 ><B
 398 >          <P
 399 >[<TT
 400 CLASS="OPTION"
 401 >-v</TT
 402 > | <TT
 403 CLASS="OPTION"
 404 >--version</TT
 405 >]</P
 406 >
 407         </B
 408 ></DT
 409 ><DD
 410 ><P
 411 >Print the version identifier and exit</P
 412 ></DD
 413 ></DL
 414 ></DIV
 415 ></DIV
 416 ><DIV
 417 CLASS="REFSECT1"
 418 ><A
 419 NAME="AEN163"
 420 ></A
 421 ><H2
 422 >Files</H2
 423 ><DIV
 424 CLASS="GLOSSLIST"
 425 ><DL
 426 ><DT
 427 ><B
 428 >          <TT
 429 CLASS="FILENAME"
 430 >/etc/sgml/*</TT
 431 >
 432         </B
 433 ></DT
 434 ><DD
 435 ><P
 436 >The SGML centralized catalogs</P
 437 ></DD
 438 ></DL
 439 ></DIV
 440 ></DIV
 441 ><DIV
 442 CLASS="REFSECT1"
 443 ><A
 444 NAME="AEN171"
 445 ></A
 446 ><H2
 447 >Authors</H2
 448 ><DIV
 449 CLASS="GLOSSLIST"
 450 ><DL
 451 ><DT
 452 ><B
 453 >          Eric Bischoff <TT
 454 CLASS="EMAIL"
 455 >&#60;<A
 456 HREF="mailto:ebisch@cybercable.tm.fr"
 457 >ebisch@cybercable.tm.fr</A
 458 >&#62;</TT
 459 >
 460         </B
 461 ></DT
 462 ><DD
 463 ><P
 464 >Developper of install-catalog.</P
 465 ></DD
 466 ></DL
 467 ></DIV
 468 ></DIV
 469 ><DIV
 470 CLASS="REFSECT1"
 471 ><A
 472 NAME="AEN179"
 473 ></A
 474 ><H2
 475 >See Also</H2
 476 ><DIV
 477 CLASS="GLOSSLIST"
 478 ><DL
 479 ><DT
 480 ><B
 481 >          <SPAN
 482 CLASS="CITEREFENTRY"
 483 ><SPAN
 484 CLASS="REFENTRYTITLE"
 485 >jw</SPAN
 486 >(1)</SPAN
 487 >
 488         </B
 489 ></DT
 490 ><DD
 491 ><P
 492 >conversion from DocBook to other file formats
 493           </P
 494 ></DD
 495 ><DT
 496 ><B
 497 ><P
 498 ><B
 499 CLASS="COMMAND"
 500 ></B
 501 > </P
 502 >
 503           <SPAN
 504 CLASS="CITEREFENTRY"
 505 ><SPAN
 506 CLASS="REFENTRYTITLE"
 507 >nsgmls</SPAN
 508 >(1)</SPAN
 509 >
 510         </B
 511 ></DT
 512 ><DD
 513 ><P
 514 >a base component of <SPAN
 515 CLASS="APPLICATION"
 516 >Jade</SPAN
 517 > DSSSL engine
 518           </P
 519 ></DD
 520 ><DT
 521 ><B
 522 ><P
 523 ><B
 524 CLASS="COMMAND"
 525 ></B
 526 > </P
 527 >
 528           <A
 529 HREF="http://sourceware.cygnus.com/docbook-tools/"
 530 TARGET="_top"
 531 >http://sourceware.cygnus.com/docbook-tools/</A
 532 ></B
 533 ></DT
 534 ><DD
 535 ><P
 536 >the home page of the DocBook tools, a compendium of
 537           all tools necessary to process DocBook files, including
 538           the SGML-common stuff.
 539           </P
 540 ></DD
 541 ></DL
 542 ></DIV
 543 ></DIV
 544 ><DIV
 545 CLASS="NAVFOOTER"
 546 ><HR
 547 ALIGN="LEFT"
 548 WIDTH="100%"><TABLE
 549 WIDTH="100%"
 550 BORDER="0"
 551 CELLPADDING="0"
 552 CELLSPACING="0"
 553 ><TR
 554 ><TD
 555 WIDTH="33%"
 556 ALIGN="left"
 557 VALIGN="top"
 558 ><A
 559 HREF="introduction.html"
 560 >Prev</A
 561 ></TD
 562 ><TD
 563 WIDTH="34%"
 564 ALIGN="center"
 565 VALIGN="top"
 566 ><A
 567 HREF="index.html"
 568 >Home</A
 569 ></TD
 570 ><TD
 571 WIDTH="33%"
 572 ALIGN="right"
 573 VALIGN="top"
 574 ><A
 575 HREF="fdl.html"
 576 >Next</A
 577 ></TD
 578 ></TR
 579 ><TR
 580 ><TD
 581 WIDTH="33%"
 582 ALIGN="left"
 583 VALIGN="top"
 584 >Introduction</TD
 585 ><TD
 586 WIDTH="34%"
 587 ALIGN="center"
 588 VALIGN="top"
 589 ><A
 590 HREF="introduction.html"
 591 >Up</A
 592 ></TD
 593 ><TD
 594 WIDTH="33%"
 595 ALIGN="right"
 596 VALIGN="top"
 597 >GNU Free Documentation License</TD
 598 ></TR
 599 ></TABLE
 600 ></DIV
 601 ></BODY
 602 ></HTML
 603 >