openafs/doc/html/AdminReference/auarf097.htm
Derrick Brashear d7da1acc31 initial-html-documentation-20010606
pull in all documentation from IBM
2001-06-06 19:09:07 +00:00

74 lines
3.9 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
<HTML><HEAD>
<TITLE>Administration Reference</TITLE>
<!-- Begin Header Records ========================================== -->
<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID -->
<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30 -->
<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
</HEAD><BODY>
<!-- (C) IBM Corporation 2000. All Rights Reserved -->
<BODY bgcolor="ffffff">
<!-- End Header Records ============================================ -->
<A NAME="Top_Of_Page"></A>
<H1>Administration Reference</H1>
<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="auarf096.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="auarf098.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>
<P>
<H2><A NAME="HDRBOS_APROPOS" HREF="auarf002.htm#ToC_111">bos apropos</A></H2>
<A NAME="IDX4473"></A>
<A NAME="IDX4474"></A>
<A NAME="IDX4475"></A>
<A NAME="IDX4476"></A>
<P><STRONG>Purpose</STRONG>
<P>Displays each help entry containing a keyword string
<P><STRONG>Synopsis</STRONG>
<PRE><B>bos apropos -topic</B> &lt;<VAR>help string</VAR>> [<B>-help</B>]
<B>bos ap -t</B> &lt;<VAR>help string</VAR>> [<B>-h</B>]
</PRE>
<P><STRONG>Description</STRONG>
<P>The <B>bos apropos</B> command displays the first line of the online
help entry for any <B>bos</B> command that has in its name or short
description the string specified by the <B>-topic</B> argument.
<P>To display the syntax for a command, use the <B>bos help</B>
command.
<P><STRONG>Options</STRONG>
<DL>
<P><DT><B><B>-topic</B>
</B><DD>Specifies the keyword string to match, in lowercase letters only.
If the string is more than a single word, surround it with double quotes ("")
or other delimiters.
<P><DT><B>-help
</B><DD>Prints the online help for this command. All other valid options
are ignored.
</DL>
<P><STRONG>Output</STRONG>
<P>The first line of a command's online help entry names it and briefly
describes its function. This command displays the first line for any
<B>bos</B> command where the string specified with the <B>-topic</B>
argument is part of the command name or first line.
<P><STRONG>Examples</STRONG>
<P>The following command lists all <B>bos</B> commands that include the
word <B>restart</B> in their names or short descriptions:
<PRE> % <B>bos apropos restart</B>
getrestart: get restart times
restart: restart all processes
setrestart: set restart times
</PRE>
<P><STRONG>Privilege Required</STRONG>
<P>None
<P><STRONG>Related Information</STRONG>
<P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
<P><A HREF="auarf104.htm#HDRBOS_HELP">bos help</A>
<P>
<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="auarf096.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="auarf098.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>
<!-- Begin Footer Records ========================================== -->
<P><HR><B>
<br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
</B>
<!-- End Footer Records ============================================ -->
<A NAME="Bot_Of_Page"></A>
</BODY></HTML>