aboutsummaryrefslogtreecommitdiff
path: root/man/expr.1
blob: 4c299596501a81791672ada9a1403ae49829ece4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md.
.TH EXPR "1" "2026-07-28" "BNU 9.11" "BNU Commands"
.SH NAME
expr \- evaluate expressions
.SH SYNOPSIS
.B expr
\fI\,EXPRESSION\/\fR
.br
.B expr
\fI\,OPTION\/\fR
.SH DESCRIPTION
.\" This page is derived from GNU Coreutils documentation.
This page documents BNU, an independent Bun implementation compatible with
GNU Coreutils 9.11.
.TP
\X'tty: link https://www.gnu.org/software/coreutils/expr#expr--help'\fB\-\-help\fP\X'tty: link'
display this help and exit
.TP
\X'tty: link https://www.gnu.org/software/coreutils/expr#expr--version'\fB\-\-version\fP\X'tty: link'
output version information and exit
.PP
Print the value of EXPRESSION to standard output.  A blank line below
separates increasing precedence groups.  EXPRESSION may be:
.TP
ARG1 | ARG2
ARG1 if it is neither null nor 0, otherwise ARG2
.TP
ARG1 & ARG2
ARG1 if neither argument is null or 0, otherwise 0
.TP
ARG1 < ARG2
ARG1 is less than ARG2
.TP
ARG1 <= ARG2
ARG1 is less than or equal to ARG2
.TP
ARG1 = ARG2
ARG1 is equal to ARG2
.TP
ARG1 != ARG2
ARG1 is unequal to ARG2
.TP
ARG1 >= ARG2
ARG1 is greater than or equal to ARG2
.TP
ARG1 > ARG2
ARG1 is greater than ARG2
.TP
ARG1 + ARG2
arithmetic sum of ARG1 and ARG2
.TP
ARG1 \- ARG2
arithmetic difference of ARG1 and ARG2
.TP
ARG1 * ARG2
arithmetic product of ARG1 and ARG2
.TP
ARG1 / ARG2
arithmetic quotient of ARG1 divided by ARG2
.TP
ARG1 % ARG2
arithmetic remainder of ARG1 divided by ARG2
.TP
STRING : REGEXP
anchored pattern match of REGEXP in STRING
.TP
match STRING REGEXP
same as STRING : REGEXP
.TP
substr STRING POS LENGTH
substring of STRING, POS counted from 1
.TP
index STRING CHARS
index in STRING where any CHARS is found, or 0
.TP
length STRING
length of STRING
.TP
+ TOKEN
interpret TOKEN as a string, even if it is a
keyword like 'match' or an operator like '/'
.TP
( EXPRESSION )
value of EXPRESSION
.PP
Beware that many operators need to be escaped or quoted for shells.
Comparisons are arithmetic if both ARGs are numbers, else lexicographical.
Pattern matches return the string matched between \e( and \e) or null; if
\e( and \e) are not used, they return the number of characters matched or 0.
.PP
Exit status is 0 if EXPRESSION is neither null nor 0, 1 if EXPRESSION is null
or 0, 2 if EXPRESSION is syntactically invalid, and 3 if an error occurred.
.SH AUTHORS
Upstream GNU Coreutils documentation authors:
Written by Mike Parker, James Youngman, and Paul Eggert.
.br
Adapted for BNU; the BNU implementation is independent.
.SH "REPORTING BUGS"
Report BNU bugs at <https://github.com/Soccera1/bnu/issues>.
.br
For upstream GNU Coreutils, see <https://www.gnu.org/software/coreutils/>.
.SH COPYRIGHT
Copyright \(co 2026 Free Software Foundation, Inc.
.br
This manual page was adapted for BNU in 2026.
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
Upstream documentation <https://www.gnu.org/software/coreutils/expr>
.br
BNU documentation is available locally via: info \(aq(bnu) expr invocation\(aq