formatdoc(1)

PROGRAM
formatdoc - Format on-line documentation for Khoros

SYNTAX

formatdoc

-type
     :
     'doc' (Formats a single doc file and places the online document in the current directory),
     'alldoc' (Formats all doc files and places the online documents in the current directory),
     'help' (Formats a single help files and places the online document in the ./help directory),
      or 'allhelp' (Formats all help files and places the online documents in the ./help directory)

[-i]
    Input documentation file (for -type doc and -type help only)

[-V]
    Gives the version for formatdoc

[-U]
    Gives the usage for formatdoc

[-P]
    Prompts for command line options

[-A [file1]]
    Creates the answer file called formatdoc.ans or file1

[-a [file1]]
    Uses formatdoc.ans or file1 as the answer file

DESCRIPTION

formatdoc will format files for use in the Khoros on-line help. This program supports several modes as specified by the -type argument. Note, If the 'alldoc' or 'allhelp' is specified with the -type argument, the -i argument is ignored.

To use formatdoc, you must be in the directory where the *.doc files exist that need formatting The files to be formatted must end with the extension '.doc'. The resulting file(s) created by formatdoc will will have the same basename without the

formatdoc will include the file KHOROS_HOME/repos/utils/online.cpright at the end of the formatted file. This file is for the Khoros copyright notice.

If the -type argument is set to 'doc' or 'alldoc', then the result from formatdoc is placed in the current directory. If the -type argument is set to 'help' or 'allhelp', the result- ing file(s) from formatdoc are placed in a subdirectory called 'help'. Note, this subdirectory must exist in the current directory.

REQUIRED ARGUMENTS

-type
    type: string
    desc:
    allowed values:
     'doc' (Formats a single doc file and places the online document in the current directory),
     'alldoc' (Formats all doc files and places the online documents in the current directory),
     'help' (Formats a single help files and places the online document in the ./help directory),
      or 'allhelp' (Formats all help files and places the online documents in the ./help directory)

OPTIONAL ARGUMENTS

-i  type: string
    desc: Input documentation file (for -type doc and -type help only)
    default: null

EXAMPLES

% formatdoc -i Overview.doc -type doc

This will format the Overview.doc file and place the result Overview file in the current directory.

% formatdoc -type allhelp

This will format the *.doc files and place the resulting formatted files in the subdirectory ./help

SEE ALSO
intro(1), verror(3), vgparms(3), vutils(3)

RESTRICTIONS
formatdoc will ignore the -i argument if the -type argument is set to 'alldoc' or 'allhelp'.

COPYRIGHT
Copyright 1991, University of New Mexico. All rights reserved.