1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30 -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
11 <!-- (C) IBM Corporation 2000. All Rights Reserved -->
12 <BODY bgcolor="ffffff">
13 <!-- End Header Records ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf103.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf105.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
18 <H2><A NAME="HDRBOS_HELP" HREF="auarf002.htm#ToC_118">bos help</A></H2>
19 <A NAME="IDX4545"></A>
20 <A NAME="IDX4546"></A>
21 <A NAME="IDX4547"></A>
22 <P><STRONG>Purpose</STRONG>
23 <P>Displays the syntax of specified <B>bos</B> commands or lists
24 functional descriptions of all <B>bos</B> commands
25 <P><STRONG>Synopsis</STRONG>
26 <PRE><B>bos help</B> [<B>-topic</B> <<VAR>help string</VAR>><SUP>+</SUP>] [<B>-help</B>]
28 <B>bos h</B> [<B>-t</B> <<VAR>help string</VAR>><SUP>+</SUP>] [<B>-h</B>]
30 <P><STRONG>Description</STRONG>
31 <P>The <B>bos help</B> command displays the complete online help entry
32 (short description and syntax statement) for each command operation code
33 specified by the <B>-topic</B> argument. If the <B>-topic</B>
34 argument is omitted, the output includes the first line (name and short
35 description) of the online help entry for every <B>bos</B> command.
36 <P>To list every <B>bos</B> command whose name or short description
37 includes a specified keyword, use the <B>bos apropos</B> command.
38 <P><STRONG>Options</STRONG>
40 <P><DT><B><B>-topic</B>
41 </B><DD>Indicates each command for which to display the complete online help
42 entry. Omit the <B>bos</B> part of the command name, providing only
43 the operation code (for example, specify <B>status</B>, not <B>bos
44 status</B>). If this argument is omitted, the output briefly
45 describes every <B>bos</B> command.
47 </B><DD>Prints the online help for this command. All other valid options
50 <P><STRONG>Output</STRONG>
51 <P>The online help entry for each <B>bos</B> command consists of the
52 following two or three lines:
54 <P><LI>The first line names the command and briefly describes its
56 <P><LI>The second line lists aliases for the command, if any.
57 <P><LI>The final line, which begins with the string <TT>Usage</TT>, lists the
58 command's options in the prescribed order. Online help entries use
59 the same symbols (for example, brackets) as the reference pages in this
62 <P><STRONG>Examples</STRONG>
63 <P>The following command displays the online help entry for the <B>bos
65 <PRE> %<B> bos help status</B>
66 bos status: show server instance status
67 Usage: bos status -server <machine name> [-instance <server
68 process name>+] [-long] [-cell <cell name>] [-noauth]
72 <P><STRONG>Privilege Required</STRONG>
74 <P><STRONG>Related Information</STRONG>
75 <P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
76 <P><A HREF="auarf097.htm#HDRBOS_APROPOS">bos apropos</A>
78 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf103.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf105.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
79 <!-- Begin Footer Records ========================================== -->
81 <br>© <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
83 <!-- End Footer Records ============================================ -->
84 <A NAME="Bot_Of_Page"></A>