81 lines
5.8 KiB
HTML
81 lines
5.8 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="Command documentation format" />
|
||
|
|
<meta name="abstract" content="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." />
|
||
|
|
<meta name="description" content="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." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="intcmdinfodoc.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rbam6environ.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rbam6runthread.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rbam6cmddescriptions.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rbam6parmsumtbl.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rbam6cmdexamples.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rbam6cmderror.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../books/sc415302.pdf" />
|
||
|
|
<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="rbam6comdesform" />
|
||
|
|
<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>Command documentation format</title>
|
||
|
|
</head>
|
||
|
|
<body id="rbam6comdesform"><a name="rbam6comdesform"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">Command documentation format</h1>
|
||
|
|
<div><p>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.</p>
|
||
|
|
<p>Each command description includes the parts discussed in the following
|
||
|
|
paragraphs. At the beginning of the command description documentation, there
|
||
|
|
are links to the Parameters, Examples, and Error messages sections. </p>
|
||
|
|
<p>It should be noted that, because a command is an i5/OS object, each command can be authorized
|
||
|
|
for specific users or authorized for use by the public (all users authorized
|
||
|
|
in some way to use the system). Because this is true for nearly every command,
|
||
|
|
it is not stated in each command description.</p>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<ul class="ullinks">
|
||
|
|
<li class="ulchildlink"><strong><a href="rbam6environ.htm">Environment</a></strong><br />
|
||
|
|
At the very top of the command description documentation are environment classification. The environment information describes where the command is allowed to run.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rbam6runthread.htm">Threadsafe classification</a></strong><br />
|
||
|
|
The threadsafe classification indicates whether a command is threadsafe. Each command has a threadsafe classification.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rbam6cmddescriptions.htm">Command description</a></strong><br />
|
||
|
|
The general description of the command follows the environment and threadsafe classification. It briefly explains the function of the command and any relationships it has with a program or with other commands. If there are restrictions on the use of the command, they are described under the heading "Restrictions."</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rbam6parmsumtbl.htm">Parameters</a></strong><br />
|
||
|
|
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.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rbam6cmdexamples.htm">Command coding examples</a></strong><br />
|
||
|
|
The <strong>Examples</strong> section provides at least one coded example
|
||
|
|
for the command. Where necessary, several examples are provided for commands
|
||
|
|
with many parameters and several logical combinations.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rbam6cmderror.htm">Error messages</a></strong><br />
|
||
|
|
The <strong>Error messages</strong> section lists error messages that can
|
||
|
|
be issued for the command.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="intcmdinfodoc.htm" title="IBM provides documentation for i5/OS commands. In addition, you can write documentation for your own commands.">Command information and documentation</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="relinfo"><strong>Related information</strong><br />
|
||
|
|
<div><a href="../books/sc415302.pdf" target="_blank">iSeries Security Reference PDF</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|