usr/src/man/man1/ckkeywd.1

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1992, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH CKKEYWD 1 "Sep 14, 1992"
   7 .SH NAME
   8 ckkeywd \- prompts for and validates a keyword
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBckkeywd\fR [\fB-Q\fR] [\fB-W\fR \fIwidth\fR] [\fB-d\fR \fIdefault\fR] [\fB-h\fR \fIhelp\fR] [\fB-e\fR \fIerror\fR]
  13      [\fB-p\fR \fIprompt\fR] [\fB-k\fR \fIpid\fR [\fB-s\fR \fIsignal\fR]] \fIkeyword\fR [...]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 \fBckkeywd\fR prompts a user and validates the response. It defines, among
  20 other things, a prompt message whose response should be one  of a list of
  21 keywords, text for help and error messages, and a default value (which will be
  22 returned if the user responds with a carriage return).  The answer returned
  23 from this command must match one of the defined list of keywords.
  24 .sp
  25 .LP
  26 All messages are limited in length to 70 characters and are formatted
  27 automatically. Any white space used in the definition (including newline) is
  28 stripped.  The \fB-W\fR option cancels the automatic formatting. When a tilde
  29 is placed at the beginning or end of a message definition, the default text
  30 will be inserted at that point, allowing both custom text and the default text
  31 to be displayed.
  32 .sp
  33 .LP
  34 If the prompt, help or error message is not defined, the default message (as
  35 defined under \fBNOTES\fR) will be displayed.
  36 .SH OPTIONS
  37 .sp
  38 .LP
  39 The following options are supported:
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fB-d\fR\fI default\fR\fR
  44 .ad
  45 .RS 14n
  46 Defines the default value as \fIdefault\fR. The default is not validated and so
  47 does not have to meet any criteria.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fB-e\fR\fI error\fR\fR
  54 .ad
  55 .RS 14n
  56 Defines the error message as \fI error\fR.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fB-h\fR\fI help\fR\fR
  63 .ad
  64 .RS 14n
  65 Defines the help messages as \fI help\fR.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fB-k\fR\fI pid\fR\fR
  72 .ad
  73 .RS 14n
  74 Specifies that process  \fBID\fR \fIpid\fR is to be sent a signal if the user
  75 chooses to abort.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fB-p\fR\fI prompt\fR\fR
  82 .ad
  83 .RS 14n
  84 Defines the prompt message as \fIprompt\fR.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fB-Q\fR\fR
  91 .ad
  92 .RS 14n
  93 Specifies that quit will not be allowed as a valid response.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fB-s\fR\fI signal\fR\fR
 100 .ad
 101 .RS 14n
 102 Specifies that the process  \fBID\fR \fIpid\fR defined with the \fB-k\fR option
 103 is to be sent signal \fI signal\fR when quit is chosen. If no signal is
 104 specified, \fBSIGTERM\fR is used.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fB-W\fR\fI width\fR\fR
 111 .ad
 112 .RS 14n
 113 Specifies that prompt, help and error messages will be formatted to a line
 114 length of \fIwidth\fR.
 115 .RE
 116
 117 .SH OPERANDS
 118 .sp
 119 .LP
 120 The following operand is supported:
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fIkeyword\fR\fR
 125 .ad
 126 .RS 11n
 127 Defines the keyword, or list of keywords, against which the answer will be
 128 verified.
 129 .RE
 130
 131 .SH EXIT STATUS
 132 .sp
 133 .LP
 134 The following exit values are returned:
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fB0\fR\fR
 139 .ad
 140 .RS 5n
 141 Successful execution.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fB1\fR\fR
 148 .ad
 149 .RS 5n
 150 \fBEOF\fR on input, or negative width on \fB-W\fR option, or no keywords from
 151 which to choose, or usage error.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB3\fR\fR
 158 .ad
 159 .RS 5n
 160 User termination (quit).
 161 .RE
 162
 163 .SH SEE ALSO
 164 .sp
 165 .LP
 166 \fBattributes\fR(5)
 167 .SH NOTES
 168 .sp
 169 .LP
 170 The default prompt for \fBckkeywd\fR is:
 171 .sp
 172 .in +2
 173 .nf
 174 Enter appropriate value [\fIkeyword\fR,[\|.\|.\|.\|],?,q]:
 175 .fi
 176 .in -2
 177 .sp
 178
 179 .sp
 180 .LP
 181 The default error message is:
 182 .sp
 183 .in +2
 184 .nf
 185 ERROR: Please enter one of the following keywords: \fIkeyword\fR,[\|.\|.\|.\|],q
 186 .fi
 187 .in -2
 188 .sp
 189
 190 .sp
 191 .LP
 192 The default help message is:
 193 .sp
 194 .in +2
 195 .nf
 196 \fIkeyword\fR\fB,[\|.\|.\|.\|],q\fR
 197 .fi
 198 .in -2
 199 .sp
 200
 201 .sp
 202 .LP
 203 When the quit option is chosen (and allowed), \fBq\fR is returned along with
 204 the return code \fB3\fR.