Provided by: yodl_1.31.18-7_i386 bug

NAME

       yodlmanpage - the manpage document type of Yodl

SYNOPSIS

       The  yodlmanpage  document  type  is  specifically implemented to write
       Unix-style manual pages. Other Yodl document formats, such as  article,
       report and book are documented in the Yodl guide and in the manpage for
       yodlmacros.

DESCRIPTION

       This manual page briefly describes the manpage  document  type  of  the
       YOLD  document  language.  This  document  type  is so specific that it
       warrants a separate manpage.

       manpage documents do not use the ‘standard´ sectioning commands  (e.g.,
       sect()  and subsect()), but have specific manpage...() macros.  You can
       however use (and are encouraged to..) other ‘normal´  macros,  such  as
       description(...)  or  itemize(...)  for lists, or bf() for boldface and
       em() for emphasis. As for fonts, the following is suggested:

       o      Use em(text) when text is a variable, or a placeholder, etc..

       o      Use bf(text)  when  text  is  literal,  such  as  a  command,  a
              filename, a directory.

       Each manpage document in Yodl must be organized as follows:

       o      manpage(name)  (section)  (date) (package) (source): This is the
              preamble of the document. It states whatever the page describes,
              the section where it belongs, the release date, the package that
              it belongs to, and the  source  of  the  package.   The  section
              number  should be (according to the Linux manpage on man): 1 for
              commands, 2 for system calls, 3 for library calls, 4 for special
              files, 5 for file formats, 6 for games, 7 for macro packages and
              conventions, 8 for system management commands, and 9  for  other
              special subjects (e.g., kernel commands).

       o      manpagename(name)   (short  description):   The  name  is  again
              whatever is described, the short description is what  e.g.,  the
              whatis database uses for descriptions.

       o      manpagesynopsis():  a very short ‘usage´ information or similar.
              Keep this section short, e.g., a line with all  program  options
              is acceptable but without descriptions (these come later).

       o      manpagedescription(): the purpose of the program and such.  This
              is also the place to document the workings.

       o      manpageoptions(): This is the place to document e.g.  the  flags
              that  are  stated  in  the  manpagesynopsis().  This  section is
              optional, but when present, must appear at this place.

       o      manpagefiles(): relevant files are described in this section.

       o      manpageseealso(): this section lists related manual pages.

       o      manpagediagnostics(): Error conditions, error messages, etc..

       o      manpagebugs(): This is where  known  bugs  are  described.  This
              section is optional.

       o      manpageauthor(): stating the author and/or the maintainer.

       o      manpagesection(NAME):  This macro starts a generic, non-required
              section. E.g., you might want a manpagesection(EXAMPLES) in your
              document.  As  a  typographic suggestion, use upper case for the
              NAME argument for consistency reasons.

FILES

       The ‘normal´ files of  the  Yodl  package  are  relevant,  notably  the
       macrofiles in /home/fred/usr/share/yodl.

SEE ALSO

       o      yodl(1): the first step converter.

       o      yodlmacros(7):   short   description   of   the  macros  of  the
              converters.

       o      yodlconverters(1): the various converters.

DIAGNOSTICS

       o      The manpage...() macros must appear in the exact order as listed
              above.

       o      All  manpage...()  macros  must appear exactly once in a manpage
              document.

       When these requirements are not met, the yodl2... converters abort.

AUTHOR

       Please consult the documentation file  AUTHORS.txt  for  more  detailed
       information, and small contributions.

       o      Karel                  Kubat                 <karel@icce.rug.nl>
              http://www.icce.rug.nl/karel/karel.html

       o      Jan               Nieuwenhuizen                <janneke@gnu.org>
              http://www.xs4all.nl/~jantien