Manual Pages for UNIX Operating System command usage for man scrollkeeper-extract

User Commands                               scrollkeeper-devel(1)



NAME
     scrollkeeper-devel, scrollkeeper-extract,  scrollkeeper-gen-
     seriesid,  scrollkeeper-preinstall  -  utilities for working
     with OMF documents and the scrollkeeper database

SYNOPSIS
     scrollkeeper-extract file stylesheet output [stylesheet out-
     put...]

     scrollkeeper-gen-seriesid

     scrollkeeper-preinstall docfile omf-file1 omf-file2

DESCRIPTION
     scrollkeeper-extract is used internally by  scrollkeeper  to
     convert  DocBook/SGML  files  to Docbook/XML files if neces-
     sary, and to apply a number of transformations  to  the  XML
     file to extract information from the XML file.

     scrollkeeper-gen-seriesid generates a globally unique series
     ID for an OMF file.

     scrollkeeper-preinstall reads  omf_file1,  changes  the  URL
     attribute  of  the identifier tag to doc_file and writes the
     output to omf_file2.  scrollkeeper-preinstall  can  be  used
     during  the document installation process to point OMF files
     to the correct location on the target machine before  regis-
     tration in the scrollkeeper database.

OPTIONS
     None.

OPERANDS
     The following operands are supported:

     docfile         Specifies the file path to the document that
                     omf-file1 describes.



     file            Specifies the XML file that is to be used as
                     input for XSLT transformations.



     omf-file1       Specifies the OMF file that  contains  meta-
                     data for docfile.



     omf-file2       Specifies the file created by  scrollkeeper-
                     preinstall,  which contains the same data as



SunOS 5.11          Last change: 01 Apr 2003                    1






User Commands                               scrollkeeper-devel(1)



                     omf-file1 except that the URL  attribute  of
                     the identifier tag is changed to docfile.



     output          Specifies the file that contains the  result
                     when   the  preceding  stylesheet  has  been
                     applied to file.



     stylesheet      Specifies an XSLT transformation to apply.



EXAMPLES
     Example 1: Creating a New scrollkeeper Series ID

     example% scrollkeeper-gen-seriesid

     Example 2: Extracting a TOC From a Document

     example% scrollkeeper-extract /path/to/xml/file.xml /usr/share/scrollkeeper/stylesheets/toc.xsl /path/to/toc.xml

EXIT STATUS
     The following exit values are returned:

     0        Application exited successfully



     >0       Application exited with failure



FILES
     The following files are used by this application:

     /usr/bin/scrollkeeper-extract

         The command-line executable for the scrollkeeper-extract
         application.



     /usr/bin/scrollkeeper-gen-seriesid

         The command-line executable  for  the  scrollkeeper-gen-
         seriesid application.






SunOS 5.11          Last change: 01 Apr 2003                    2






User Commands                               scrollkeeper-devel(1)



     /usr/bin/scrollkeeper-preinstall

         The  command-line  executable  for   the   scrollkeeper-
         preinstall application.



ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Availability                | SUNWgnome-libs-devel        |
    |_____________________________|_____________________________|
    | Interface stability         | Obsolete                    |
    |_____________________________|_____________________________|


SEE ALSO
     scrollkeeper(1)

NOTES
     Written by Sander Vesik, Sun Microsystems Inc., 2003.

     Updated by Ghee Teo, Sun Microsystems Inc., 2007.




























SunOS 5.11          Last change: 01 Apr 2003                    3