trinity/overgrown
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

intcmp.1: bold

Browse Source
This commit is contained in:
Emma Tebibyte 2024-06-17 23:27:19 -06:00
parent 59eee27979
commit e38dcc09b1
Signed by untrusted user: emma
GPG Key ID: 06FA419A1698C270
1 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/intcmp.1
View File

@ -28,19 +28,23 @@ Permits a given integer to be less than the following integer.
.\" .\"
.SH EXAMPLES .SH EXAMPLES
It may help to think of the -e, -g, and -l options as equivalent to the It may help to think of the
infix algebraic \(lq=\(rq, \(lq>\(rq, and \(lq<\(rq operators respectively, with .BR -e ,
each option putting its symbol between every given integer. The following .BR -g ,
example is equivalent to evaluating \(lq1 < 2 < 3\(rq: and
.B -l
options as equivalent to the infix algebraic \(lq=\(rq, \(lq>\(rq, and \(lq<\(rq
operators respectively, with each option putting its symbol between every given
integer. The following example is equivalent to evaluating \(lq1 < 2 < 3\(rq:
\" \"
.RS .RS
.R intcmp -l 1 2 3 intcmp -l 1 2 3
.RE .RE
.\" .\"
.SH DIAGNOSTICS .SH DIAGNOSTICS
The program will exit with a status code of 0 for a valid expression and with a The program will exit with a successfully for a valid expression and with an
code of 1 for an invalid expression. error code of 1 for an invalid expression.
In the event of an error, a debug message will be printed and the program will In the event of an error, a debug message will be printed and the program will
exit with the appropriate exit with the appropriate
@ -49,7 +53,8 @@ error code.
.\" .\"
.SH BUGS .SH BUGS
-egl, \(lqequal to or less than or greater than\(rq, exits 0 no matter what for .BR -egl ,
\(lqequal to or less than or greater than\(rq, always exits successfully for
valid program usage and may be abused to function as an integer validator. Use valid program usage and may be abused to function as an integer validator. Use
.BR str (1) .BR str (1)
instead. instead.
@ -57,9 +62,17 @@ instead.
.SH CAVEATS .SH CAVEATS
There are multiple ways to express compound comparisons; \(lqless than or equal There are multiple ways to express compound comparisons; \(lqless than or equal
to\(rq can be -le or -el, for example. to\(rq can be
.B -le
or
.BR -el ,
for example.
The inequality comparison is -gl or -lg for \(lqless than or greater than\(rq; The inequality comparison is
.B -gl
.B or
.B -lg
for \(lqless than or greater than\(rq;
this is elegant but unintuitive. this is elegant but unintuitive.
.\" .\"
.SH RATIONALE .SH RATIONALE