forked from bonsai/harakit
docs: removed unnecessary comments
This commit is contained in:
@@ -9,22 +9,25 @@
|
||||
intcmp \(en compare integers
|
||||
.\"
|
||||
.SH SYNOPSIS
|
||||
.\"
|
||||
|
||||
intcmp
|
||||
.RB ( -egl )
|
||||
.RB [ integer ]
|
||||
.RB [ integer... ]
|
||||
.SH DESCRIPTION
|
||||
Compare integers to each other.
|
||||
.\"
|
||||
.SH OPTIONS
|
||||
|
||||
.IP \fB-e\fP
|
||||
Permits given integers to be equal to each other.
|
||||
.IP \fB-g\fP
|
||||
Permits a given integer to be greater than the following integer.
|
||||
.IP \fB-l\fP
|
||||
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
|
||||
infix algebraic \(lq=\(rq, \(lq>\(rq, and \(lq<\(rq operators respectively, with
|
||||
each option putting its symbol between every given integer. The following
|
||||
@@ -35,7 +38,7 @@ example is equivalent to evaluating \(lq1 < 2 < 3\(rq:
|
||||
.RE
|
||||
.\"
|
||||
.SH DIAGNOSTICS
|
||||
.\"
|
||||
|
||||
The program will exit with a status code of 0 for a valid expression and with a
|
||||
code of 1 for an invalid expression.
|
||||
|
||||
@@ -45,14 +48,14 @@ exit with the appropriate
|
||||
error code.
|
||||
.\"
|
||||
.SH BUGS
|
||||
.\"
|
||||
|
||||
-egl, \(lqequal to or less than or greater than\(rq, exits 0 no matter what for
|
||||
valid program usage and may be abused to function as an integer validator. Use
|
||||
.BR str (1)
|
||||
instead.
|
||||
.\"
|
||||
.SH CAVEATS
|
||||
.\"
|
||||
|
||||
There are multiple ways to express compound comparisons; \(lqless than or equal
|
||||
to\(rq can be -le or -el, for example.
|
||||
|
||||
@@ -60,7 +63,7 @@ The inequality comparison is -gl or -lg for \(lqless than or greater than\(rq;
|
||||
this is elegant but unintuitive.
|
||||
.\"
|
||||
.SH RATIONALE
|
||||
.\"
|
||||
|
||||
The traditional tool for integer comparisons in POSIX and other Unix shells has
|
||||
been
|
||||
.BR test (1).
|
||||
@@ -72,7 +75,7 @@ with
|
||||
.BR test (1p).
|
||||
.\"
|
||||
.SH AUTHOR
|
||||
.\"
|
||||
|
||||
Written by DTB
|
||||
.MT trinity@trinity.moe
|
||||
.ME .
|
||||
|
||||
Reference in New Issue
Block a user