summaryrefslogtreecommitdiffstats
path: root/txr.1
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2014-07-02 07:17:45 -0700
committerKaz Kylheku <kaz@kylheku.com>2014-07-02 07:17:45 -0700
commit20e75858d4c1e971b6b577fdf3b97b3005fc8328 (patch)
treebd043976346aadff6ee9e17ec13dffdbf4afe8c1 /txr.1
parent70b8d2eceb191a126aa12f242cd0ec449fc98465 (diff)
downloadtxr-20e75858d4c1e971b6b577fdf3b97b3005fc8328.tar.gz
txr-20e75858d4c1e971b6b577fdf3b97b3005fc8328.tar.bz2
txr-20e75858d4c1e971b6b577fdf3b97b3005fc8328.zip
* txr.1: Documented usleep.
Diffstat (limited to 'txr.1')
-rw-r--r--txr.121
1 files changed, 21 insertions, 0 deletions
diff --git a/txr.1 b/txr.1
index 53557fa6..801c5f5f 100644
--- a/txr.1
+++ b/txr.1
@@ -13828,6 +13828,27 @@ EXIT_FAILURE, and t corresponds to EXIT_SUCCESS. These are platform-independent
indicators of failed or successful termination. The numeric value 0 also
indicates success.
+.SS Function usleep
+
+.TP
+Syntax:
+
+ (usleep <usec>)
+
+.TP
+Description:
+
+The usleep function suspends the execution of the program for at least
+<usec> microseconds.
+
+The return value is t if the sleep was successfully executed. A nil
+value indicates premature wakup or complete failure.
+
+Note: the actual sleep resolution is not guaranteed, and depends on granularity
+of the system timer. Actual sleep times may be rounded up to the nearest 10
+millisecond multiple on a system where timed suspensions are triggered by a 100
+Hz tick.
+
.SS Function mkdir
.TP