usr/src/man/man1b/expr.1b

   1 '\" te
   2 .\"  Copyright (c) 2000, 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 EXPR 1B "Jun 6, 2000"
   7 .SH NAME
   8 expr \- evaluate arguments as a logical, arithmetic, or string expression
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/ucb/expr\fR \fIargument\fR...
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBexpr\fR utility evaluates expressions as specified by its arguments.
  19 After evaluation, the result is written on the standard output. Each token of
  20 the expression is a separate argument, so terms of the expression must be
  21 separated by blanks. Characters special to the shell must be escaped. Note:
  22 \fB0\fR is returned to indicate a zero value, rather than the null string.
  23 Strings containing blanks or other special characters should be quoted.
  24 Integer-valued arguments may be preceded by a unary minus sign. Internally,
  25 integers are treated as 32-bit, two's-complement numbers.
  26 .sp
  27 .LP
  28 The operators and keywords are listed below. Characters that need to be escaped
  29 are preceded by `\fB\e\fR\&'. The list is in order of increasing precedence,
  30 with equal precedence operators grouped within \fB{\|}\fR symbols.
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIexpr\fR\fB \e| \fR\fIexpr\fR\fR
  35 .ad
  36 .sp .6
  37 .RS 4n
  38 Returns the evaluation of the first \fIexpr\fR if it is neither \fINULL\fR nor
  39 \fB0\fR; otherwise, returns the evaluation of the second \fIexpr\fR if it is
  40 not \fINULL\fR; otherwise, \fB0\fR.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIexpr\fR\fB \e& \fR\fIexpr\fR\fR
  47 .ad
  48 .sp .6
  49 .RS 4n
  50 Returns the first \fIexpr\fR if neither \fIexpr\fR is \fINULL\fR or \fB0\fR,
  51 otherwise returns \fB0\fR.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fIexpr\fR { \fB=,\fR \e\fB,\fR \e , \fB\e<\fR,\fB \e<=\fR,\fB != \fR}
  58 \fIexpr\fR\fR
  59 .ad
  60 .sp .6
  61 .RS 4n
  62 Returns the result of an integer comparison if both arguments are integers,
  63 otherwise returns the result of a lexical comparison.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIexpr\fR { \fB+\fR,\fB \(mi \fR} \fIexpr\fR\fR
  70 .ad
  71 .sp .6
  72 .RS 4n
  73 Addition or subtraction of integer-valued arguments.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fIexpr\fR { \fB\e\fR,\fB /\fR,\fB % \fR} \fBexpr\fR\fR
  80 .ad
  81 .sp .6
  82 .RS 4n
  83 Multiplication, division, or remainder of the integer-valued arguments.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fIstring\fR\fB : \fR\fIregular-expression\fR\fR
  90 .ad
  91 .br
  92 .na
  93 \fB\fBmatch\fR\fI string regular-expression\fR\fR
  94 .ad
  95 .sp .6
  96 .RS 4n
  97 The two forms of the matching operator above are synonymous. The matching
  98 operators \fB:\fR and \fBmatch\fR compare the first argument with the second
  99 argument which must be a regular expression. Regular expression syntax is the
 100 same as that of \fBregexp\fR(5), except that all patterns are "anchored"
 101 (treated as if they begin with \fB^\fR) and therefore \fB^\fR is not a special
 102 character, in that context. Normally, the matching operator returns the number
 103 of characters matched (\fB0\fR on failure). Alternatively, the
 104 \fB\e\|.\|.\|.\|\e\fR pattern symbols can be used to return a portion of the
 105 first argument.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBsubstr\fR \fIstring integer-1 integer-2\fR\fR
 112 .ad
 113 .sp .6
 114 .RS 4n
 115 Extracts the substring of  \fIstring\fR starting at position \fIinteger-1\fR
 116 and of length \fIinteger-2\fR characters. If \fIinteger-1\fR has a value
 117 greater than the length of \fIstring\fR, \fBexpr\fR returns a null string. If
 118 you try to extract more characters than there are in \fIstring\fR, \fBexpr\fR
 119 returns all the remaining characters from \fIstring\fR. Beware of using
 120 negative values for either \fIinteger-1\fR or \fIinteger-2\fR as  \fBexpr\fR
 121 tends to run forever in these cases.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBindex\fR \fIstring character-list\fR\fR
 128 .ad
 129 .sp .6
 130 .RS 4n
 131 Reports the first position in \fIstring\fR at which any one of the characters
 132 in \fIcharacter-list\fR matches a character in  \fIstring\fR.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBlength\fR \fIstring\fR\fR
 139 .ad
 140 .sp .6
 141 .RS 4n
 142 Returns the length (that is, the number of characters) of \fIstring\fR.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fB( expr )\fR\fR
 149 .ad
 150 .sp .6
 151 .RS 4n
 152 Parentheses may be used for grouping.
 153 .RE
 154
 155 .SH EXAMPLES
 156 .LP
 157 \fBExample 1 \fRAdding an integer to a shell variable
 158 .sp
 159 .LP
 160 Add 1 to the shell variable \fBa\fR.
 161
 162 .sp
 163 .in +2
 164 .nf
 165 \fBa='expr $a + 1'\fR
 166 .fi
 167 .in -2
 168 .sp
 169
 170 .LP
 171 \fBExample 2 \fRReturning a path name segment
 172 .sp
 173 .LP
 174 Return the last segment of a path name (that is, the filename part). Watch out
 175 for \fB/\fR alone as an argument: \fBexpr\fR will take it as the division
 176 operator (see \fBBUGS\fR below).
 177
 178 .sp
 179 .in +2
 180 .nf
 181 \fB# 'For $a equal to either "/usr/abc/file" or just "file"'
 182 expr  $a  :  '.*/\e  \e  $a\fR
 183 .fi
 184 .in -2
 185 .sp
 186
 187 .LP
 188 \fBExample 3 \fRUsing // characters to simplify the expression
 189 .sp
 190 .LP
 191 The addition of the \fB//\fR characters eliminates any ambiguity about the
 192 division operator and simplifies the whole expression.
 193
 194 .sp
 195 .in +2
 196 .nf
 197 \fB# A better representation of example 2.
 198 expr  //$a  :  '.*/\e\fR
 199 .fi
 200 .in -2
 201 .sp
 202
 203 .LP
 204 \fBExample 4 \fRReturning the value of a variable
 205 .sp
 206 .LP
 207 Returns the number of characters in \fB$VAR\fR.
 208
 209 .sp
 210 .in +2
 211 .nf
 212 \fBexpr  $VAR  :  '.*'\fR
 213 .fi
 214 .in -2
 215 .sp
 216
 217 .SH EXIT STATUS
 218 .sp
 219 .LP
 220 \fBexpr\fR returns the following exit codes:
 221 .sp
 222 .ne 2
 223 .na
 224 \fB\fB0\fR\fR
 225 .ad
 226 .RS 5n
 227 If the expression is neither  \fINULL\fR nor \fB0\fR.
 228 .RE
 229
 230 .sp
 231 .ne 2
 232 .na
 233 \fB\fB1\fR\fR
 234 .ad
 235 .RS 5n
 236 If the expression \fIis\fR \fINULL\fR or \fB0\fR.
 237 .RE
 238
 239 .sp
 240 .ne 2
 241 .na
 242 \fB\fB2\fR\fR
 243 .ad
 244 .RS 5n
 245 For invalid expressions.
 246 .RE
 247
 248 .SH SEE ALSO
 249 .sp
 250 .LP
 251 \fBsh\fR(1), \fBtest\fR(1), \fBattributes\fR(5), \fBregexp\fR(5)
 252 .SH DIAGNOSTICS
 253 .sp
 254 .ne 2
 255 .na
 256 \fB\fBsyntax\fR \fBerror\fR\fR
 257 .ad
 258 .RS 24n
 259 for operator/operand errors
 260 .RE
 261
 262 .sp
 263 .ne 2
 264 .na
 265 \fB\fBnon-numeric argument\fR\fR
 266 .ad
 267 .RS 24n
 268 if arithmetic is attempted on such a string
 269 .RE
 270
 271 .sp
 272 .ne 2
 273 .na
 274 \fB\fBdivision by zero\fR\fR
 275 .ad
 276 .RS 24n
 277 if an attempt to divide by zero is made
 278 .RE
 279
 280 .SH BUGS
 281 .sp
 282 .LP
 283 After argument processing by the shell, \fBexpr\fR cannot tell the difference
 284 between an operator and an operand except by the value. If \fB$a\fR is an
 285 \fB=\fR, the command:
 286 .sp
 287 .in +2
 288 .nf
 289 \fBexpr  $a  =  '='\fR
 290 .fi
 291 .in -2
 292 .sp
 293
 294 .sp
 295 .LP
 296 looks like:
 297 .sp
 298 .in +2
 299 .nf
 300 \fBexpr  =  =  =\fR
 301 .fi
 302 .in -2
 303 .sp
 304
 305 .sp
 306 .LP
 307 as the arguments are passed to \fBexpr\fR (and they will all be taken as the
 308 \fB=\fR operator). The following works:
 309 .sp
 310 .in +2
 311 .nf
 312 \fBexpr  X$a  =  X=\fR
 313 .fi
 314 .in -2
 315 .sp
 316
 317 .sp
 318 .LP
 319 Note: the \fBmatch\fR, \fBsubstr\fR, \fBlength\fR, and \fBindex\fR operators
 320 cannot themselves be used as ordinary strings.  That is, the expression:
 321 .sp
 322 .in +2
 323 .nf
 324 example% \fBexpr index expurgatorious length\fR
 325 syntax error
 326 example%
 327 .fi
 328 .in -2
 329 .sp
 330
 331 .sp
 332 .LP
 333 generates the `\fBsyntax error\fR' message as shown instead of the value
 334 \fB1\fR as you might expect.