VMS Help RUNOFF, /CONTENTS  *Conan The Librarian (sorry for the slow response - running on an old VAX)

    Invokes the DIGITAL Standard Runoff (DSR) Table of Contents
    utility to create an .RNT file that can be processed by DSR to
    make a table of contents. The input file for this command is
    an intermediate binary file (.BRN) that is produced with the
    RUNOFF command and the /INTERMEDIATE qualifier. Qualifiers to
    this command allow you to specify the following characteristics
    for table of contents entries:

    o  Using boldface type or underlining for entries

    o  Deepest header level to be included

    o  Running page numbers or chapter-oriented page numbers

    o  Displaying or not displaying section numbers

    For a complete description of the DSR Table of Contents utility,
    see the OpenVMS DIGITAL Standard Runoff Reference Manual.

    Format

      RUNOFF/CONTENTS  filespec[,...] or filespec[+...]

1 - Parameter

 filespec[,...] or filespec[+...]

    Specifies one or more intermediate binary files (.BRN) that
    contain information (chapter titles, header levels, sections,
    and so on) for making a table of contents. To create a .BRN file,
    use the RUNOFF command with the /INTERMEDIATE qualifier. See
    the RUNOFF command for more information on the /INTERMEDIATE
    qualifier.

    If you omit the input file type, the DSR Table of Contents
    utility uses a default file type of .BRN. The RUNOFF/CONTENTS
    command also processes BTC files that the previous version of DSR
    produced.

    For single input files, the DSR Table of Contents utility
    produces an output file with the same file name as the input
    file. The output file type is .RNT.

    If you separate multiple input files with commas (,),  separate
    .RNT files for each input file are created. If you separate
    multiple input files with plus signs (+),  a single .RNT file
    that contains table of contents information for all of the input
    files is created. The default output file name is the same as the
    first input file name; the default file type is .RNT. Wildcard
    characters are not allowed in the file specification.

