1 :Info: old_help: oh: 1988-07-15  old_help, oh
  2 
  3 Syntax as a command:  oh {info_names} {-control_args}
  4 
  5 
  6 Function:  prints descriptions of system commands, active functions,
  7 and subroutines; as well as miscellaneous information about system
  8 status, system changes, and general information.  Help selects this
  9 information from segments maintained on-line, which are in a special
 10 format, called info segments (info segs).
 11 
 12 For information on the format of info segs, type "help info_seg.gi".
 13 
 14 
 15 Arguments:
 16 info_names
 17    specify the information to be printed.  The suffix ".info" is
 18    assumed.  If a pathname is specified, it identifies the info seg to
 19    be printed.  Otherwise, help searches for segments matching an
 20    entryname using the "info_segments" search list.  For subroutines,
 21    an entry point name can be included in the info_name (e.g.,
 22    subroutine_$entry_point).  The star convention is allowed, except
 23    when an entry point name is specified or when the -entry_point
 24    control argument is used.  (See "Notes on star convention" below.)
 25 
 26 
 27    If no info_names are specified, help prints the default info seg
 28    help_infos.gi.info which gives a brief introduction to the help
 29    facility.
 30 
 31    If the help command fails to find an info seg corresponding to a
 32    given info_name, use the list_help command to find info segs which
 33    contain the specified info_name in their entrynames.
 34 
 35 
 36 Control arguments for selecting info segs:
 37 -pathname path, -pn path
 38    specifies the pathname of a segment containing the info seg to be
 39    printed.  It is useful when the info to be printed is in the working
 40    directory, or when the pathname begins with a minus (-) character.
 41 -entry_point, -ep
 42    selects the info describing the main entry point of a subroutine,
 43    if there is one.  For example, "help ioa_ -ep" prints the info
 44    describing the ioa_$ioa_ subroutine entry point.
 45 
 46 
 47 Control arguments for information selection:
 48 -all, -a
 49    prints the entire info or subroutine entry point description without
 50    intervening questions.
 51 -brief, -bf
 52    prints a brief summary of a command, active function or subroutine
 53    info seg with no intervening questions.  The summary includes the
 54    Syntax section, and (for commands and active functions) a list of
 55    control arguments and/or other keywords used by the command.
 56 -brief_header, -bfhe
 57    shortens the long heading line that is printed by default.  Instead,
 58    help prints a brief heading line, consisting of the heading and line
 59    count.
 60 
 61 
 62 -case_sensitive, -cs
 63    when used with either -section of -search, will perform the
 64    requested action in a case sensitive manner.
 65 -control_arg STR, -ca STR
 66    prints only the descriptions of the control (or other) arguments
 67    whose names contain STR.  STR must NOT include a leading minus sign
 68    (-).  For example, "help mail -ca brief match exclude"
 69    prints descriptions of the -brief, -match and -exclude control
 70    arguments of the mail command.  All arguments following -ca until
 71    the next control argument are treated as STR.
 72 -header, -he
 73    prints only a long heading line consisting of the pathname of the
 74    info seg, heading, and line count.  No other information is printed.
 75    This control argument conflicts with all other information selection
 76    control arguments.
 77 
 78 
 79 -list_entry_points, -lep
 80    lists the entry points in a subroutine info segment.
 81 -non_case_sensitive, -ncs
 82    when used with either -section or -search, will perform the
 83    requested action in a non-case sensitive manner.  This is the
 84    default.
 85 -title
 86    lists the section titles used in the info seg (including section
 87    line counts), then asks if the user wishes to see the first section.
 88 
 89 
 90 Control arguments for selecting a starting paragraph:
 91 -search STRs, -srh STRs
 92    begins printing with the first paragraph containing any of STRs.
 93    STRs can be typed in lowercase, since case is ignored when
 94    matching.  All arguments following the -search control argument are
 95    treated as STRs, so -search must be the last control argument
 96    given.  The search usually begins with the first paragraph, but
 97    when -section is also specified it begins with the matching section
 98    and continues to the last paragraph (i.e., without wraparound).
 99 -section STRs, -scn STRs
