iceauth/man/iceauth.man

   1 .\" Copyright 1994, 1998  The Open Group
   2 .\"
   3 .\" Permission to use, copy, modify, distribute, and sell this software and its
   4 .\" documentation for any purpose is hereby granted without fee, provided that
   5 .\" the above copyright notice appear in all copies and that both that
   6 .\" copyright notice and this permission notice appear in supporting
   7 .\" documentation.
   8 .\"
   9 .\" The above copyright notice and this permission notice shall be included in
  10 .\" all copies or substantial portions of the Software.
  11 .\"
  12 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  13 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  14 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  15 .\" THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  16 .\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  17 .\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  18 .\" SOFTWARE.
  19 .\"
  20 .\" Except as contained in this notice, the name of The Open Group shall not
  21 .\" be used in advertising or otherwise to promote the sale, use or other
  22 .\" dealing in this Software without prior written authorization from the
  23 .\" The Open Group.
  24 .\"
  25 .TH ICEAUTH 1 __xorgversion__
  26 .SH NAME
  27 iceauth \- ICE authority file utility
  28 .SH SYNOPSIS
  29 .B iceauth
  30 [ \fB\-f\fP \fIauthfile\fP ] [ \fB\-vqib\fP ] [ \fIcommand arg ...\fP ]
  31 .SH DESCRIPTION
  32 .PP
  33 The \fIiceauth\fP program is used to edit and display the authorization
  34 information used in connecting with ICE.  This program is usually
  35 used to extract authorization records from one machine and merge them in on
  36 another (as is the case when using remote logins or granting access to
  37 other users).  Commands (described below) may be entered interactively,
  38 on the \fIiceauth\fP command line, or in scripts.
  39 .SH OPTIONS
  40 .PP
  41 \fB\-f\fP \fIauthfile\fP  Name of the authority file to use. Will default to
  42              the file currently in use by the session.
  43 .PP
  44 \fB\-v\fP           Turns on extra messages (verbose mode)
  45 .PP
  46 \fB\-q\fP           Turns off extra messages (quiet mode)
  47 .PP
  48 \fB\-i\fP           Ignore the locks on the authority file
  49 .PP
  50 \fB\-b\fP           Break the locks on the authority file
  51 .PP
  52 \fB\-u\fP           Print basic usage instructions
  53 .PP
  54 .SH USAGE
  55 .PP
  56 When \fIiceauth\fP is run it will allow the following set of commands
  57 to be entered interactively or in scripts.
  58 .PP
  59 \fB?\fP
  60 .PP
  61 List available commands.
  62 .PP
  63 \fBhelp\fP
  64 .PP
  65 Print help information. You may supply a command name to \fIhelp\fP to
  66 get specific information about it.
  67 .PP
  68 \fBinfo\fP
  69 .PP
  70 Print information about the entries in the authority file.
  71 .PP
  72 \fBlist\fP
  73 .PP
  74 List (print) entries in the authority file. You may specify optional
  75 modifiers as below to specify which entries are listed.
  76 .PP
  77 \fIlist\fP [ \fIprotocol_name\fP ] [ \fIprotocol_data\fP ] [
  78 \fInetid\fP ] [ \fIauthname\fP ]
  79 .PP
  80 \fBadd\fP
  81 .PP
  82 Add an entry to the authority file. This must be in the format
  83 .PP
  84 \fIadd\fP \fIprotocol_name\fP \fIprotocol_data\fP \fInetid\fP \fIauthname\fP \fIauthdata\fP
  85 .PP
  86 \fBremove\fP
  87 .PP
  88 Remove entries from the authority file.
  89 .PP
  90 \fIremove\fP [ \fIprotocol_name\fP ] [ \fIprotocol_data\fP ] [
  91 \fInetid\fP ] [ \fIauthname\fP ]
  92 .PP
  93 \fBextract\fP
  94 .PP
  95 Extract entries from the authority file in to a destination file. You
  96 must supply the path to the destination to this command as in the
  97 following format. Optional specifiers allow you to narrow which
  98 entries are extracted.
  99 .PP
 100 \fIextract\fP \fIfilename\fP [ \fIprotocol_name\fP ] [ \fIprotocol_data\fP ]
 101 [ \fInetid\fP ] [ \fIauthname\fP ]
 102 .PP
 103 \fBmerge\fP
 104 .PP
 105 Merge entries from other files in to the authority file selected by the program. You may supply any number of file paths to this command as follows:
 106 .PP
 107 \fImerge\fP \fIfilename1\fP [ \fIfilename2\fP ] [ \fIfilename3\fP ] ...
 108 .PP
 109 \fBexit\fP
 110 .PP
 111 Save changes and exit the program.
 112 .PP
 113 \fBquit\fP
 114 .PP
 115 Abort changes and exit the program without saving.
 116 .PP
 117 \fBsource\fP
 118 .PP
 119 Read and execute commands from a file.
 120 .PP
 121 \fIsource\fP \fIfilename\fP
 122 .PP
 123 .SH AUTHOR
 124 Ralph Mor, X Consortium