MOSD(7)                 COMMAND REFERENCE                 MOSD(7)



NAME
     mosd - the OSDD adapter macro package for formatting
     documents

     The osdd, mm, mmt, and troff commands are not supported for
     UTek workstations.

SYNOPSIS
     osdd [ options ] [ files ]
     mm -mosd [ options ] [ files ]
     nroff -mm -mosd [ options ] [ files ]
     nroff -cm -mosd [ options ] [ files ]
     mmt -mosd [ options ] [ files ]
     troff -mm -mosd [ options ] [ files ]

DESCRIPTION
     The OSDD adapter macro package is a tool used in conjunction
     with the MM macro package to prepare Operations Systems
     Deliverable Documentation.  Many of the OSDD Standards are
     different from the default format provided by MM. The OSDD
     adapter package sets the appropriate MM options for
     automatic production of the OSDD Standards.  The OSDD
     adapter package also generates the correct OSDD page headers
     and footers, heading styles, Table of Contents format, etc.

     OSDD document (input) files are prepared with the MM macros.
     Additional information which must be given at the beginning
     of the document file is specified by the following string
     definitions:

          .ds H1 document-number
          .ds H2 section-number
          .ds H3 issue-number
          .ds H4 date
          .ds H5 rating

     The document-number should be of the standard 10-character
     format.  The words ``Section'' and ``Issue'' should not be
     included in the string definitions; they will be supplied
     automatically when the document is printed.  For example:

          .ds H1 OPA-1P135-01
          .ds H2 4
          .ds H3 2

     automatically produces:

          OPA-1P135-01
          Section 4
          Issue 2





Printed 3/13/89                                                 1

MOSD(7)                 COMMAND REFERENCE                 MOSD(7)



     as the document page header.  Quotation marks are not used
     in string definitions.

     If certain information is not to be included in a page
     header, then the string is defined as null; e.g.,

          .ds H2

     means that there is no section-number.

     The OSDD Standards require that the Table of Contents be
     numbered beginning with Page 1.  By default, the first page
     of text will be numbered Page 2.  If the Table of Contents
     has more than one page, for example n, then either -rPn+1
     must be included as a command line option or .nr P n must be
     included in the document file.  For example, if the Table of
     Contents is four pages then use -rP5 on the command line or
     .nr P 4 in the document file.

     The OSDD Standards require that certain information such as
     the document rating appear on the Document Index or on the
     Table of Contents page if there is no index.  By default, it
     is assumed that an index has been prepared separately.  If
     there is no index, the following must be included in the
     document file:

          .nr Di 0

     This will ensure that the necessary information is included
     on the Table of Contents page.

     The OSDD Standards require that all numbered figures be
     placed at the end of the document.  The .Fg macro is used to
     produce full page figures.  This macro produces a blank page
     with the appropriate header, footer, and figure caption.
     Insertion of the actual figure on the page is a manual
     operation.  The macro usage is:

          .Fg page-count "figure caption"

     where page-count is the number of pages required for a
     multi-page figure (default 1 page).

     The .Fg macro cannot be used within the document unless the
     final .Fg in a series of figures is followed by a .SK macro
     to force out the last figure page.

     The Table of Contents for OSDD documents (see Figure 4 in
     Section 4.1 of the OSDD Standards) is produced with:

          .Tc
          System Type



Printed 3/13/89                                                 2

MOSD(7)                 COMMAND REFERENCE                 MOSD(7)



          System Name
          Document Type
          .Td

     The .Tc/.Td macros are used instead of the .TC macro from
     MM.

     The .PM macro may be used to generate proprietary markings -
     see the MM document for legal styles.

     The .P macro is used for paragraphs.  The Np register is set
     automatically to indicate the paragraph numbering style.  It
     is very important that the .P macro be used correctly.  All
     paragraphs (including those immediately following a .H
     macro) must use a .P macro.  Unless there is a .P macro,
     there will not be a number generated for the paragraph.
     Similarly, the .P macro should not be used for text which is
     not a paragraph.  The .SP macro may be appropriate for these
     cases, e.g., for ``paragraphs'' within a list item.

     The page header format is produced automatically in
     accordance with the OSDD Standards.  The OSDD Adapter macro
     package uses the .TP macro for this purpose.  Therefore the
     .TP macro normally available in MM is not available for
     users.

FILES
     /usr/lib/tmac/tmac.osd

     /usr/lib/macros/osdd

SEE ALSO
     nroff(1).






















Printed 3/13/89                                                 3

%%index%%
na:240,349;
sy:589,904;
de:1493,1425;3230,2628;6170,1425;
fi:7595,178;
se:7773,125;
%%index%%000000000117