95 lines
5.3 KiB
HTML
95 lines
5.3 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="reference" />
|
|
<meta name="DC.Title" content="CommandHelpRetriever class" />
|
|
<meta name="abstract" content="" />
|
|
<meta name="description" content="" />
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2006" />
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2006" />
|
|
<meta name="DC.Format" content="XHTML" />
|
|
<meta name="DC.Identifier" content="rzahhcmdhelpretriever" />
|
|
<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>CommandHelpRetriever class</title>
|
|
</head>
|
|
<body id="rzahhcmdhelpretriever"><a name="rzahhcmdhelpretriever"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">CommandHelpRetriever class</h1>
|
|
<div><p></p>
|
|
<div class="section"><p>The <a href="javadoc/com/ibm/as400/util/CommandHelpRetriever.html">CommandHelpRetriever</a> class retrieves help text for i5/OS™ control
|
|
language (CL) commands and generates that text either in HTML or User Interface
|
|
Manager (UIM) format. You can run CommandHelpRetriever from a command line
|
|
or embed the functionality into your Java™ program.</p>
|
|
<p>To use CommandHelpRetriever,
|
|
your server must run i5/OS V5R1 or later and have an XML parser and XSL
|
|
processor in the CLASSPATH environment variable. For more information, see
|
|
the following page:</p>
|
|
<blockquote><a href="rzahhxmlparserxslprocessor.htm">XML parser and XSLT processor</a></blockquote>
|
|
<p>Additionally,
|
|
the Generate Command Documentation (GENCMDDOC) CL command uses the CommandHelpRetriever
|
|
class. So you can simply use the GENCMDDOC command to take advantage of the
|
|
functionality offered by the CommandHelpRetriever class. For more information,
|
|
see the following page:</p>
|
|
<blockquote><a href="../cl/gencmddoc.htm">Generate Command Documentation (GENCMDDOC)</a></blockquote>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Running CommandHelpRetriever from a command line</h4><p>You
|
|
can run the CommandHelpRetriever class as a stand-alone command line program.
|
|
To run CommandHelpRetriever from a command line, you must pass the following
|
|
minimum parameters:</p>
|
|
<ul><li>The library on your iSeries™ server that contains the CL command. System
|
|
commands reside in the QSYS library.</li>
|
|
<li>The CL command.</li>
|
|
</ul>
|
|
<p>You can also pass optional parameters to CommandHelpRetriever that
|
|
include the iSeries server,
|
|
the user ID, password, and the location for the generated file.</p>
|
|
<p>For
|
|
more information, see the Javadoc reference documentation for CommandHelpRetriever.</p>
|
|
<p>Example:
|
|
Using CommandHelpRetriever from a command line</p>
|
|
<p>The following example
|
|
generates an HTML file called CRTLIB.html in the current directory.</p>
|
|
<div class="note"><span class="notetitle">Note:</span> The
|
|
example command appears on two lines for display purposes only. Type your
|
|
command on a single line.</div>
|
|
<pre> java com.ibm.as400.util.CommandHelpRetriever -library QSYS -command CRTLIB
|
|
-system MySystem -userid MyUserID -password MyPassword</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Embedding the CommandHelpRetriever class in your program</h4><p>You
|
|
can also use the CommandHelpRetriever class in your Java application
|
|
to display the help documentation for specified CL commands. After you create
|
|
a CommandHelpRetriever object, you can use the generateHTML and generateUIM
|
|
methods to generate help documentation in either format.</p>
|
|
<p>When you use
|
|
generateHTML(), you can display the generated HTML in the panel group for
|
|
the command or you can specify a different panel group.</p>
|
|
<p>The following
|
|
example creates a CommandHelpRetriever object and generates String objects
|
|
that represent the HTML and UIM help documentation for the CRTLIB command.</p>
|
|
<pre> CommandHelpRetriever helpGenerator = new CommandHelpRetriever();
|
|
AS400 system = new AS400("MySystem", "MyUserID", "MyPassword");
|
|
Command crtlibCommand = new Command(system, "/QSYS.LIB/CRTLIB.CMD");
|
|
String html = helpGenerator.generateHTML(crtlibCommand);
|
|
String uim = helpGenerator.generateUIM(crtlibCommand);</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Javadoc reference documentation</h4><p>For more information
|
|
about the CommandHelpRetriever class, see the following Javadoc reference
|
|
documentation:</p>
|
|
<blockquote><a href="javadoc/com/ibm/as400/util/CommandHelpRetriever.html">CommandHelpRetriever</a></blockquote>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html> |