106 lines
7.5 KiB
HTML
106 lines
7.5 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="Parameters" />
|
|
<meta name="abstract" content="The Parameters section provides a parameter summary table. The parameter summary table shows all the parameters and values that are valid for the command. Possible values are indicated in the Choices column. The default value, as shipped by IBM, is underlined in the Choices column. The default values are used by the system for parameters or parts of parameters that are not coded." />
|
|
<meta name="description" content="The Parameters section provides a parameter summary table. The parameter summary table shows all the parameters and values that are valid for the command. Possible values are indicated in the Choices column. The default value, as shipped by IBM, is underlined in the Choices column. The default values are used by the system for parameters or parts of parameters that are not coded." />
|
|
<meta name="DC.Relation" scheme="URI" content="rbam6comdesform.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="rbam6parmsumtbl" />
|
|
<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>Parameters</title>
|
|
</head>
|
|
<body id="rbam6parmsumtbl"><a name="rbam6parmsumtbl"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">Parameters</h1>
|
|
<div><p>The <strong>Parameters</strong> section provides a parameter summary table.
|
|
The parameter summary table shows all the parameters and values that are valid
|
|
for the command. Possible values are indicated in the Choices column. The
|
|
default value, as shipped by IBM<sup>®</sup>, is underlined in the Choices column. The default
|
|
values are used by the system for parameters or parts of parameters that are
|
|
not coded.</p>
|
|
<div class="section"><h4 class="sectiontitle">Parameter descriptions</h4><p> Parameter descriptions follow
|
|
the parameter summary table. Parameter descriptions are presented in the same
|
|
order as the parameters are listed in the parameter summary table. Each parameter
|
|
description includes an explanation of the function of the parameter, followed
|
|
by a description of each possible parameter value. The default parameter value,
|
|
if there is one, is usually described first and is shown as an underlined
|
|
heading at the beginning of the text that describes the value. </p>
|
|
<p>The
|
|
description of each parameter explains what the parameter means, what it specifies,
|
|
and the dependent relationships it has with other parameters in the command.
|
|
When the parameter has more than one value, the information that applies to
|
|
the parameter as a whole is covered first, then the specific information for
|
|
each of the values is described after the name of each value.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Parameter summary table</h4><p>The parameter summary table
|
|
summarizes parameters and values for CL commands.</p>
|
|
<p class="c1" id="rbam6parmsumtbl__keyword"><a name="rbam6parmsumtbl__keyword"><!-- --></a><strong>Keyword
|
|
column </strong></p>
|
|
<p>This column shows the <var class="varname">parameter keyword</var> name.
|
|
Every CL command parameter has a keyword name associated with it. When you
|
|
are viewing the command documentation using a browser, you can click on the
|
|
keyword name to link to the start of the information for the parameter within
|
|
the command documentation file.</p>
|
|
<p class="c1" id="rbam6parmsumtbl__description"><a name="rbam6parmsumtbl__description"><!-- --></a><strong>Description
|
|
column</strong> </p>
|
|
<p>This column shows the prompt text defined for the parameter,
|
|
a parameter qualifier, or a parameter element. <var class="varname">Qualifiers</var> are
|
|
normally used for qualified object names or qualified job names. <var class="varname">Elements</var> are
|
|
used to define multiple input fields for a single parameter. The description
|
|
for a qualifier or element contains the qualifier or element number within
|
|
the parameter.</p>
|
|
<p class="c1" id="rbam6parmsumtbl__choices"><a name="rbam6parmsumtbl__choices"><!-- --></a><strong>Choices column</strong> </p>
|
|
<p>This
|
|
column shows the possible values for the parameter, qualifier, or element.</p>
|
|
<ul><li> <var class="varname">Predefined values</var>, also known as special values, are
|
|
listed in this column. Predefined values usually begin with an asterisk (*)
|
|
or Q, followed by all uppercase letters.</li>
|
|
<li>If the parameter, qualifier, or element allows <var class="varname">user-defined
|
|
values</var>, a description of the parameter type appears in italics,
|
|
for example <var class="varname">Name</var>.</li>
|
|
<li> <var class="varname">Default values</var> may be defined for optional parameters.
|
|
Default values are shown in bold, underlined text, for example <strong> <u>*NO</u> </strong>.</li>
|
|
<li>For complex parameters that have multiple qualifiers or elements, or if
|
|
the parameter or element supports a list of values, any <var class="varname">single value</var> choices
|
|
are identified. Single value choices may be used only once.</li>
|
|
<li> <var class="varname">Repeated values</var> can be specified for some parameters.
|
|
For repeated values, this column indicates the number of allowed repetitions.</li>
|
|
</ul>
|
|
<p id="rbam6parmsumtbl__notes"><a name="rbam6parmsumtbl__notes"><!-- --></a><strong>Notes column</strong></p>
|
|
<p>This column shows additional
|
|
information about each parameter.</p>
|
|
<ul><li>"Required" appears in this column to indicate <var class="varname">required parameters</var>,
|
|
parameters for which you are always required to specify an input value.</li>
|
|
<li>"Optional" appears in this column to indicate <var class="varname">optional parameters</var>,
|
|
parameters for which no input value is required.</li>
|
|
<li>"Key" appears in this column to indicate <var class="varname">key parameters</var>,
|
|
which are used by commands that have prompt override programs.</li>
|
|
<li>"Positional" appears in this column if the parameter is allowed to be
|
|
specified positionally (without the associated parameter keyword) in a command
|
|
string. The parameter's positional number appears following "Positional".</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rbam6comdesform.htm" title="Command documentation is provided for i5/OS commands in the form of online help and information in the iSeries Information Center. In the Information Center, each command description follows the same format.">Command documentation format</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |