Документ взят из кэша поисковой машины. Адрес оригинального документа : http://www.atnf.csiro.au/computing/software/gipsy/tsk/help.dc1 Дата изменения: Thu May 13 14:38:22 1993 Дата индексирования: Thu Jan 15 23:26:32 2009 Кодировка: Поисковые слова: ccd

Program: HELP

Purpose: Display purpose lines or categories or complete
documentation of tasks (subroutines and general
items). Data can be directed to printer also.

Category: UTILITY

File: help.c

Author: M. Vogelaar

Keywords:

[...] means: the default (pressing carriage return
if you are prompted with a keyword) is specified
between the brackets.


SUBJECT= Give number(s) of subject(s): [exit]

Give a number corresponding with one of the
following subjects:

1. GENERAL HELP ABOUT HERMES
2. GENERAL HELP ABOUT APPLICATIONS
3. GENERAL HELP ABOUT DOCUMENTATION
4. DISPLAY/PRINT DOCUMENTATION: TASKS/SUBROUTINES/GENERAL
5. DISPLAY/PRINT PURPOSE LINES OF TASKS etc.
6. SEARCH ON CATEGORY, DISPLAY/PRINT RESULT
7. QUESTIONS AND ANSWERS


SUBJECT=4, 5 or 6

DOCTYPE= Documentation: [1]=TASKS 2=SUBR 3=SUBR(low) 4=GENERAL
1 selects documentation about applications.
2 selects documentation about much used subroutines
3 selects documentation about low level subroutines
4 selects documentation about general items like
system management, input syntax, compilation etc.


SUBJECT=4:

DOCUMENT= Give name of doc. to print: [return to menu]
Send this document to a printer selected with
PRINTER=
The '*' character can be used as a wildcard, f.i.
DOCUMENT=*gauss* prints all documents with 'gauss'
in its name.
DOCUMENT= accepts up to 32 strings in one specification.


SUBJECT=5:

DOCUMENT= Give document(s) for purpose line: [return to menu]
Display purpose line(s) of selected tasks or
subroutines. The '*' character can be used as a
wildcard f.i. DOCUMENT=*gauss*
DOCUMENT= accepts up to 32 strings in one specification.


SUBJECT=6:

CATEGORY= Give name of category: [return to menu]
A list with categories known to the system
is displayed first. CATEGORY= is a name from this list.
Wildcards (= '*' character) can be used also.
Special cases:
CATEGORY=* will select all categories known to the
system.
CATEGORY=** will select all documentation whether
its category is known to the system or
not.

CATEGORY= accepts up to 32 strings in one specifi-
cation.

PRINTER= Give number of printer: [TO SCREEN]
A list with available printers is generated
If the number of a displayed printer is
selected, output is directed to that printer. The
default selection however is output to the screen.
The keyword can be changed just before any output.


Description: With the keyword SUBJECT= you can select one or more
subjects from the menu by specifying the corresponding
menu numbers. For the subjects 4, 5 and 6 the program
prompts you (DOCTYPE=) to give the document type.
This can be one of:

1) Application documentation,
2) Documentation about subroutines used in applications
3) Documentation about low level (system) subroutines
4) General documentation about input syntax, system
management, compilation, utilities, devices,
etc.

The default selection is documentation about tasks.

For the subjects 4 and 5 (print documentation and
purpose lines from documentation) a document name
is wanted. First a list is displayed with all available
documents of type DOCTYPE= A selection is made with
DOCUMENT= which accepts up to 32 document names. The
names can include the wildcard character '*'. For
instance DOCUMENT=*GAUSS* will select all files with
the name GAUSS included. The matching is case insensitive.
SUBJECT=6 allows you to find applications in a given
category. You specify the category name with CATEGORY=
All category lines in the documentation that include
your string will be listed together with program name
and purpose line. An asterisk can be used as wildcard
character to select your category (or categories).
If you want to select all documentation (discard cate-
gory) use: CATEGORY=**

Output for subjects 1 to 6 can be to a printer or
to screen. The selection is made with PRINTER=
after the printer menu is displayed.
Note that on different systems you can get different
printer options. PRINTER=0 always selects the screen
as output device. An example of a printer menu:

==============================PRINTERS=====================
nr name cols rows comment
===========================================================
0 To SCREEN only
1 l1psprinter 181 73 Printer in room ZG172
2 l2psprinter 181 73 Printer in room ZG172
3 p1psprinter 91 82 Printer in room ZG172
4 p2psprinter 91 82 Printer in room ZG172
5 lineprinter 132 60 Printer in room ZG170
6 landscape 132 60 Printer in room ZG172
7 portrait 96 60 Printer in room ZG172
===========================================================


Notes:

Example:

Updates: Aug 6, 1992: VOG, Document created.
Nov 2, 1992: VOG, Integrated PURPOSE in HELP.
Send documents to printer.