100    prints the first section whose title contains the strings STRs.
101    The entire section title is not required.  STRs can be typed in
102    lowercase, since case is ignored when matching. All arguments
103    following the -section control argument until the next control
104    argument are treated as STRs.
105 
106 
107 Control arguments for paragraph grouping:
108    The following control arguments determine how much information help
109    prints before asking if the user wants to see more.
110 -minlines I
111    sets the minimum paragraph size to I lines.  Paragraphs smaller than
112    this size are printed with preceding paragraphs.  The default is 4.
113 -maxlines J
114    sets the maximum paragraph grouping size to J lines so no more than
115    J lines of information are printed before asking if the user wants
116    more help.  The default is 15.
117 
118 
119 List of responses:
120    The responses accepted when help questions the user are given
121    here.  Those responses that search the info seg or list section
122    titles operate from the current paragraph to the end of the info
123    seg.  No wraparound feature is employed.
124 brief, bf
125    prints a summary of a command, active function or subroutine info
126    seg, including Syntax section and a list of control arguments, then
127    repeats the previous question.
128 control_arg STR,  ca STR
129    prints descriptions of control (or other) arguments whose names
130    contain STR, then repeats the previous question.
131 
132 
133 entry_point {EP_NAME},  ep {EP_NAME}
134    skips to the description of subroutine entry point EP_NAME.  The
135    EP_NAME can be specified as entry_point_name or
136    subroutine_$entry_point_name.  If EP_NAME is omitted, help skips to
137    the description of the subroutine_$subroutine_ entry point, if one
138    exists.
139 header, he
140    prints a long heading line to identify the current info seg.  The
141    line consists of the pathname of the info seg, heading, and line
142    count.
143 list_entry_points, lep
144    lists the entry points in a subroutine info segment.
145 list_requests, lr
146    prints information about available help requests.
147 
148 
149 no, n
150    exits from the current info seg, and begins printing the next info
151    seg selected by info_names given in the help command.  Returns from
152    the help command if all selected info segs have been printed.
153 quit, q
154    causes the help command to return without printing the remaining
155    info segs selected by the info_names.
156 
157 
158 rest {-scn} {-all_entrypoints}  {-entrypoint},
159 r {-scn} {-aep}  {-ep}
160    prints the rest of the info seg without intervening questions.  If
161    the -section control argument is specified, help prints only the
162    rest of the current section without questions.  When the section has
163    been printed, help then asks whether the user wants to see the next
164    section.  If -all_entrypoints is specified, help will print the rest
165    of the remaining entry points.  If -entrypoint is specified help
166    will print the rest of the current entry point only (default).
167 
168 
169 search {STRs} {-case_sensitive} {-non_case_sensitive } {-top},
170 srh {STRs} {-top} {-cs} {-ncs}
171    skips to the next paragraph containing STRs.  Paragraph selection is
172    performed as described above for the -search control argument.  If
173    -top or -t is specified, searching starts at the beginning of the
174    info seg.  If STRs is omitted, help uses the strings from the
175    previous search response or -search control argument.
176    -case_sensitive and -non_case_sensitive are mutually exclusive and
177    will search the string as specified.
178 
179 
180 section {STRs} {-case_sensitive} {-non_case_sensitive} {-top},
181 scn {STRs} {-cs} {-ncs} {-top}
182    skips to the next section whose title contains STRs.  Title matching
183    is performed as described above for the -section control argument.
184    If -top or -t is specified, title searching starts at the beginning
185    of the info.  If STRs is omitted, help uses the search strings from
186    the previous section response or -section control argument.
187    -case_sensitive and -non_case_sensitive are mutually exclusive and
188    will search the string as specified.
189 
190 
191 skip {-scn} {-rest} {-seen} {-ep}, s {-scn} {-rest} {-seen} {-ep}
192    skips the next paragraph and asks whether the user wants to see the
193    paragraph following it.  If -section or -scn is specified, help
194    skips all paragraphs of the current section.  If -rest or -r,
195    -entry_point or -ep are specified, help skips the rest of this info
196    seg or subroutine entry point description, continuing with the next.
197    If -seen is specified, help skips to the next paragraph that the
198    user has not seen.  Only one of these control arguments can be used
199    at a time.
200 title {-top}
201    lists titles and line counts of all sections remaining in the
202    current info seg.  If -top or -t is specified, help lists all
203    section titles.
204 
205 
206 top, t
207    skips to the beginning of the info seg, prints the heading line, and
208    asks whether the user wants to see the first section.  This is
209    useful if the user wishes to review earlier parts of the info seg.
210 yes, y
211    prints the next paragraph of information, then asks whether the user
212    wants more help.
213 ?
214    prints a list of available responses.
215 .
216    prints "help" to identify the current interactive environment.
217 .. command_line
218    passes the remainder of the response to the Multics command
219    processor as a command line.
220 
221 
222 Notes:  The -all, -brief, -control_arg and -title control arguments are
223 mutually exclusive.
224 
225 When -section or -search control arguments are specified and no
226 matching paragraph is found in any of the info segs selected by an
227 info_name or info selection control argument, that info seg is passed
228 over without comment.  Thus, the starting paragraph control arguments
229 serve as a secondary info selection mechanism.
230 
231 
232 The starting paragraph control arguments can be used with any of the
233 information selection control arguments listed above, but its effect
234 differs depending upon which of them are used.  When -section or
235 -search is used with -header, only the heading lines for infos
236 containing a matching paragraph are listed.  The matching paragraph
237 itself is not printed.  When they are used with -brief or -control_arg,
238 help prints a heading line and then the information selected by -brief
239 or -control_arg.  The matching paragraph is not printed.
240 
241 When -section or -search is used with -brief_header, a brief heading
242 line is printed preceding the matching paragraph.  When used with
243 -title, help prints a heading line, then the list of section titles,
244 and finally the matching paragraph.  When used with -all, the entire
245 info is printed for infos containing a matching paragraph.
246 
247 
248 The help command remembers which paragraphs the user has seen and which
249 have been skipped or not yet reached.  It asks the user to "Review"
250 paragraphs seen before, but asks if "More help" is needed for unseen
251 paragraphs.  It stops printing if all paragraphs have been seen when
252 the end of info is reached.  However, if any paragraphs were skipped,
253 help asks if user wants to see them.  If the response is "yes", the
254 first unseen paragraph is printed.  The user can then answer "skip
255 -seen" to view subsequent unseen paragraphs.
256 
257 The question/answer dialogue continues until all of the information is
258 printed, or until the user replies "no".
259 
260 
261 :Info: help: 1988-07-15  help
262 
263 Syntax as a command:  help {info_names} {-control_args}
264 
265 
266 Function:  prints descriptions of system commands, active functions,
267 and subroutines; as well as miscellaneous information about system
268 status, system changes, and general information.  Help selects this
269 information from segments maintained on-line, which are in a special
270 format, called info segments (info segs).
271 
272 For information on the format of info segs, type "help info_seg.gi".
273 
274 
275 Arguments:
276 info_names
277    specify the information to be printed.  The suffix ".info" is
278    assumed.  If a pathname is specified, it identifies the info seg to
279    be printed.  Otherwise, help searches for segments matching an
280    entryname using the "info_segments" search list.  For subroutines,
281    an entry point name can be included in the info_name (e.g.,
282    subroutine_$entry_point).  The star convention is allowed, except
283    when an entry point name is specified or when the -entry_point
284    control argument is used.  (See "Notes on star convention" below.)
285 
286 
287    If no info_names are specified, help prints the default info seg
288    help_infos.gi.info which gives a brief introduction to the help
289    facility.
290 
291    If the help command fails to find an info seg corresponding to a
292    given info_name, use the list_help command to find info segs which
293    contain the specified info_name in their entrynames.
294 
295 
296 Control arguments for selecting info segs:
297 -pathname path, -pn path
298    specifies the pathname of a segment containing the info seg to be
299    printed.  It is useful when the info to be printed is in the working
300    directory, or when the pathname begins with a minus (-) character.
301 -entry_point, -ep
302    selects the info describing the main entry point of a subroutine,
303    if there is one.  For example, "help ioa_ -ep" prints the info
304    describing the ioa_$ioa_ subroutine entry point.
305 
306 
307 Control arguments for information selection:
308 -all, -a
309    prints the entire info or subroutine entry point description without
310    intervening questions.
311 -brief, -bf
312    prints a brief summary of a command, active function or subroutine
313    info seg with no intervening questions.  The summary includes the
314    Syntax section, and (for commands and active functions) a list of
315    control arguments and/or other keywords used by the command.
316 -brief_header, -bfhe
317    shortens the long heading line that is printed by default.  Instead,
318    help prints a brief heading line, consisting of the heading and line
319    count.
320 
321 
322 -case_sensitive, -cs
323    when used with either -section of -search, will perform the
324    requested action in a case sensitive manner.
325 -control_arg STR, -ca STR
326    prints only the descriptions of the control (or other) arguments
327    whose names contain STR.  STR must NOT include a leading minus sign
328    (-).  For example, "help mail -ca brief match exclude"
329    prints descriptions of the -brief, -match and -exclude control
330    arguments of the mail command.  All arguments following -ca until
331    the next control argument are treated as STR.
332 -header, -he
333    prints only a long heading line consisting of the pathname of the
334    info seg, heading, and line count.  No other information is printed.
335    This control argument conflicts with all other information selection
336    control arguments.
337 
338 
339 -list_entry_points, -lep
340    lists the entry points in a subroutine info segment.
341 -non_case_sensitive, -ncs
342    when used with either -section or -search, will perform the
343    requested action in a non-case sensitive manner.  This is the
344    default.
345 -title
346    lists the section titles used in the info seg (including section
347    line counts), then asks if the user wishes to see the first section.
348 
349 
350 Control arguments for selecting a starting paragraph:
351 -search STRs, -srh STRs
352    begins printing with the first paragraph containing any of STRs.
353    STRs can be typed in lowercase, since case is ignored when
354    matching.  All arguments following the -search control argument are
355    treated as STRs, so -search must be the last control argument
356    given.  The search usually begins with the first paragraph, but
357    when -section is also specified it begins with the matching section
358    and continues to the last paragraph (i.e., without wraparound).
359 -section STRs, -scn STRs
360    prints the first section whose title contains the strings STRs.
361    The entire section title is not required.  STRs can be typed in
362    lowercase, since case is ignored when matching. All arguments
363    following the -section control argument until the next control
364    argument are treated as STRs.
365 
366 
367 Control arguments for paragraph grouping:
368    The following control arguments determine how much information help
369    prints before asking if the user wants to see more.
370 -minlines I
371    sets the minimum paragraph size to I lines.  Paragraphs smaller than
372    this size are printed with preceding paragraphs.  The default is 4.
373 -maxlines J
374    sets the maximum paragraph grouping size to J lines so no more than
375    J lines of information are printed before asking if the user wants
376    more help.  The default is 15.
377 
378 
379 List of responses:
380    The responses accepted when help questions the user are given
381    here.  Those responses that search the info seg or list section
382    titles operate from the current paragraph to the end of the info
383    seg.  No wraparound feature is employed.
384 brief, bf
385    prints a summary of a command, active function or subroutine info
386    seg, including Syntax section and a list of control arguments, then
387    repeats the previous question.
388 control_arg STR,  ca STR
389    prints descriptions of control (or other) arguments whose names
390    contain STR, then repeats the previous question.
391 
392 
393 entry_point {EP_NAME},  ep {EP_NAME}
394    skips to the description of subroutine entry point EP_NAME.  The
395    EP_NAME can be specified as entry_point_name or
396    subroutine_$entry_point_name.  If EP_NAME is omitted, help skips to
397    the description of the subroutine_$subroutine_ entry point, if one
398    exists.
399 header, he
400    prints a long heading line to identify the current info seg.  The
401    line consists of the pathname of the info seg, heading, and line
402    count.
403 list_entry_points, lep
404    lists the entry points in a subroutine info segment.
405 list_requests, lr
406    prints information about available help requests.
407 
408 
409 no, n
410    exits from the current info seg, and begins printing the next info
411    seg selected by info_names given in the help command.  Returns from
412    the help command if all selected info segs have been printed.
413 quit, q
414    causes the help command to return without printing the remaining
415    info segs selected by the info_names.
416 
417 
418 rest {-scn} {-all_entrypoints}  {-entrypoint},
419 r {-scn} {-aep}  {-ep}
420    prints the rest of the info seg without intervening questions.  If
421    the -section control argument is specified, help prints only the
422    rest of the current section without questions.  When the section has
423    been printed, help then asks whether the user wants to see the next
424    section.  If -all_entrypoints is specified, help will print the rest
425    of the remaining entry points.  If -entrypoint is specified help
426    will print the rest of the current entry point only (default).
427 
428 
429 search {STRs} {-case_sensitive} {-non_case_sensitive } {-top},
430 srh {STRs} {-top} {-cs} {-ncs}
431    skips to the next paragraph containing STRs.  Paragraph selection is
432    performed as described above for the -search control argument.  If
433    -top or -t is specified, searching starts at the beginning of the
434    info seg.  If STRs is omitted, help uses the strings from the
435    previous search response or -search control argument.
436    -case_sensitive and -non_case_sensitive are mutually exclusive and
437    will search the string as specified.
438 
439 
440 section {STRs} {-case_sensitive} {-non_case_sensitive} {-top},
441 scn {STRs} {-cs} {-ncs} {-top}
442    skips to the next section whose title contains STRs.  Title matching
443    is performed as described above for the -section control argument.
444    If -top or -t is specified, title searching starts at the beginning
445    of the info.  If STRs is omitted, help uses the search strings from
446    the previous section response or -section control argument.
447    -case_sensitive and -non_case_sensitive are mutually exclusive and
448    will search the string as specified.
449 
450 
451 skip {-scn} {-rest} {-seen} {-ep}, s {-scn} {-rest} {-seen} {-ep}
452    skips the next paragraph and asks whether the user wants to see the
453    paragraph following it.  If -section or -scn is specified, help
454    skips all paragraphs of the current section.  If -rest or -r,
455    -entry_point or -ep are specified, help skips the rest of this info
456    seg or subroutine entry point description, continuing with the next.
457    If -seen is specified, help skips to the next paragraph that the
458    user has not seen.  Only one of these control arguments can be used
459    at a time.
460 title {-top}
461    lists titles and line counts of all sections remaining in the
462    current info seg.  If -top or -t is specified, help lists all
463    section titles.
464 
465 
466 top, t
467    skips to the beginning of the info seg, prints the heading line, and
468    asks whether the user wants to see the first section.  This is
469    useful if the user wishes to review earlier parts of the info seg.
470 yes, y
471    prints the next paragraph of information, then asks whether the user
472    wants more help.
473 ?
474    prints a list of available responses.
475 .
476    prints "help" to identify the current interactive environment.
477 .. command_line
478    passes the remainder of the response to the Multics command
479    processor as a command line.
480 
481 
482 Notes:  The -all, -brief, -control_arg and -title control arguments are
483 mutually exclusive.
484 
485 When -section or -search control arguments are specified and no
486 matching paragraph is found in any of the info segs selected by an
487 info_name or info selection control argument, that info seg is passed
488 over without comment.  Thus, the starting paragraph control arguments
489 serve as a secondary info selection mechanism.
490 
491 
492 The starting paragraph control arguments can be used with any of the
493 information selection control arguments listed above, but its effect
494 differs depending upon which of them are used.  When -section or
495 -search is used with -header, only the heading lines for infos
496 containing a matching paragraph are listed.  The matching paragraph
497 itself is not printed.  When they are used with -brief or -control_arg,
498 help prints a heading line and then the information selected by -brief
499 or -control_arg.  The matching paragraph is not printed.
500 
501 When -section or -search is used with -brief_header, a brief heading
502 line is printed preceding the matching paragraph.  When used with
503 -title, help prints a heading line, then the list of section titles,
504 and finally the matching paragraph.  When used with -all, the entire
505 info is printed for infos containing a matching paragraph.
506 
507 
508 The help command remembers which paragraphs the user has seen and which
509 have been skipped or not yet reached.  It asks the user to "Review"
510 paragraphs seen before, but asks if "More help" is needed for unseen
511 paragraphs.  It stops printing if all paragraphs have been seen when
512 the end of info is reached.  However, if any paragraphs were skipped,
513 help asks if user wants to see them.  If the response is "yes", the
514 first unseen paragraph is printed.  The user can then answer "skip
515 -seen" to view subsequent unseen paragraphs.
516 
517 The question/answer dialogue continues until all of the information is
518 printed, or until the user replies "no".
519 
520 
521 :hcom:
522 
523 /****^  HISTORY COMMENTS:
524   1) change(2021-02-15,GDixon), approve(2021-02-15,MCR10085),
525      audit(2021-03-17,Swenson), install(2021-03-17,MR12.6g-0052):
526       A) As part of preserving the pre-2020 version of help command as
527          old_help (oh), rename help.info to old_help.info (oh.info) and
528          move this file from >doc>info to >doc>priv.  No info content
529          was changed other than command names.
530       B) Add a second block to this file containing the original
531          help.info document (with no command name changes).  Since
532          the name help.info will not appear on the info segment,
533          this block will be invisible unless the user adds a link
534          to an early directory in their info_seg search paths
535          referencing >doc>priv>old_help.info as help.info.
536                                                    END HISTORY COMMENTS */