usr/src/man/man1/ckdate.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 CKDATE 1 "Sep 14, 1992"
   7 .SH NAME
   8 ckdate, errdate, helpdate, valdate \- prompts for and validates a date
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBckdate\fR [\fB-Q\fR] [\fB-W\fR \fIwidth\fR] [\fB-f\fR \fIformat\fR] [\fB-d\fR \fIdefault\fR] [\fB-h\fR \fIhelp\fR]
  13      [\fB-e\fR \fIerror\fR] [\fB-p\fR \fIprompt\fR] [\fB-k\fR \fIpid\fR [\fB-s\fR \fIsignal\fR]]
  14 .fi
  15
  16 .LP
  17 .nf
  18 \fB/usr/sadm/bin/errdate\fR [\fB-W\fR \fIwidth\fR] [\fB-e\fR \fIerror\fR] [\fB-f\fR \fIformat\fR]
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fB/usr/sadm/bin/helpdate\fR [\fB-W\fR \fIwidth\fR] [\fB-h\fR \fIhelp\fR] [\fB-f\fR \fIformat\fR]
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fB/usr/sadm/bin/valdate\fR [\fB-f\fR \fIformat\fR] \fIinput\fR
  29 .fi
  30
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  34 The \fBckdate\fR utility prompts a user and validates the response. It defines,
  35 among other things, a prompt message whose response should be a date, text for
  36 help and error messages, and a default value (which will be returned if the
  37 user responds with a  RETURN). The user response must match the defined format
  38 for a date.
  39 .sp
  40 .LP
  41 All messages are limited in length to 70 characters and are formatted
  42 automatically. Any white space used in the definition (including newline) is
  43 stripped. The \fB-W\fR option cancels the automatic formatting. When a tilde is
  44 placed at the beginning or end of a message definition, the default text will
  45 be inserted at that point, allowing both custom text and the default text to be
  46 displayed.
  47 .sp
  48 .LP
  49 If the prompt, help or error message is not defined, the default message (as
  50 defined under \fBNOTES\fR) will be displayed.
  51 .sp
  52 .LP
  53 Three visual tool modules are linked to the \fBckdate\fR command. They are
  54 \fBerrdate\fR (which formats and displays an error message), \fBhelpdate\fR
  55 (which formats and displays a help message), and \fBvaldate\fR (which validates
  56 a response). These modules should be used in conjunction with FML objects. In
  57 this instance, the FML object defines the prompt. When \fBformat\fR is defined
  58 in the \fBerrdate\fR and \fBhelpdate\fR modules, the messages will describe the
  59 expected format.
  60 .SH OPTIONS
  61 .sp
  62 .LP
  63 The following options are supported:
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fB-d\fR \fIdefault\fR\fR
  68 .ad
  69 .RS 14n
  70 Defines the default value as \fIdefault\fR. The default does not have to meet
  71 the format criteria.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fB-e\fR \fIerror\fR\fR
  78 .ad
  79 .RS 14n
  80 Defines the error message as \fIerror\fR.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fB-f\fR \fIformat\fR\fR
  87 .ad
  88 .RS 14n
  89 Specifies the format against which the input will be verified. Possible formats
  90 and their definitions are:
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB%b\fR  =\fR
  95 .ad
  96 .RS 9n
  97 abbreviated month name (jan, feb, mar)
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fB%B\fR  =\fR
 104 .ad
 105 .RS 9n
 106 full month name \fB%d\fR  = day of month (01 - 31)
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fB%D\fR  =\fR
 113 .ad
 114 .RS 9n
 115 date as %m/%d/%y (the default format)
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fB%e\fR  =\fR
 122 .ad
 123 .RS 9n
 124 day of month (1 - 31; single digits are preceded by a blank)
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fB%h\fR  =\fR
 131 .ad
 132 .RS 9n
 133 abbreviated month name, identical to \fB%b%\fR
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fB%m\fR  =\fR
 140 .ad
 141 .RS 9n
 142 month number (01 - 12)
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fB%y\fR  =\fR
 149 .ad
 150 .RS 9n
 151 year within century (for instance, 89)
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB%Y\fR  =\fR
 158 .ad
 159 .RS 9n
 160 year as \fBCCYY\fR (for instance, 1989)
 161 .RE
 162
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fB-h\fR\fI help\fR\fR
 169 .ad
 170 .RS 14n
 171 Defines the help messages as \fBhelp\fR.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fB-k\fR\fI pid\fR\fR
 178 .ad
 179 .RS 14n
 180 Specifies that process \fBID\fR \fIpid\fR is to be sent a signal if the user
 181 chooses to abort.
 182 .RE
 183
 184 .sp
 185 .ne 2
 186 .na
 187 \fB\fB-p\fR\fI prompt\fR\fR
 188 .ad
 189 .RS 14n
 190 Defines the prompt message as \fIprompt\fR.
 191 .RE
 192
 193 .sp
 194 .ne 2
 195 .na
 196 \fB\fB-Q\fR\fR
 197 .ad
 198 .RS 14n
 199 Specifies that quit will not be allowed as a valid response.
 200 .RE
 201
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fB-s\fR\fI signal\fR\fR
 206 .ad
 207 .RS 14n
 208 Specifies that the process \fBID\fR \fIpid\fR defined with the \fB-k\fR option
 209 is to be sent signal \fBsignal\fR when quit is chosen.  If no signal is
 210 specified, \fBSIGTERM\fR is used.
 211 .RE
 212
 213 .sp
 214 .ne 2
 215 .na
 216 \fB\fB-W\fR\fI width\fR\fR
 217 .ad
 218 .RS 14n
 219 Specifies that prompt, help and error messages will be formatted to a line
 220 length of \fBwidth\fR.
 221 .RE
 222
 223 .SH OPERANDS
 224 .sp
 225 .LP
 226 The following operand is supported:
 227 .sp
 228 .ne 2
 229 .na
 230 \fB\fIinput\fR\fR
 231 .ad
 232 .RS 9n
 233 Input to be verified against format criteria.
 234 .RE
 235
 236 .SH EXIT STATUS
 237 .sp
 238 .LP
 239 The following exit values are returned:
 240 .sp
 241 .ne 2
 242 .na
 243 \fB\fB0\fR\fR
 244 .ad
 245 .RS 5n
 246 Successful execution.
 247 .RE
 248
 249 .sp
 250 .ne 2
 251 .na
 252 \fB\fB1\fR\fR
 253 .ad
 254 .RS 5n
 255 \fBEOF\fR on input, or negative width on  \fB-W\fR option, or usage error.
 256 .RE
 257
 258 .sp
 259 .ne 2
 260 .na
 261 \fB\fB3\fR\fR
 262 .ad
 263 .RS 5n
 264 User termination (quit).
 265 .RE
 266
 267 .sp
 268 .ne 2
 269 .na
 270 \fB\fB4\fR\fR
 271 .ad
 272 .RS 5n
 273 Garbled format argument.
 274 .RE
 275
 276 .SH SEE ALSO
 277 .sp
 278 .LP
 279 \fBattributes\fR(5)
 280 .SH NOTES
 281 .sp
 282 .LP
 283 The default prompt for \fBckdate\fR is:
 284 .sp
 285 .in +2
 286 .nf
 287 Enter the date [?,q]:
 288 .fi
 289 .in -2
 290 .sp
 291
 292 .sp
 293 .LP
 294 The default error message is:
 295 .sp
 296 .in +2
 297 .nf
 298 ERROR - Please enter a date.  Format is <format>.
 299 .fi
 300 .in -2
 301 .sp
 302
 303 .sp
 304 .LP
 305 The default help message is:
 306 .sp
 307 .in +2
 308 .nf
 309 Please enter a date. Format is <format>.
 310 .fi
 311 .in -2
 312 .sp
 313
 314 .sp
 315 .LP
 316 When the quit option is chosen (and allowed), \fBq\fR is returned along with
 317 the return code \fB3\fR. The \fBvaldate\fR module will not produce any output.
 318 It returns zero for success and non-zero for failure.