summaryrefslogtreecommitdiffstats
path: root/txr.1
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2017-07-08 21:04:07 -0700
committerKaz Kylheku <kaz@kylheku.com>2017-07-08 21:04:07 -0700
commit730f560580ab1a347f034546807de2bc1535c93d (patch)
tree6eee7e9930b8c7d9fefbc075a06b42604496e6fc /txr.1
parent37ca74d53d7f69d4288fba4ae65b5479a9fad51c (diff)
downloadtxr-730f560580ab1a347f034546807de2bc1535c93d.tar.gz
txr-730f560580ab1a347f034546807de2bc1535c93d.tar.bz2
txr-730f560580ab1a347f034546807de2bc1535c93d.zip
doc: change Buffers heading.
* txr.1: This change to the buffers heading causes the buf identifier to be cross-referenced, which is useful to people browsing the FFI section. Fixing some wording too.
Diffstat (limited to 'txr.1')
-rw-r--r--txr.113
1 files changed, 9 insertions, 4 deletions
diff --git a/txr.1 b/txr.1
index 82c6ee4f..ac5da841 100644
--- a/txr.1
+++ b/txr.1
@@ -52931,11 +52931,16 @@ named
.codn RTLD_LOCAL ,
.IR "et cetera" .
-.SS* Buffers
+.coSS The @ buf type
-Buffers are vector-like objects specialized for holding binary data. Buffers
-support operations specialized toward the encoding of Lisp values into
-machine-oriented data types, and decoding such data types into Lisp values.
+Object of the type
+.code buf
+are
+.IR buffers :
+vector-like objects specialized for holding binary data represented as
+a sequence of 8 bit bytes. Buffers support operations specialized toward the
+encoding of Lisp values into machine-oriented data types, and decoding such
+data types into Lisp values.
Buffers are particularly useful in conjunction with the Foreign Function
Interface (FFI), since they can be used to prepare arbitrary data which