aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-02-11 13:47:47 +0100
committerMattias Andrée <maandree@kth.se>2016-02-11 13:47:47 +0100
commitad33ab41d57169fdd15b1867f363b4987be69dfb (patch)
treea07c866e2c7707ee959f622fe608bcd7da8a74fb /README
parentwhitespace (diff)
downloadoptimised-true-ad33ab41d57169fdd15b1867f363b4987be69dfb.tar.gz
optimised-true-ad33ab41d57169fdd15b1867f363b4987be69dfb.tar.bz2
optimised-true-ad33ab41d57169fdd15b1867f363b4987be69dfb.tar.xz
improve readme
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'README')
-rw-r--r--README46
1 files changed, 45 insertions, 1 deletions
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)