Tour Formatter: user guide


                   Documentation team


                        ABSTRACT

              An  original manual showing how to
         explain a small command‐line program.


     1.  Purpose

          Tour Formatter is a fictional example used
     to teach documentation  structure.  Real  groff
     commands in this guide can format the source.

     2.  Getting started

          Save  this  document as manual.ms and com‐
     pile it with groff.

     groff ‐S ‐e ‐t ‐p ‐ms ‐Tpdf manual.ms > manual.pdf

     3.  Command usage

          The imaginary command accepts  one  source
     file and an optional device selection.

     tourfmt ‐T pdf input.ms

     4.  Configuration

     ┌────────────────────┐
     │ Setting    Default │
     │ device     pdf     │
     │ warnings   enabled │
     └────────────────────┘







                           ‐2‐            GRF‐12‐001
     5.  Troubleshooting

     Missing macro package
           Check  the  package  name  and  the local
           groff installation.

     Unexpected line break
           Look for a no‐fill display  or  a  forced
           break in the source.

     6.  Maintenance

          Keep  the  source, sample inputs and build
     command under version control. Inspect the gen‐
     erated output after a source change.
     GRF‐12‐001