summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2019-07-18 23:36:32 -0700
committerKaz Kylheku <kaz@kylheku.com>2019-07-18 23:36:32 -0700
commit08a07c137d7c4f31de234fe76cd3ad013d012450 (patch)
tree27e19c86728a159c184f43bec862da26a1e01968
parent0717edbd26a75442d0aa8695d140243ec0b69b5d (diff)
downloadtxr-08a07c137d7c4f31de234fe76cd3ad013d012450.tar.gz
txr-08a07c137d7c4f31de234fe76cd3ad013d012450.tar.bz2
txr-08a07c137d7c4f31de234fe76cd3ad013d012450.zip
doc: ffi-in offset argument description missing.
* txr.1: Document the offset argument of the ffi-in operation.
-rw-r--r--txr.110
1 files changed, 9 insertions, 1 deletions
diff --git a/txr.1 b/txr.1
index 7c34fb88..83fe303b 100644
--- a/txr.1
+++ b/txr.1
@@ -64714,7 +64714,7 @@ will be stored in the buffer.
.coNP Function @ ffi-in
.synb
-.mets (ffi-in < src-buf < obj < type << copy-p )
+.mets (ffi-in < src-buf < obj < type < copy-p <> [ offset ])
.syne
.desc
The
@@ -64775,6 +64775,14 @@ is has a variable length, then the actual size of the foreign representation is
calculated from
.metn obj .
+The optional
+.meta offset
+argument specifies a byte offset from the beginning of the data area of
+.meta src-buf
+from which the foreign-representation of
+.meta obj
+is taken.
+
The
.code ffi-in
function returns either