diff --git a/docs/intcmp.1 b/docs/intcmp.1 index 94e88a4..2808362 100644 --- a/docs/intcmp.1 +++ b/docs/intcmp.1 @@ -28,19 +28,23 @@ Permits a given integer to be less than the following integer. .\" .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 -example is equivalent to evaluating \(lq1 < 2 < 3\(rq: +It may help to think of the +.BR -e , +.BR -g , +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 -.R intcmp -l 1 2 3 +intcmp -l 1 2 3 .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. +The program will exit with a successfully for a valid expression and with an +error code of 1 for an invalid expression. In the event of an error, a debug message will be printed and the program will exit with the appropriate @@ -49,7 +53,8 @@ error code. .\" .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 .BR str (1) instead. @@ -57,9 +62,17 @@ instead. .SH CAVEATS 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. .\" .SH RATIONALE