From ad33ab41d57169fdd15b1867f363b4987be69dfb Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Thu, 11 Feb 2016 13:47:47 +0100 Subject: improve readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/README b/README index a8941ca..3ecc1a8 100644 --- a/README +++ b/README @@ -1,2 +1,46 @@ -Optimised implementations of true(1) and false(1). +NAME + true - return true value + false - return false value + +SYNOPSIS + true [ignored arguments] + false [ignored arguments] + +DESCRIPTION + Optimised implementations of true(1p) and false(1p). + true and false shall do nothing, successfully and + unsuccessfully, respectively. + + If your microarchitecture is especially supported, + true and false are implemented in assembler, without + a C runtime and only requires one page of memory. + + If your microarchitecture is not especially supported, + true and false are implemented in C using only a + return statement in the main function. In this case, + a C runtime is used which slows down the program + significantly and it is usually required that somewhere + around 400 KB to 800 KB of memory is used (that is + about 150 pages.) + +OPTIONS + None. + +EXIT STATUS + true shall exit with the status 0. + false shall exit with any value other than 0. + In this implement false exits with the status 1. + +RATIONALE + None. + +NOTES + Your shell may have its own verions of true(1p) + and false(1p). + +BUGS + None. These programs are about as simple as it gets. + +SEE ALSO + true(1p), false(1p) -- cgit v1.2.3-70-g09d2