2 - Qualifiers

 2.1 - /BOLD

       /BOLD
       /NOBOLD (default)

    Controls whether the boldface type specified in chapter and
    header titles in the input file appears in the table of contents.

    If you specify the /BOLD qualifier, the text flagged for boldface
    type in the body of the document is marked for overprinting in
    the finished table of contents.

    If you specify the /NOBOLD qualifier, the text flagged for
    boldface type in the document is not overprinted in the table
    of contents.

 2.2 - /DEEPEST_HEADER

       /DEEPEST_HEADER=n

    Controls how many levels of header levels are output in the table
    of contents. You can specify any number of header levels (up to
    six) to be displayed by changing the value of n.

    The default is /DEEPEST_HEADER=6.

 2.3 - /IDENTIFICATION

       /IDENTIFICATION
       /NOIDENTIFICATION (default)

    Controls whether the current version number of the DSR table of
    contents utility is reported.

 2.4 - /INDENT

       /INDENT
       /NOINDENT (default)

    Controls how many spaces the header levels after level 1 are
    indented in the table of contents.

    If you omit this qualifier, or if you specify the /NOINDENT
    qualifier, all header levels after header level 1 are indented
    2 spaces.

    If you specify the /INDENT qualifier, each header level after
    header level 1 is indented 2 spaces beyond the preceding header
    level.

 2.5 - /LOG

       /LOG
       /NOLOG (default)

    Controls whether the DSR Table of Contents utility displays
    the name of each input file as it is processed and after it
    is processed. The name of each output file created may also be
    displayed. If there are any errors in processing, the DSR Table
    of Contents utility sends messages to the terminal even if the
    /NOLOG qualifier is in effect.

 2.6 - /OUTPUT

       /OUTPUT[=filespec]
       /NOOUTPUT

    Specifies that an output file is to be produced and optionally
    names it. If you specify the /OUTPUT qualifier without a file
    specification, or if you omit the qualifier entirely, the output
    file name matches the input file name. The default file type is
    .RNT.

    You can change the name of the output file by supplying a file
    specification for the value filespec.

    The /NOOUTPUT qualifier suppresses the creation of an output
    file. You can use the /NOOUTPUT qualifier to check an input file
    for errors without using system resources to generate an output
    file.

 2.7 - /PAGE_NUMBERS

       /PAGE_NUMBERS=(option[,...])

    Controls whether the page number references in the table of
    contents are running page numbers or chapter-oriented page
    numbers; also controls how many levels of headers have page
    references listed in the table of contents. You can specify the
    following options:

    o  LEVEL=n

       Specifies that header levels up to and including header level
       n have page numbers listed in the table of contents. The
       default is to display page numbers for six levels of headers.

    o  NORUNNING

       Specifies chapter-oriented page numbers (such as 1-3, 10-42).
       You can specify chapter-oriented numbers for the table of
       contents even if the document does not have chapter-oriented
       numbers. NORUNNING is the default.

    o  RUNNING

       Specifies running page numbers (such as 3, 42). You can
       specify running page numbers for the table of contents even
       if the document does not have running page numbers.

    If you supply more than one option, separate them with commas and
    enclose the list in parentheses.

 2.8 - /REQUIRE

       /REQUIRE=filespec
       /NOREQUIRE (default)

    Allows you to change or delete the heading on the first page of
    a table of contents. The default heading is the word CONTENTS
    centered on the page and followed by one blank line. You can
    either substitute another word as a heading, or have no heading.

    To change the heading, do one of the following:

    o  If you do not want any heading, specify a null file as the
       file specification for /REQUIRE.

       $ RUNOFF/CONTENTS/REQUIRE=nl:

    o  If you want to use a different heading, create or edit a
       file that specifies the heading that you want. Use the file
       that you create as the file specification for the /REQUIRE
       qualifier.

    When you use the /REQUIRE qualifier, the default heading for the
    first page of the contents is not generated. The file that you
    are "requiring" must provide the heading. The file can contain
    both DSR commands that change the format of the first page and
    the text that you want to appear at the top of the page. Or the
    file can contain only DSR commands to format the first page of
    the contents. For example, you can put the command .FIGURE 10
    in the file. This command generates 10 blank lines at the top of
    the first page of the table of contents. You can use these blank
    lines for later pasteup.

 2.9 - /SECTION_NUMBERS

       /SECTION_NUMBERS (default)
       /NOSECTION_NUMBERS

    Controls whether the DSR Table of Contents utility displays
    section numbers in the table of contents. The /SECTION_NUMBERS
    qualifier displays section numbers for all header levels in the
    table of contents. The /NOSECTION_NUMBERS qualifier suppresses
    the display of section numbers for all header levels.

 2.10 - /UNDERLINE

       /UNDERLINE
       /NOUNDERLINE (default)

    Controls whether the underlining specified in chapter and header
    titles in the input file appears in the table of contents.

    If you specify the /UNDERLINE qualifier, the text flagged for
    underlining in the body of the document is underlined in the
    table of contents.

    If you specify the /NOUNDERLINE qualifier, the text flagged for
    underlining in the body of the document is not underlined in the
    table of contents.

3 - Examples

    1.$  RUNOFF/INTERMEDIATE CHPT1,CHPT2,CHPT3

      Before using the RUNOFF/CONTENTS command, you must use the
      RUNOFF/INTERMEDIATE command to create a .BRN file as input for
      the DSR Table of Contents utility. The command line in this
      example creates three separate files: CHPT1.BRN, CHPT2.BRN, and
      CHPT3.BRN.

    2.$  RUNOFF/CONTENTS CHPT1.BRN

      In this example, the RUNOFF/CONTENTS command takes the file
      CHPT1.BRN as input and creates CHPT1.RNT, which can be
      processed by DSR to produce a final table of contents for
      Chapter 1.

    3.$  RUNOFF/CONTENTS/INDENT/NOSECTION_NUMBERS CHPT2

      The command in this example takes the file CHPT2.BRN as input
      and creates CHPT2.RNT. When processed with the RUNOFF command,
      the .RNT file will produce a table of contents in which each
      header level after header level 1 is indented 2 spaces beyond
      the preceding header level. The table of contents will not have
      section numbers listed. See the following example for a sample
      command line for processing .RNT files.

    4.$  RUNOFF/LOG CHPT2.RNT

      The command in this example produces CHPT2.MEC, which is a
      formatted table of contents. You can use the TYPE or the PRINT
      command to view the table of contents.