1 08/07/86 where_doc, wdoc
2
3 Syntax as a command: wdoc topic_name -control_args
4
5
6 Function: returns the names of manuals that contain information about
7 the specified topic name.
8
9
10 Arguments:
11 topic_name
12 is the name of a topic, command, subroutine, or I/O module. Use
13 iteration to get more than one topic.
14
15
16 Control arguments:
17 -all, -a
18 prints all the sections of manual information.
19 -allow_partial_matches, -apm
20 searches for a partial match of the topic name if an exact match is
21 not found.
22 -audience, -aud
23 describes the audience for which the manual is intended.
24 -database_pathname PATH, -dbpn PATH
25 specifies the pathname of the data base you want instead of the
26 default one. Once you supply -database_pathname, the specified data
27 base is used for all subsequent invocations of where_doc during your
28 process until you select another data base.
29
30
31 -description, -desc
32 returns a brief description of the manual's contents.
33 Default
34 -dont_allow_partial_matches, -dapm
35 does not allow partial matches. Default
36 -new_features, -nf
37 lists all new features that have been added to the manual with the
38 last update revision or addendum.
39 -no_audience, -no_aud
40 does not describe the manual's intended audience. Default
41 -no_description, -no_desc
42 suppresses printing of the brief description of the manual's
43 contents.
44 -no_new_features, -no_nf
45 does not list new features. Default
46
47
48 -no_table_of_contents, -no_toc
49 does not print the manual's table of contents. Default
50 -output_file PATH, -of PATH
51 directs the output to a file instead of to your terminal.
52 -table_of_contents, -toc
53 prints the manual's table of contents.
54
55
56 Notes: If you can't find a match for topic_name and didn't select
57 -allow_partial_matches or -dont_allow_partial_matches, you are asked
58 whether or not you want where_doc to search for partial matches.
59
60 When you use a control argument giving additional information about the
61 manuals found e.g. -audience or -table_of_contents and where_doc
62 finds more than one manual with information about the topic_name, a
63 menu containing the names of the manuals is displayed. You can then
64 choose to see the information on one or more of the manuals listed or
65 return to command level.