102 lines
6.1 KiB
HTML
102 lines
6.1 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
<!DOCTYPE html
|
||
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
<html lang="en-us" xml:lang="en-us">
|
||
|
<head>
|
||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
<meta name="security" content="public" />
|
||
|
<meta name="Robots" content="index,follow" />
|
||
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
<meta name="DC.Type" content="concept" />
|
||
|
<meta name="DC.Title" content="Commands and command help" />
|
||
|
<meta name="abstract" content="Command prompting and online command help are powerful features of CL commands." />
|
||
|
<meta name="description" content="Command prompting and online command help are powerful features of CL commands." />
|
||
|
<meta name="DC.Relation" scheme="URI" content="doccmd.htm" />
|
||
|
<meta name="DC.Relation" scheme="URI" content="../cl/crtcmd.htm" />
|
||
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
|
||
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1998, 2006" />
|
||
|
<meta name="DC.Format" content="XHTML" />
|
||
|
<meta name="DC.Identifier" content="cmdhlprel" />
|
||
|
<meta name="DC.Language" content="en-us" />
|
||
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
<!-- US Government Users Restricted Rights -->
|
||
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
<title>Commands and command help</title>
|
||
|
</head>
|
||
|
<body id="cmdhlprel"><a name="cmdhlprel"><!-- --></a>
|
||
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
<h1 class="topictitle1">Commands and command help</h1>
|
||
|
<div><p>Command prompting and online command help are powerful features
|
||
|
of CL commands.</p>
|
||
|
<p> If you have developed one or more of your own CL commands, you know that
|
||
|
all of the command prompting capabilities used by IBM<sup>®</sup> CL commands are available for you to
|
||
|
use for your commands. The same is true for command help; the same capabilities
|
||
|
for help provided for IBM-provided commands are also available for you to
|
||
|
use to create online help.</p>
|
||
|
<p>The first step is to understand how the connections work between commands
|
||
|
and command help. </p>
|
||
|
<ul><li>Command help information is stored in panel group objects. The symbolic
|
||
|
object type for a panel group is *PNLGRP. A help panel group consists of
|
||
|
help modules. Each help module has a help module name.</li>
|
||
|
<li>There are two parameters on the <span class="cmdname">Create Command (CRTCMD)</span> command
|
||
|
that make the connection between a command (*CMD) object and an online help
|
||
|
panel group: <strong>HLPID</strong> (Help identifier) and <strong>HLPPNLGRP</strong> (Help panel
|
||
|
group).</li>
|
||
|
<li>There are four types of command help modules in an online help panel group:
|
||
|
<ol><li>Command-level help module</li>
|
||
|
<li>Parameter-level help module</li>
|
||
|
<li>Command examples help module</li>
|
||
|
<li>Command error messages help module</li>
|
||
|
</ol>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<p>When you try to view the help for a CL command (for instance, by pressing
|
||
|
the F1 (Help) key while prompting the command), i5/OS™ determines whether the command has
|
||
|
a help panel group associated with the command. If the command was created
|
||
|
specifying a panel group name for the HLPPNLGRP parameter, or was changed
|
||
|
by the <span class="cmdname">Change Command (CHGCMD)</span> command to have a help panel
|
||
|
group associated with the command, the help stored in the panel group is
|
||
|
retrieved, formatted, and displayed. i5/OS attempts to retrieve help from the
|
||
|
following help modules in the help panel group: </p>
|
||
|
<ul><li>A command-level help module that has the same name as the value specified
|
||
|
for the HLPID parameter when the command was created or changed. For example,
|
||
|
if command STRPAY was created specifying HLPID(STRPAY), i5/OS looks for
|
||
|
a help module named STRPAY.</li>
|
||
|
<li>A parameter-level help module for each command parameter, with the exception
|
||
|
of constant parameters. The help module name must be the command's HLPID value
|
||
|
followed by a forward slash character followed by the parameter keyword name.
|
||
|
For example, if command STRPAY has a HLPID value of STRPAY and a parameter
|
||
|
named TITLE, i5/OS looks
|
||
|
for a parameter-level help module named STRPAY/TITLE.</li>
|
||
|
<li>A help module containing one or more examples of using the command.
|
||
|
The help module name must be the command's HLPID value followed by a forward
|
||
|
slash character followed by COMMAND/EXAMPLES. For example, if command STRPAY
|
||
|
has a HLPID value of STRPAY, i5/OS looks for a command examples help module named
|
||
|
STRPAY/COMMAND/EXAMPLES.</li>
|
||
|
<li>A help module containing the list of monitorable messages that may be
|
||
|
signaled from the command. The help module name must be the command's HLPID
|
||
|
value followed by a forward slash character followed by ERROR/MESSAGES. For
|
||
|
example, if command STRPAY has a HLPID value of STRPAY, i5/OS looks for
|
||
|
a command examples help module named STRPAY/ERROR/MESSAGES.</li>
|
||
|
</ul>
|
||
|
<p>When viewing extended CL command help on a 5250 terminal (or using 5250
|
||
|
emulator software), command-level and parameter-level help sections are required,
|
||
|
and the examples and error messages help sections are optional. If the command-level
|
||
|
help section or any parameter-level help section is not found in the online
|
||
|
help panel group, diagnostic message CPF6E01 (Help information is incomplete)
|
||
|
is displayed at the bottom of the help display. If the examples or error
|
||
|
messages help modules are not found, no diagnostic message is displayed.</p>
|
||
|
</div>
|
||
|
<div>
|
||
|
<div class="familylinks">
|
||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="doccmd.htm" title="You can create online help and HTML command description information for commands that you create.">Document commands</a></div>
|
||
|
</div>
|
||
|
<div class="relinfo"><strong>Related information</strong><br />
|
||
|
<div><a href="../cl/crtcmd.htm">Create Command (CRTCMD) command</a></div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</body>
|
||
|
</html>
|