doc/html/AdminReference/auarf187.htm

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
   2 <HTML><HEAD>
   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">
  10 </HEAD><BODY>
  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="auarf186.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="auarf188.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>
  17 <P>
  18 <H2><A NAME="HDRKAS_HELP" HREF="auarf002.htm#ToC_201">kas help</A></H2>
  19 <A NAME="IDX5109"></A>
  20 <A NAME="IDX5110"></A>
  21 <A NAME="IDX5111"></A>
  22 <P><STRONG>Purpose</STRONG>
  23 <P>Displays the syntax of each specified <B>kas</B> command or lists
  24 functional descriptions of all <B>kas</B> commands
  25 <P><STRONG>Synopsis</STRONG>
  26 <PRE><B>kas help </B>[<B>-topic</B> &lt;<VAR>help&nbsp;string</VAR>><SUP>+</SUP>]  [<B>-help</B>]
  27
  28 <B>kas h</B> [<B>-t</B> &lt;<VAR>help&nbsp;string</VAR>><SUP>+</SUP>]  [<B>-h</B>]
  29 </PRE>
  30 <P><STRONG>Description</STRONG>
  31 <P>The <B>kas 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>kas</B> command.
  36 <P>To list every <B>kas</B> command whose name or short description
  37 includes a specified keyword, use the <B>kas apropos</B> command.
  38 <P><STRONG>Options</STRONG>
  39 <DL>
  40 <P><DT><B>-topic
  41 </B><DD>Indicates each command for which to display the complete online help
  42 entry. Omit the <B>kas</B> part of the command name, providing only
  43 the operation code (for example, specify <B>setpassword</B>, not <B>kas
  44 setpassword</B>). If this argument is omitted, the output briefly
  45 describes every <B>kas</B> command.
  46 <P><DT><B>-help
  47 </B><DD>Prints the online help for this command. All other valid options
  48 are ignored.
  49 </DL>
  50 <P><STRONG>Output</STRONG>
  51 <P>The online help entry for each <B>kas</B> command consists of the
  52 following two or three lines:
  53 <UL>
  54 <P><LI>The first line names the command and briefly describes its
  55 function.
  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
  60 document.
  61 </UL>
  62 <P><STRONG>Examples</STRONG>
  63 <P>The following command displays the online help entry for the <B>kas
  64 setpassword</B> command:
  65 <PRE>   % <B>kas help setpassword</B>
  66    kas setpassword: set a user's password
  67    aliases: sp
  68    Usage: kas setpassword -name &lt;name of user>
  69    [-new_password &lt;new password>] [-kvno &lt;key version number>]
  70    [-admin_username &lt;admin principal to use for authentication>]
  71    [-password_for_admin &lt;password>] [-cell &lt;cell name>]
  72    [-servers &lt;explicit list of authentication servers>+] [-help]
  73
  74 </PRE>
  75 <P><STRONG>Privilege Required</STRONG>
  76 <P>None, and no password is required.
  77 <P><STRONG>Related Information</STRONG>
  78 <P><A HREF="auarf181.htm#HDRKAS_INTRO">kas</A>
  79 <P><A HREF="auarf182.htm#HDRKAS_APROPOS">kas apropos</A>
  80 <P>
  81 <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="auarf186.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="auarf188.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>
  82 <!-- Begin Footer Records  ========================================== -->
  83 <P><HR><B>
  84 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
  85 </B>
  86 <!-- End Footer Records  ============================================ -->
  87 <A NAME="Bot_Of_Page"></A>
  88 </BODY></HTML>