helppage(1)

PROGRAM
helppage - A utility for Updating/Creating Help Pages for Cantata.

SYNTAX

helppage

-------------------------------

-i  input Man (1) file
    -OR-

-all
    Format All Man (1) pages
    -------------------------------

[-toolbox]
    Toolbox name

[-V]
    Gives the version for helppage

[-U]
    Gives the usage for helppage

[-P]
    Prompts for command line options

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

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

DESCRIPTION
helppage is a program for updating/creating Help pages for Cantata. This program calls a csh shell script "helppage_csh" that performs the updating/creating of the help pages for Cantata. The C driver accepts either a filename for a Man (1) page, or a boolean specifying whether to format ALL Man (1) pages. Note that the -i and -all arguments are mutually exclusive. If desired, only one man page will be formatted or alternatively all man pages will be formatted.

An optional toolbox may be specified with the "-toolbox" option. The "-toolbox" option specifies which toolbox you are working with. If you are working in KHOROS_HOME, do not specify a toolbox. Each toolbox has the mach file This mach file specifies the information required by all of the khoros tools concerning the particular toolbox environment. The LOCAL_SRC_TOP field in the mach file must be set.

For more information on toolboxes and mach files, consult Volume 2 Chapter 1 and Chapter 9 of the Khoros manual.

REQUIRED ARGUMENTS

*** These arguments are MUTUALLY EXCLUSIVE ***
       You MUST provide ONE AND ONLY ONE of:

-i  type: infile
    desc: input Man (1) file

-all
    type: boolean
    desc: Format All Man (1) pages

Default argument of mutually exclusive group: -i
********

OPTIONAL ARGUMENTS

-toolbox
    type: string
    desc: Toolbox name
    default: null

EXAMPLES

helppage -i myfile.1 -toolbox medic_toolbox

This will update the man page, "myfile.1" for Cantata.

helppage -all 1 -toolbox medic_toolbox

This will update All of the man (1) pages in the toolbox "medic_toolbox" for Cantata Help,

SEE ALSO
intro(1), verror(3), vgparms(3), vutils(3) ghostwriter(1), intro(1), ghostreader(1), ghostcheck(1)

RESTRICTIONS

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