1 :Info: help: 2020-10-23 help
2
3 Syntax as a command: help INFO_NAMEs -control_args
4
5
6 Function: the help subsystem prints descriptions of system commands,
7 active functions, and subroutines; as well as miscellaneous
8 information about system status, system changes, and general
9 information.
10
11 The help command gets the information it displays from info segments,
12 each containing one or more blocks of information, divided into named
13 sections. Each section holds one or more paragraphs of information.
14 It displays the information one page at a time. At the end of each
15 page, help gives a list of section titles that follow and asks if the
16 user wants "More help?". For a list of responses, type:
17 help help_responses
18 or at a "More help?" prompt, type:
19 help
20
21
22 Arguments selecting info segments:
23 INFO_NAMEs
24 select an info seg having an entryname matching one of the given
25 INFO_NAMEs. The suffix ".info" is assumed if not given. If a
26 pathname is given, only an info seg in that directory is selected.
27 If only an entryname is given, help looks in the "info_segments"
28 search list for a segment with matching INFO_NAME.
29
30 When selecting an info seg describing a subroutine, an entry point
31 name may be included in the INFO_NAME: help hcs_$status
32 Printing begins with the description of that entry point.
33
34
35 The star convention is allowed, except when INFO_NAME includes a
36 subroutine entry point name, or when the -entry_point is given.
37
38 If no INFO_NAME is given, help prints the default info seg
39 help_system.gi.info which gives a brief introduction to the help
40 subsystem.
41
42
43 Control arguments selecting info segments:
44 The -section and -search controls select info segs for display: an
45 info seg matching INFO_NAME must also contain a paragraph matching
46 one of the STR strings below. Display begins at that matching
47 paragraph.
48 -section STRs, -scn STRs
49 selects the first section of the info seg whose title contains one
50 of the STR strings. The entire section title is not required.
51 STRs may be typed in lowercase; by default, case is ignored when
52 matching. All arguments following the -section control argument
53 until the next control argument are treated as STRs.
54
55
56 -search STRs, -srh STRs
57 selects the first paragraph of the info seg containing any of the
58 STR strings. These may be typed in lowercase; by default, case is
59 ignored when matching. All arguments following the -search control
60 argument are treated as STRs, so -search must be the last control
61 argument given. The search usually begins with the first
62 paragraph; if -section is also specified, searching begins with the
63 matching section and continues to the last paragraph of the info
64 block.
65
66
67 -case_sensitive, -cs
68 when used with either -section of -search, will perform the
69 requested action in a case sensitive manner.
70 -non_case_sensitive, -ncs
71 when used with either -section or -search, will perform the
72 requested action in a non-case sensitive manner. This is the
73 default.
74
75
76 -pathname INFO_PATH, -pn INFO_PATH
77 specifies the pathname of an info segment to be printed. It is
78 useful when the info to be printed is in the working directory, or
79 if the pathname begins with a minus - character. The final
80 entryname of INFO_PATH is treated as the INFO_NAME.
81 -entry_point, -ep
82 selects the info describing the main entry point of a subroutine,
83 if there is one. For example, "help ioa_ -ep" prints the info
84 describing the ioa_$ioa_ subroutine entry point.
85 -info BLOCK_NAME
86 within an info seg selected by INFO_NAME, actually select a block
87 designated by :Info: BLOCK_NAME: where BLOCK_NAME.info does not
88 appear as an entryname on the info segment. This is useful for
89 displaying a subsystem's request descriptions.
90
91
92 Control arguments info displayed:
93 -all, -a
94 prints the entire info or subroutine entry point description
95 without intervening questions. If used with only a subroutine
96 reference name, help prints the subroutine introduction and all of
97 its entry points.
98 -brief, -bf
99 prints only a brief summary of a command, active function or
100 subroutine info seg with no intervening questions. The summary
101 includes the Syntax section, and names of "Arguments",
102 "Control arguments" and "List of ..." items.
103 -brief_header, -bfhe
104 displays only a short header introducing the info seg: the heading
105 line from the info seg; and its line count.
106
107
108 -control_arg STRs, -ca STRs
109 prints only the descriptions of the control or other arguments
110 whose names contain STR. STR must NOT include a leading minus sign
111 -. For example, "help mail -ca brief match exclude" prints
112 descriptions of the -brief, -match and -exclude control arguments
113 of the mail command. All arguments following -ca until the next
114 control argument are treated as STR operands.
115 -header, -he
116 prints only a long heading line consisting of the pathname of the
117 info seg, heading line from the info seg, and its line count. No
118 other information is printed. This control argument conflicts with
119 all other information display control arguments.
120
121
122 -list_entry_points, -lep
123 names all entry points in a subroutine info segment, then prompts
124 about sections in the subroutine's introduction. The entry_point
125 response may be used to select a particular entry point for
126 display. For example, to display the pathname_$component entry
127 point, respond to the prompt with: ep component
128 -titles, -title
129 lists the section titles used in the info seg including section
130 line counts, then asks if the user wishes to see the first section.
131
132
133 Control arguments paragraph grouping:
134 -maxlines J
135 sets the maximum paragraph grouping size to J lines. J or fewer
136 lines of information are printed before asking if the user wants
137 more help. Default is the terminal's page length.
138
139
140 Notes on control arguments:
141 The -all, -brief, -control_arg and -title control arguments are
142 mutually exclusive.
143
144
145 When -section or -search control arguments are specified and no
146 matching paragraph is found in any info seg selected by an INFO_NAME
147 or info selection control argument, that info seg is skipped without
148 comment.
149
150 Also, -section and -search do not always control where printing
151 starts.
152
153 If used with -header, only the heading lines for infos containing a
154 matching paragraph are listed; the matching paragraph is not
155 printed.
156
157 If used with -brief or -control_arg, help prints a heading line and
158 then the information selected by -brief or -control_arg; the
159 matching paragraph is not printed.
160
161
162 If used with -brief_header, a brief heading line is printed
163 preceding the matching paragraph.
164
165 When used with -title, help prints a heading line, then the list of
166 section titles, and finally the matching paragraph.
167
168 If used with -all, the entire info is printed for infos containing a
169 matching paragraph.
170
171
172 Notes on info segments:
173 Help gets the information it displays from segments formatted as an
174 "info segment". Each info seg contains one or more blocks of
175 information, divided into named sections. Each section holds one or
176 more paragraphs of information.
177
178 An information block describes a command, subroutine entry point, or
179 other information topic.
180
181 For information about the format of an info seg, type:
182 help info_seg.gi
183
184
185 Notes on help operation:
186 The help command displays information from info segments, each
187 containing one or more blocks of information, divided into named
188 sections. Each section holds one or more paragraphs of information.
189
190 Information is displayed one page at a time. At the end of each
191 page, help gives a list of section titles that follow and asks if the
192 user wants "More help?". For a list of possible responses, type:
193 help help_responses
194 or
195 help hr
196
197
198 The help command remembers which paragraphs the user has seen and
199 which have been skipped or not yet reached. It automatically stops
200 printing an info block if all paragraphs have been seen when reaching
201 the end of the info block.
202
203
204 If any paragraphs were skipped, help enters an unseen_paragraphs_only
205 mode of operation, asking if groups of adjacent unseen paragraphs
206 should be printed. Typical responses when in unseen_paragraphs_only
207 mode are:
208
209 yes, y
210 print the next group of unseen paragraphs.
211 rest -unseen, rest
212 print all remaining unseen paragraphs.
213 titles -unseen, titles
214 print section titles for all sections containing an unseen
215 paragraph.
216 section STR, scn STR
217 select which section containing unseen paragraphs to display from
218 sections listed by: titles -unseen
219
220
221 The user may enter unseen_paragraphs_only mode at any time by typing
222 one of the responses: unseen_paragraphs_only, unseen, uns
223
224
225 Notes on help-related commands:
226 If the help command fails to find an info seg corresponding to a given
227 INFO_NAME, search for the correct name using:
228
229 list_help TOPIC
230
231 list_help lh displays the names of info segs having a given TOPIC
232 string anywhere in its entryname. For details, type: help lh
233
234
235 Use the check_info_segs cis command to locate info segments changed
236 recently. For details, type: help cis
237
238
239 :Info: help_responses.gi: help_responses: hr.gi: hr:
240 2020-10-27 Responses to help's "More help?"
241
242 The help command displays information from info segments, each
243 containing one or more blocks of information, divided into named
244 sections. Each section holds one or more paragraphs of information.
245
246 Information is displayed one page at a time. At the end of each page,
247 help gives a list of section titles that follow and asks if the user
248 wants "More help?". The user may give one of the following responses.
249
250
251 List of responses all info segments:
252 As help prints a paragraph of information, it marks that paragraph
253 as "seen by the user". Several responses include options to skip
254 seen paragraphs, or to check for unseen paragraphs.
255
256 Responses that search the info segment or list section titles
257 operate from the current paragraph to the end of the information
258 block. Automatic wraparound searches are not used.
259
260 yes, y
261 prints paragraphs mentioned in the prompt, then displays section
262 titles of subsequent paragraphs, and prompts: More help?
263
264
265 rest -section | -unseen,
266 r -scn | -uns
267 prints the rest of the info block without intervening prompts.
268 Or if the -section control argument is given, prints only the
269 remaining paragraphs of the current section without prompts.
270 If -unseen is given, prints the remaining unseen paragraphs
271 in the information block.
272 skip -section | -seen | -rest,
273 s -scn | -seen | -rest
274 skips paragraphs mentioned in the prompt, and asks the user about
275 display of subsequent paragraphs in the block. If -section is
276 given, help skips only the paragraphs in the first section of the
277 prompt. If -seen is given, searches for and display the next
278 unseen paragraph. If -rest is given, skips to the end of the info
279 block, and then asks if unseen paragraphs should be displayed.
280
281
282 next, no, n
283 exits from the current information segment if more help is not
284 needed. If the help command INFO_NAMEs selected other segments,
285 help begins printing the next info segment; otherwise, help returns
286 to the command processor.
287 quit, q
288 causes help to return to the command processor without printing the
289 remaining info segs selected by the INFO_NAMEs.
290
291
292 brief, bf
293 prints a summary of a command, active function or subroutine info
294 seg including its Syntax section and names of "Arguments",
295 "Control arguments", and "List of ..." items.
296 control_arg STRs -case_sensitive,
297 ca STRs -cs
298 prints descriptions of "Arguments", "Control arguments" and
299 "List of ..." items whose names contain one of the STR strings.
300 Then repeats the previous "More help?" question. If STR is
301 omitted, the string used in the previous control_arg response or
302 help -control_arg control is used again.
303
304
305 titles -top | -unseen,
306 title -t | -uns
307 lists title and line count for all sections remaining in the current
308 info seg. If -top is given, help lists information for all
309 sections. If -unseen is given, help lists all titles containing
310 unseen paragraphs.
311
312
313 section STRs -case_sensitive -top,
314 scn STRs -cs -t
315 skips to the next section whose title contains STRs. The entire
316 section title is not required. STRs may be typed in lowercase;
317 -non_case_sensitive is the default when matching. If -top is
318 specified, title searching starts at the beginning of the info
319 block. If STR is omitted, help uses the search strings from the
320 previous section response or -section control argument.
321
322
323 search STRs -case_sensitive -top,
324 srh STRs -cs -t,
325 sh STRs -cs | -ncs -t
326 skips to the next paragraph containing one of the STR strings.
327 STRs may be typed in lowercase; -non_case_sensitive is the default
328 when searching. If -top is specified, searching starts at the
329 beginning of the info seg. If no STR is given, help uses the
330 strings from the previous search response or -search control
331 argument.
332
333
334 top, t
335 skips to the beginning of the info block, prints its heading line,
336 and asks whether the user wants to see the first section. This is
337 useful if the user wishes to review earlier parts of the info seg.
338 header, he
339 prints a long heading line to identify the current info seg. The
340 line consists of the pathname of the info seg, heading, and line
341 count.
342
343
344 unseen_paragraphs_only, unseen, uns
345 skips to the top of the info block, then searches for unseen
346 paragraphs. Those in the first section with unseen paragraphs are
347 printed as a group; then help prompts asking if the user wants to
348 see the next group of unseen paragraphs. Typical responses are
349 described below in "Notes on unseen paragraphs".
350 every_paragraph_visible, every_pgh, every
351 reverts from unseen_paragraphs_only mode to normal mode in which
352 both seen and unseen paragraphs are printed.
353
354
355 help RESPONSE_NAME -brief | -control_arg STR,
356 h RESPONSE_NAME -bf | -ca STR
357 prints details about help responses. RESPONSE_NAME may be the name
358 of any help response. If a response name is given, -brief and
359 -control_arg may be given to summarize information about that
360 response's syntax and arguments.
361
362 If RESPONSE_NAME is omitted, a summary of "More help?" responses
363 is printed.
364
365
366 list_responses, list_requests, lr
367 prints a 1-line description of each available help response.
368 ?
369 prints a summary of available response name and control arguments.
370 .
371 prints "help" with current version to identify the help subsystem.
372 .. MULTICS_COMMAND_LINE
373 passes the remainder of the response to the Multics command
374 processor as a command line.
375
376
377 List of responses subroutine info segments:
378 The following responses are available only when displaying an
379 info segment documenting a subroutine.
380 list_entry_points, list_ep, lep
381 lists the entry points in a subroutine info segment.
382
383 entry_point EP_NAME, ep EP_NAME
384 skips to the description of subroutine entry point EP_NAME. The
385 EP_NAME may be given as subroutine_$entry_point_name or as just
386 entry_point_name. For example, when viewing pathname_.info, to
387 skips to the pathname_$component entry point description, type:
388 ep component
389 If EP_NAME is omitted, help skips to the description of the
390 subroutine_$subroutine_ entry point, if one exists.
391
392
393 find_entry_point STRs -case_sensitive | -non_case_sensitive -top,
394 find_ep STRs -cs | -ncs -t
395 skips to the subroutine entry point whose description includes one
396 of the STR strings. Matching is -non_case_sensitive by default.
397 If STRs are omitted, the strings given in the most recent find_ep
398 response are re-used to find a subsequent matching entry point.
399
400 all_entry_points, aep
401 prints a heading for subroutine info segment, then prints its
402 introduction followed by descriptions of each entry point without
403 asking questions.
404
405
406 List of responses non-subroutine info segments:
407 The following responses are available only when displaying an
408 info segment documenting a command or general information topic.
409 all_paragraphs, all
410 prints a heading for the info block, then prints all of its
411 sections without asking questions.
412 info INFO_NAME
413 skips to another block in the current info segment, if the user
414 knows one of the names by which that block is known.
415 find_info STRs -case_sensitive | -non_case_sensitive -top,
416 find STRs -cs | -ncs -t
417 skips to another block in the current info segment by searching
418 those blocks for a paragraph matching one of the STR strings.
419 If STRs are omitted, the strings given in the most recent find_info
420 response are re-used to find a subsequent matching entry point.
421
422
423 Notes on unseen paragraphs:
424 The help command remembers which paragraphs the user has seen and
425 which have been skipped or not yet reached. It automatically stops
426 printing an info block if all paragraphs have been seen when reaching
427 the end of the info block.
428
429
430 If any paragraphs were skipped, help enters an unseen_paragraphs_only
431 mode of operation, asking if groups of adjacent unseen paragraphs
432 should be printed. Typical responses when in unseen_paragraphs_only
433 mode are:
434
435 yes, y
436 print the next group of unseen paragraphs.
437 rest -unseen, rest
438 print all remaining unseen paragraphs.
439 titles -unseen, titles
440 print section titles for all sections containing an unseen
441 paragraph.
442 section STR, scn STR
443 select which section containing unseen paragraphs to display from
444 sections listed by: titles -unseen
445
446
447 The user may enter unseen_paragraphs_only mode at any time by typing
448 one of the responses: unseen_paragraphs_only, unseen, uns
449
450
451 :Info: yes: y: 2020-10-27 yes, y
452
453 Syntax: yes, y
454
455
456 Function: prints paragraphs mentioned in the prompt, displays section
457 titles of subsequent paragraphs, and prompts: More help?
458
459
460 :Info: rest: r: 2020-11-17 rest, r
461
462 Syntax: rest -control_arg
463 r -control_arg
464
465
466 Function: prints the remaining paragraphs of the info block or
467 section without further prompts.
468
469
470 Control arguments end of range:
471 Zero or one of the following may be given. If neither is given,
472 print the remaining paragraphs of the current info block without
473 prompts. default in every_paragraph_visible mode
474 -section, -scn
475 print the remaining paragraphs of the current section without
476 prompts.
477 -unseen, -uns
478 prints the remaining unseen paragraphs in the information block.
479 default in unseen_paragraphs_only mode
480
481
482 Control arguments start of range:
483 If -top is not given, printing begins with next paragraph of the
484 current info block.
485 -top, -t
486 print beginning at the top of the current section if -section is
487 also given; otherwise at the top of the current info block.
488
489
490 :Info: skip: s: 2020-10-27 skip s
491
492
493 Syntax: skip -control_arg
494 s -control_arg
495
496
497 Function: skips paragraphs mentioned in the prompt and asks the user
498 about display of subsequent paragraphs in the block. default in
499 every_paragraph_visible mode
500
501
502 Control arguments:
503 Zero or one of the following may be given.
504 -section -scn
505 skips only the paragraphs in the first section of the prompt.
506 Prompts again about subsequent paragraphs.
507 -seen
508 searches for and displays the next unseen paragraph. default in
509 unseen_paragraphs_only mode
510 -rest
511 if the block has unseen paragraphs asks if the first group of
512 unseen paragraphs should be displayed. Otherwise moves on to the
513 next info seg selected by help INFO_NAMEs.
514
515
516 Notes:
517 For information about unseen_paragraphs_only mode type:
518 help unseen
519
520
521 :Info: next: no: n: 2020-10-27 next no n
522
523 Syntax: next no n
524
525
526 Function: exits from the current information segment when more help
527 is not needed. If the help command INFO_NAMEs selected other
528 segments help begins printing the next info segment. Otherwise help
529 returns to the command processor.
530
531
532 :Info: quit: q: 2020-10-27 quit q
533
534 Syntax: quit q
535
536
537 Function: causes help to return to the command processor without
538 printing the remaining info segs selected by the INFO_NAMEs.
539
540
541 :Info: brief: bf: 2020-10-27 brief bf
542
543 Syntax: brief bf
544
545
546 Function: prints a summary of a command active function or
547 subroutine info seg including its Syntax section and item names in
548 "Arguments" "Control arguments" and "List of ..." sections. Then
549 repeats the previous "More help?" question.
550
551
552 :Info: control_arg: ca: 2020-10-27 control_arg ca
553
554 Syntax:
555 control_arg STRs -control_arg
556 ca STRs -control_arg
557
558
559 Function: prints descriptions of "Arguments" "Control arguments" and
560 "List of ..." items whose names contain one of the STR strings. Then
561 repeats the previous "More help?" question.
562
563
564 Arguments:
565 STRs
566 strings matched with item names in "Arguments" "Control arguments"
567 and "List of ..." sections of the current info block. If STRs are
568 omitted the strings used in the previous control_arg response or
569 help -control_arg control are used again.
570
571
572 Control arguments:
573 -non_case_sensitive -ncs
574 matching of STR with item names is performed with both STR and item
575 names translated to lower case letters. default
576 -case_sensitive -cs
577 matching of STR with item names is performed in a case sensitive
578 manner.
579
580
581 :Info: titles: title: 2020-10-27 titles title
582
583 Syntax:
584 titles -control_arg
585 title -control_arg
586
587
588 Function: displays section titles in the current info block.
589
590
591 Control arguments:
592 -top -t
593 displays all section titles. By default only section titles below
594 the current section are displayed.
595 -unseen -uns
596 displays all section titles containing unseen paragraphs.
597
598
599 :Info: section: scn: 2020-10-27 section scn
600
601 Syntax:
602 section STRs -control_args
603 scn STRs -control_args
604
605
606 Function: positions to a section of the current info block whose
607 title has words matching one of the STR strings.
608
609
610 Arguments:
611 STRs
612 strings matched with words in the section titles. If STRs are
613 omitted the strings used in the previous section response or
614 help -section control are used again.
615
616
617 Control arguments:
618 -top -t
619 searches all section titles. By default only section titles below
620 the current section are searched.
621 -non_case_sensitive -ncs
622 matching of STR with title words is performed with both STR and
623 titles translated to lower case letters. default
624 -case_sensitive -cs
625 matching of STR with title words is performed in a case sensitive
626 manner.
627
628
629 :Info: search: srh: sh: 2020-10-27 search srh sh
630
631 Syntax:
632 search STRs -control_args
633 srh STRs -control_args
634 sh STRs -control_args
635
636
637 Function: in the current info block skips to the next paragraph
638 containing one of the STR strings.
639
640
641 Arguments:
642 STRs
643 strings matched with words in the paragraphs. If STRs are
644 omitted the strings used in the previous search response or
645 help -search control are used again.
646
647
648 Control arguments:
649 -top -t
650 searches all paragraphs. By default only paragraphs following
651 the most recently displayed paragraph are searched.
652 -non_case_sensitive -ncs
653 matching of STR with paragraphs is performed with both STR and
654 paragraphs translated to lower case letters. default
655 -case_sensitive -cs
656 matching of STR with paragraphs is performed in a case sensitive
657 manner.
658
659
660 :Info: top: t: 2020-11-11 top t
661
662 Syntax: t -control_arg
663
664
665 Function: skips to the beginning of the info block prints its
666 heading line and asks whether the user wants to see the first
667 section. This is useful if the user wishes to review earlier parts
668 of the info seg.
669
670
671 Control arguments:
672 -section -scn
673 skips to the beginning of the current section and begins printing
674 the entire section.
675
676
677 :Info: header: he: 2020-10-27 header he
678
679
680 Syntax: header he
681
682
683 Function: prints a long heading line to identify the current info
684 seg. The line consists of the pathname of the info block its heading
685 and count of lines in the block.
686
687
688 :Info: unseen_paragraphs_only: unseen: uns:
689 2020-10-27 unseen_paragraphs_only unseen uns
690
691 Syntax: unseen_paragraphs_only unseen uns
692
693
694 Function: skips to the top of the info block then searches for
695 unseen paragraphs. Those in the first section with unseen paragraphs
696 are printed as a group; then help prompts asking if the user wants to
697 see the next group of unseen paragraphs. Typical responses are
698 described below in "Notes on unseen paragraphs".
699
700
701 Notes on unseen paragraphs:
702 The help command remembers which paragraphs the user has seen and
703 which have been skipped or not yet reached. It automatically stops
704 printing an info block if all paragraphs have been seen when reaching
705 the end of the info block.
706
707
708 If any paragraphs were skipped help enters an unseen_paragraphs_only
709 mode of operation asking if groups of adjacent unseen paragraphs
710 should be printed. The unseen_paragraphs_only response enters this
711 mode before the end of block is reached.
712
713
714 Typical responses when in unseen_paragraphs_only mode include the
715 following:
716
717 yes y
718 print the next group of unseen paragraphs.
719 rest -unseen rest
720 print all remaining unseen paragraphs.
721 titles -unseen titles
722 print section titles for all sections containing an unseen
723 paragraph.
724 section STR scn STR
725 select which section containing unseen paragraphs to display from
726 sections listed by: titles -unseen
727
728
729 For responses that include an -unseen control argument that control
730 becomes the default when in unseen_paragraphs_only mode.
731
732
733 :Info: every_paragraph_visible: every_pgh: every:
734 2020-10-27 every_paragraph_visible every_pgh every
735
736 Syntax: every_paragraph_visible every_pgh every
737
738
739 Function: reverts from unseen_paragraphs_only mode to normal mode in
740 which both seen and unseen paragraphs are printed.
741
742
743 :Info: help: h: 2020-10-27 help h
744
745 Syntax:
746 help RESPONSE_NAME -control_args
747 h RESPONSE_NAME -control_args
748
749
750 Function: prints details about help responses. If RESPONSE_NAME is
751 omitted prints a list of help responses.
752
753
754 Arguments:
755 RESPONSE_NAME
756 the name of any help response. By default prints a list of help
757 responses.
758
759
760 Control arguments:
761 -brief -bf
762 prints the "Syntax" section and item names in "Arguments" and
763 "Control arguments" sections to summarize use of the response.
764 -control_arg STR -ca STR
765 matches STR string against names of items in the "Arguments" and
766 "Control arguments" section. Prints a description of matching
767 items.
768
769
770 :Info: list_responses: list_requests: lr:
771 2020-10-27 list_responses list_requests lr
772
773 Syntax:
774 list_responses STRs -control_args
775 list_requests STRs -control_args
776 lr STRs -control_args
777
778
779 Function: prints a brief description of selected subsystem requests.
780
781
782 Arguments:
783 STRs
784 specifies the requests to be listed. Any request with a name
785 containing one of these strings is listed. If no STRs are given
786 all requests are listed.
787
788
789 Control arguments:
790 -all -a
791 includes undocumented and unimplemented requests in the list of
792 requests eligible for matching the STR arguments.
793 -exact
794 lists only those requests one of whose names exactly match one of
795 the STR arguments.
796
797
798 Notes:
799 When matching STRs with request names a request name is considered
800 to match a STR only if that STR is at the beginning or end of a word
801 within the request name. Words in request names are bounded by the
802 beginning and end of the request name and by the characters period .
803 hyphen - underscore _ and dollar sign $.
804
805
806 Examples:
807 The request line:
808 list_requests list
809 will match requests named list list_users and forum_list but will not
810 match a request named prelisting.
811
812
813 :Info: ?: 2020-10-27 ?
814
815 Syntax: ?
816
817
818 Function: prints a summary of available response names and their
819 arguments and control arguments.
820
821
822 :Info: .: 2020-10-27 .
823
824 Syntax: .
825
826
827 Function: prints "help" with current version to identify the help
828 subsystem.
829
830
831 :Info: ..: 2020-10-27 ..
832
833 Syntax: .. MULTICS_COMMAND_LINE
834
835
836 Function: passes the remainder of the response line to the Multics
837 command processor as a command line.
838
839
840 Arguments:
841 MULTICS_COMMAND_LINE
842 is a standard Multics command line containing one or more Multics
843 commands.
844
845
846 :Info: list_entry_points: list_entrypoints: list_ep: lep:
847 2020-11-11 list_entry_points list_ep lep
848
849 Syntax: lep -control_arg
850
851
852 Function: lists the entry points descriptions available for a
853 subroutine info segment.
854
855
856 Control arguments:
857 -unseen -uns
858 lists only entry points that have not been displayed. If any
859 paragraph of an entry point was displayed that entry point is
860 omitted from the list.
861
862
863 :Info: entry_point: entrypoint: ep:
864 2020-11-19 entry_point ep
865
866 Syntax:
867 entry_point EP_STRING -control_arg
868 ep EP_STRING -control_arg
869
870
871 Function: selects the next subroutine entry points to display:
872 one whose entry point name matches an EP_STRING argument; or the first
873 entry point which has not been displayed by the user.
874
875
876 Arguments:
877 EP_STRING
878 selects an entry point name that matches EP_STRING. EP_STRING may
879 be given as subroutine_$EP_STRING or just EP_STRING. If EP_STRING
880 is omitted selects an entry point name that is the same as the
881 subroutine's reference name subroutine_$subroutine_.
882 See also the -match EP_STRING control argument.
883
884 If neither -match nor -exact is given searching selects an entry
885 point whose name exactly matches EP_STRING. If none is found a
886 second search looks for entry points whose name contains EP_STRING.
887
888
889 Control arguments:
890 -match EP_STRING
891 selects all entry point names that contain EP_STRING. This is
892 useful to force a wider search if EP_STRING exactly matches one of
893 the entry point names.
894 -exact ER_STR
895 selects only an entry point name exactly matching EP_STRING.
896
897
898 -unseen -uns
899 selects only entry points that have not been displayed earlier.
900
901
902 Examples:
903 When viewing pathname_.info to select the pathname_$component
904 description type:
905 ep component
906 or just:
907 ep comp
908
909 When viewing check_star_name_.info to select the
910 check_star_name_$check_star_name_ entry point type:
911 ep
912
913 To display names of all cu_$ command utility entry points dealing
914 with argument counts type:
915 ep -match arg_count
916
917
918 :Info: find_entry_point: find_entrypoint: find_ep:
919 2020-10-27 find_entry_point find_ep
920
921 Syntax:
922 find_entry_point STRs -control_args
923 find_ep STRs -control_args
924
925
926 Function: selects for display the next subroutine entry point whose
927 description includes one of the STR strings. This search can locate
928 an entry point performing a given function when the entry point name is
929 not known.
930
931
932 Arguments:
933 STRs
934 strings matched against paragraphs in the entry point info block.
935 The next block matching one of the STR strings is selected for
936 display. If no STRs are given the strings given with the most
937 recent find_ep request are reused.
938
939
940 Control arguments:
941 -top -t
942 searching begins with the first entry point description block in the
943 info segment rather than searching only descriptions following the
944 current block.
945 -non_case_sensitive -ncs
946 matching of STR with paragraphs is performed with both STR and
947 paragraph translated to lower case letters. default
948 -case_sensitive -cs
949 matching of STR with item names is performed in a case sensitive
950 manner.
951
952
953 Notes:
954 Use the entry point response to select the description of a known
955 subroutine entry point.
956
957
958 :Info: all_entry_points: all_entrypoints: aep:
959 2020-10-27 all_entry_points aep
960
961 Syntax: aep
962
963
964 Function: prints a heading for subroutine info segment then prints
965 its introduction followed by descriptions of each entry point without
966 asking questions.
967
968
969 :Info: all_paragraphs: all: 2020-10-27 all_paragraphs all
970
971 Syntax: all
972
973
974 Function: prints a heading for the current info block then prints
975 all of its sections without asking questions.
976
977
978 :Info: info: 2021-02-01 info
979
980 Syntax: info INFO_NAME -control_arg
981
982
983 Function: selects another info block in the current info segment
984 given one of the names in its block divider. Or lists info blocks
985 in the current info segment.
986
987
988 Arguments:
989 INFO_NAME
990 gives a name for the desired info block to be displayed.
991
992
993 Control arguments:
994 -list -ls
995 displays a list of info blocks in the info segment.
996
997
998 Notes: Either an info_name or -list may be given. Both are not
999 supported.
1000
1001
1002 :Info: find_info: find: 2020-10-27 find_info find
1003
1004 Syntax:
1005 find_info STRs -control_args
1006 find STRs -control_args
1007
1008
1009 Function: selects for display the next info block in the current info
1010 segment whose description includes one of the STR strings. This
1011 search can locate an info block describing a particular operation when
1012 the operation name is not known.
1013
1014
1015 Arguments:
1016 STRs
1017 strings matched against paragraphs in the info block. The next
1018 block matching one of the STR strings is selected for display. If
1019 no STRs are given the strings given with the most recent find_info
1020 request are reused.
1021
1022
1023 Control arguments:
1024 -top -t
1025 searching begins with the first info block in the info segment
1026 rather than searching only descriptions following the current
1027 block.
1028 -non_case_sensitive -ncs
1029 matching of STR with paragraphs is performed with both STR and
1030 paragraph translated to lower case letters. default
1031 -case_sensitive -cs
1032 matching of STR with item names is performed in a case sensitive
1033 manner.
1034
1035
1036 :Info: hidden_args.topic: hidden_args:
1037 2020-12-31 help's hidden control arguments
1038
1039 The following control arguments were added to the help command to
1040 support debugging of the help_ subroutine. These descriptions are
1041 hidden to avoid presenting debug-related descriptions to general user
1042 community.
1043
1044
1045 List of hidden control arguments:
1046 -no_video -nv
1047 disables help_ code that overwrites prompt and user response after
1048 user replies "yes" to the prompt.
1049
1050
1051 -debug OP
1052 turns on special debugging code in help_. OP may be an integer
1053 between 1 and 14 inclusive. Only values 1 2 3 were defined as of
1054 this writing.
1055 OP=1: enable debug_prompt and debug_print calls in
1056 help_listen_util_. These show factors affecting the next
1057 prompt and next text printed.
1058 OP=2: enable print statements in help_util_$format_LIST showing
1059 how number of columns and rows were determined in the
1060 formatted LIST.
1061 OP=3: print iFile.caseI and .structure values seen by help_ after
1062 info segment has been parsed.
1063 The OP value is stored in the help_args.pad26 array element and
1064 help_ accesses that OP using that element.
1065
1066
1067 :Info: help_infos.gi: help_infos: 1981-07-25 On-line information
1068
1069 Information is available on-line in info segments such as this one.
1070 To get this information use the help command just as you did to get
1071 this info seg with the name an info_name of the info seg you want
1072 to read.
1073
1074
1075 List of helpful info segs:
1076 The following info segments provide more information about the
1077 help system. Their short names are in parentheses.
1078 help
1079 describes the function of the help command how to use it
1080 and how to read through an info segment.
1081 list_help lh
1082 describes the list_help command which provides a means of
1083 searching for and listing info_names.
1084 modules module
1085 explains how to get information about Multics commands
1086 active functions and subroutines by using the help command.
1087 topics topic
1088 explains how to get general information about certain aspects
1089 of the Multics system.
1090
1091
1092 :Info: help_system.gi: help_system: 2020-10-27 Multics help system
1093
1094 Multics provides online help through information segments info segs
1095 such as this one. Type the command "help TOPIC" where TOPIC is a
1096 string identifying the desired information. The help command will
1097 look for an info seg having the entryname TOPIC.info; if found help
1098 prints the information contained in the info seg describes that topic.
1099
1100 A topic can be an individual command subroutine or some other feature
1101 of the system. For example to get information about the print
1102 command type:
1103 help print
1104
1105
1106 If the info seg is lengthy help stops after printing a certain number
1107 of lines to ask you if you want "More info?". In response you may
1108 type:
1109
1110 yes or y to print the next section of the info seg
1111 no or n to stop printing the current info seg
1112 rest or r to print the rest of the info seg without the questions
1113 top or t to return to the beginning of the info seg.
1114 quit or q to exit the help subsystem.
1115
1116 After typing your response press CARRIAGE RETURN.
1117
1118
1119 Other responses are available. To display a summary of available
1120 responses while using help type:
1121 ?
1122 which prints the full set of responses.
1123
1124
1125 At Multics command level for details about a particular response use
1126 the help -control_arg or -ca control to select a particular response
1127 name. For example learn about the titles response by entering the
1128 command:
1129 help help -ca title
1130
1131 For details about all help responses type:
1132 help help_responses
1133
1134 To invoke a Multics command while at a "More help?" prompt use a
1135 dot-dot escape followed by the command. For example:
1136 ..help help -ca title
1137
1138
1139 To get more information about Multics that you can read at the
1140 terminal type:
1141 help help_infos
1142
1143 Use the print_search_paths psp command to list directories holding
1144 info segs; type:
1145 psp info
1146
1147
1148 You may get general information about certain aspects of the Multics
1149 system type:
1150 help topics
1151
1152 If you want to get information about Multics commands and other system
1153 modules type:
1154 help modules
1155
1156 To get information about Multics published documentation you can type:
1157 help documentation
1158
1159 If the help command can't find an info seg for a given info name use
1160 the list_help command to find info segs that contain the specified
1161 TOPIC string in their entryname.
1162
1163
1164 Notes on short names:
1165 Many of the info segs have short names as well as the long names we've
1166 been using thus far. You get the same information with the short
1167 name; it's just that you have to type fewer characters on your
1168 keyboard. Three of the four info segs listed above have short names.
1169 To get the topics info seg you could type:
1170 help topic
1171
1172 To get the modules info seg you could type:
1173 help module
1174
1175 And to get the documentation info seg you could type:
1176 help doc
1177
1178
1179 :Info: topics.gi: topics: topic.gi: topic: 1984-10-17 Online help topics
1180
1181 The Multics help system includes a number of info segments info segs
1182 that contain general information gi about features or use of the
1183 system. The info names of these segments end with the suffix
1184 "gi.info". For example acl_matching.gi.info describes how Access
1185 Control List acl entries are matched with User_ids in access control
1186 commands such as set_acl. The suffix ".info" is assumed if you don't
1187 provide it; so to get the info segment on acl_matching type:
1188 help acl_matching.gi
1189
1190
1191 To get a complete list of the info segs whose names have the suffix
1192 "gi.info" use the list_help command:
1193 list_help gi
1194
1195
1196 If you want a list of info segs that pertain to a particular subject
1197 type a word or a string of characters that is part of a word that
1198 describes that subject and list_help prints a list of all info names
1199 containing that word or partial word. For example if you want a list
1200 of info segs that describe the Multics mail facility type:
1201 list_help mail
1202
1203
1204 For more information about list_help including its method for
1205 matching character strings type:
1206 help list_help
1207
1208
1209 :Info: modules.gi: modules: module.gi: module:
1210 2020-10-27 Commands Active Functions Subroutines
1211
1212 The help system provides individual info segments for each command
1213 active function and subroutine in the Multics system. These info
1214 segments are given the name of the particular system module command
1215 active function or subroutine with a suffix of "info". The
1216 resulting name is called an info_name. For example the info segment
1217 describing the print command is named "print.info". But you need not
1218 type this suffix when using the help command; you can simply type:
1219 help print
1220
1221
1222 Notes on module info_names:
1223 If you are unsure of the name of a system module you can get a list
1224 of possible names by using the list_help command with a word that
1225 describes what you are looking for. For example if you want to know
1226 how to use the mail facility you might type:
1227 list_help mail
1228
1229 For more information about the list_help command type:
1230 help list_help
1231
1232
1233 Notes on subroutine entry points:
1234 You can go directly to the description of a particular entry point in
1235 a subroutine by typing the name of the entry point with the help
1236 command. For example by typing:
1237
1238 help cu_$get_command_processor
1239
1240 you automatically bypass the 18 cu_ entry points described in
1241 alphabetical order before this one.
1242
1243
1244 If on the other hand you want to start printing at the beginning of
1245 the info seg for the command utility subroutine you type:
1246 help cu_
1247
1248 This prints an introduction for the cu_ subroutine lists the
1249 entry points it provides and asks if you want to see the first
1250 entry point. To select the cu_$arg_ptr entry point respond to
1251 the "More help?" prompt with:
1252 ep arg_ptr
1253
1254
1255 :Info: documentation.gi: documentation: doc.gi: doc:
1256 1981-07-25 Multics Documentation
1257
1258 There are two general information info segments which provide
1259 information about Multics manuals. Type "help" with the following
1260 info segment names info_names to get the information indicated:
1261
1262 manuals
1263 lists all Multics manuals and their current revision status.
1264
1265 order_manuals
1266 provides instructions for ordering Multics manuals.
1267
1268
1269 :hcom:
1270
1271
1272
1273
1274 /****^ HISTORY COMMENTS:
1275 1 change2020-10-24GDixon, approve2021-02-23MCR10089,
1276 audit2021-03-31Swenson, install2021-03-31MR12.6g-0053:
1277 A) Capitalize positional argument names like INFO_NAME and TOPIC.
1278 B) Describe -all when applied to introduction of a multi-entry-point
1279 subroutine info seg.
1280 C) Describe -brief output including Syntax, plus all items in
1281 "Arguments", "Control arguments", and "List of ..." sections.
1282 D) Add help_system.gi.info and several info segs it references
1283 since they for part of the documentation for the help command.
1284 The referenced info segs are: topics.gi.info, modules.gi.info,
1285 and documentation.gi.info.
1286 2) change2022-10-29Swenson, approve2022-10-29MCR10124,
1287 audit2022-10-29None, install2022-10-29MR12.8-1047:
1288 Fixed description on how to get help on help responses.
1289 END HISTORY COMMENTS */
1290
1291
1292