User Tools

Site Tools


getting_help

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
getting_help [2018/10/03 20:51]
lricker add header
getting_help [2018/11/21 21:46]
lricker
Line 5: Line 5:
 The DCL HELP facility and command have long been recognized as essential, both for the novice user and the experienced VMS guru alike. Bespoken help libraries are available not only to cover the essential DCL commands themselves, but also for specific utility programs such as (VMS) MAIL and PHONE, and for system administration tools such as SYSGEN, SYSMAN, TCPIP, AUTHORIZE and more.  For these latter, a built-in utility ''​HELP''​ command gives access to that utility'​s command help-text. ​ For example: The DCL HELP facility and command have long been recognized as essential, both for the novice user and the experienced VMS guru alike. Bespoken help libraries are available not only to cover the essential DCL commands themselves, but also for specific utility programs such as (VMS) MAIL and PHONE, and for system administration tools such as SYSGEN, SYSMAN, TCPIP, AUTHORIZE and more.  For these latter, a built-in utility ''​HELP''​ command gives access to that utility'​s command help-text. ​ For example:
  
-  ​$ MCR AUTHORIZE +<​code>​ 
-  UAF> HELP +$ MCR AUTHORIZE 
-  ...+UAF> HELP 
 +     ​... 
 +</​code>​
  
 **For general DCL use**, the ''​HELP''​ command is essential -- For example, try (in your logged-in VMS session): **For general DCL use**, the ''​HELP''​ command is essential -- For example, try (in your logged-in VMS session):
  
-  ​$ HELP                ! access to the whole DCL HELP facility, including an overview of topics +<​code>​ 
-   +$ HELP                ! access to the whole DCL HELP facility, including an overview of topics 
-  $ HELP HELP           ! getting started with HELP + 
-   +$ HELP HELP           ! getting started with HELP 
-  $ HELP INSTRUCTIONS ​  ! how to use HELP (details) + 
-   +$ HELP INSTRUCTIONS ​  ! how to use HELP (details) 
-  $ HELP HINTS          ! useful tips on getting the most out of HELP topics+ 
 +$ HELP HINTS          ! useful tips on getting the most out of HELP topics 
 +</​code>​
  
 Of course, to get help on a specific DCL command, for instance on the ''​COPY''​ command, use: Of course, to get help on a specific DCL command, for instance on the ''​COPY''​ command, use:
  
-  ​$ HELP COPY+<​code>​ 
 +$ HELP COPY 
 +</​code>​
  
 Within HELP's overview of topics, any topic which appears in all ''​UPPERCASE''​ is a DCL command verb; topics in Mixed/lower case are concept topics, such as ''​Filespec''​ and ''​Errors''​ (both of which you should review). Within HELP's overview of topics, any topic which appears in all ''​UPPERCASE''​ is a DCL command verb; topics in Mixed/lower case are concept topics, such as ''​Filespec''​ and ''​Errors''​ (both of which you should review).
Line 35: Line 41:
 Both programmers and sysadmins often need to look up the details of the so-called "DCL Lexical Functions",​ but if you want help on, say, the F$CVTIME function, this won't work: Both programmers and sysadmins often need to look up the details of the so-called "DCL Lexical Functions",​ but if you want help on, say, the F$CVTIME function, this won't work:
  
-  ​$ HELP F$CVTIME +<​code>​ 
-  Sorry, no documentation on F$CVTIME+$ HELP F$CVTIME 
 +Sorry, no documentation on F$CVTIME 
 +</​code>​
  
 Instead, you'll have to remember that all of these lexical functions are sub-topics under HELP's ''​Lexicals''​ topic, so use: Instead, you'll have to remember that all of these lexical functions are sub-topics under HELP's ''​Lexicals''​ topic, so use:
  
-  ​$ HELP LEXICAL F$CVTIME+<​code>​ 
 +$ HELP LEXICAL F$CVTIME
   ...   ...
 +</​code>​
  
-(you could abbreviate ''​LEXICAL''​ to just ''​LEX''​).+(you could abbreviate ''​LEXICAL''​ to just ''​LEX''​).  Also, see the wiki article [[DCL Lexical Functions]] for much more information about DCL lexicals.
  
 A special function of DCL HELP is the [[dcl_error_messages|HELP /MESSAGE]] command, which you should become familiar with to solve specific command syntax and operational problems. A special function of DCL HELP is the [[dcl_error_messages|HELP /MESSAGE]] command, which you should become familiar with to solve specific command syntax and operational problems.
getting_help.txt · Last modified: 2018/11/21 21:46 by lricker