bin/expr/expr.1

   1 .\" -*- nroff -*-
   2 .\"-
   3 .\" Copyright (c) 1993 Winning Strategies, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"      This product includes software developed by Winning Strategies, Inc.
  17 .\" 4. The name of the author may not be used to endorse or promote products
  18 .\"    derived from this software without specific prior written permission
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  21 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  22 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  23 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  29 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd July 12, 2004
  34 .Dt EXPR 1
  35 .Os
  36 .Sh NAME
  37 .Nm expr
  38 .Nd evaluate expression
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl e
  42 .Ar expression
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility evaluates
  47 .Ar expression
  48 and writes the result on standard output.
  49 .Pp
  50 All operators and operands must be passed as separate arguments.
  51 Several of the operators have special meaning to command interpreters
  52 and must therefore be quoted appropriately.
  53 All integer operands are interpreted in base 10.
  54 .Pp
  55 Arithmetic operations are performed using signed integer math.
  56 If the
  57 .Fl e
  58 flag is specified, arithmetic uses the C
  59 .Vt intmax_t
  60 data type (the largest integral type available), and
  61 .Nm
  62 will detect arithmetic overflow and return an error indication.
  63 If a numeric operand is specified which is so large as to overflow
  64 conversion to an integer, it is parsed as a string instead.
  65 If
  66 .Fl e
  67 is not specified, arithmetic operations and parsing of integer
  68 arguments will overflow silently according to the rules of the C
  69 standard, using the
  70 .Vt long
  71 data type.
  72 .Pp
  73 Operators are listed below in order of increasing precedence; all
  74 are left-associative.
  75 Operators with equal precedence are grouped within symbols
  76 .Ql {
  77 and
  78 .Ql } .
  79 .Bl -tag -width indent
  80 .It Ar expr1 Li | Ar expr2
  81 Return the evaluation of
  82 .Ar expr1
  83 if it is neither an empty string nor zero;
  84 otherwise, returns the evaluation of
  85 .Ar expr2 .
  86 .It Ar expr1 Li & Ar expr2
  87 Return the evaluation of
  88 .Ar expr1
  89 if neither expression evaluates to an empty string or zero;
  90 otherwise, returns zero.
  91 .It Ar expr1 Li "{=, >, >=, <, <=, !=}" Ar expr2
  92 Return the results of integer comparison if both arguments are integers;
  93 otherwise, returns the results of string comparison using the locale-specific
  94 collation sequence.
  95 The result of each comparison is 1 if the specified relation is true,
  96 or 0 if the relation is false.
  97 .It Ar expr1 Li "{+, -}" Ar expr2
  98 Return the results of addition or subtraction of integer-valued arguments.
  99 .It Ar expr1 Li "{*, /, %}" Ar expr2
 100 Return the results of multiplication, integer division, or remainder of integer-valued arguments.
 101 .It Ar expr1 Li : Ar expr2
 102 The
 103 .Dq Li \&:
 104 operator matches
 105 .Ar expr1
 106 against
 107 .Ar expr2 ,
 108 which must be a basic regular expression.
 109 The regular expression is anchored
 110 to the beginning of the string with an implicit
 111 .Dq Li ^ .
 112 .Pp
 113 If the match succeeds and the pattern contains at least one regular
 114 expression subexpression
 115 .Dq Li "\e(...\e)" ,
 116 the string corresponding to
 117 .Dq Li \e1
 118 is returned;
 119 otherwise the matching operator returns the number of characters matched.
 120 If the match fails and the pattern contains a regular expression subexpression
 121 the null string is returned;
 122 otherwise 0.
 123 .El
 124 .Pp
 125 Parentheses are used for grouping in the usual manner.
 126 .Pp
 127 The
 128 .Nm
 129 utility makes no lexical distinction between arguments which may be
 130 operators and arguments which may be operands.
 131 An operand which is lexically identical to an operator will be considered a
 132 syntax error.
 133 See the examples below for a work-around.
 134 .Pp
 135 The syntax of the
 136 .Nm
 137 command in general is historic and inconvenient.
 138 New applications are advised to use shell arithmetic rather than
 139 .Nm .
 140 .Ss Compatibility with previous implementations
 141 Unless
 142 .Fx
 143 4.x
 144 compatibility is enabled, this version of
 145 .Nm
 146 adheres to the
 147 .Tn POSIX
 148 Utility Syntax Guidelines, which require that a leading argument beginning
 149 with a minus sign be considered an option to the program.
 150 The standard
 151 .Fl Fl
 152 syntax may be used to prevent this interpretation.
 153 However, many historic implementations of
 154 .Nm ,
 155 including the one in previous versions of
 156 .Fx ,
 157 will not permit this syntax.
 158 See the examples below for portable ways to guarantee the correct
 159 interpretation.
 160 The
 161 .Xr check_utility_compat 3
 162 function (with a
 163 .Fa utility
 164 argument of
 165 .Dq Li expr )
 166 is used to determine whether compatibility mode should be enabled.
 167 This feature is intended for use as a transition and debugging aid, when
 168 .Nm
 169 is used in complex scripts which cannot easily be recast to avoid the
 170 non-portable usage.
 171 Enabling compatibility mode
 172 also implicitly enables the
 173 .Fl e
 174 option, since this matches the historic behavior of
 175 .Nm
 176 in
 177 .Fx .
 178 For historical reasons, defining the environment variable
 179 .Ev EXPR_COMPAT
 180 also enables compatibility mode.
 181 .Sh ENVIRONMENT
 182 .Bl -tag -width ".Ev EXPR_COMPAT"
 183 .It Ev EXPR_COMPAT
 184 If set, enables compatibility mode.
 185 .El
 186 .Sh EXIT STATUS
 187 The
 188 .Nm
 189 utility exits with one of the following values:
 190 .Bl -tag -width indent -compact
 191 .It 0
 192 the expression is neither an empty string nor 0.
 193 .It 1
 194 the expression is an empty string or 0.
 195 .It 2
 196 the expression is invalid.
 197 .El
 198 .Sh EXAMPLES
 199 .Bl -bullet
 200 .It
 201 The following example (in
 202 .Xr sh 1
 203 syntax) adds one to the variable
 204 .Va a :
 205 .Dl "a=$(expr $a + 1)"
 206 .It
 207 This will fail if the value of
 208 .Va a
 209 is a negative number.
 210 To protect negative values of
 211 .Va a
 212 from being interpreted as options to the
 213 .Nm
 214 command, one might rearrange the expression:
 215 .Dl "a=$(expr 1 + $a)"
 216 .It
 217 More generally, parenthesize possibly-negative values:
 218 .Dl "a=$(expr \e( $a \e) + 1)"
 219 .It
 220 This example prints the filename portion of a pathname stored
 221 in variable
 222 .Va a .
 223 Since
 224 .Va a
 225 might represent the path
 226 .Pa / ,
 227 it is necessary to prevent it from being interpreted as the division operator.
 228 The
 229 .Li //
 230 characters resolve this ambiguity.
 231 .Dl "expr \*q//$a\*q \&: '.*/\e(.*\e)'"
 232 .El
 233 .Pp
 234 The following examples output the number of characters in variable
 235 .Va a .
 236 Again, if
 237 .Va a
 238 might begin with a hyphen, it is necessary to prevent it from being
 239 interpreted as an option to
 240 .Nm .
 241 .Bl -bullet
 242 .It
 243 If the
 244 .Nm
 245 command conforms to
 246 .St -p1003.1-2001 ,
 247 this is simple:
 248 .Dl "expr -- \*q$a\*q \&: \*q.*\*q"
 249 .It
 250 For portability to older systems, however, a more complicated command
 251 is required:
 252 .Dl "expr \e( \*qX$a\*q \&: \*q.*\*q \e) - 1"
 253 .El
 254 .Sh SEE ALSO
 255 .Xr sh 1 ,
 256 .Xr test 1 ,
 257 .Xr check_utility_compat 3
 258 .Sh STANDARDS
 259 The
 260 .Nm
 261 utility conforms to
 262 .St -p1003.1-2001 ,
 263 provided that compatibility mode is not enabled.
 264 The
 265 .Fl e
 266 flag is an extension.