summaryrefslogtreecommitdiffstats
path: root/doc/src/05100-lib-read.md
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2017-08-12 15:48:00 +0000
committerMatthias Beyer <mail@beyermatthias.de>2017-08-12 15:48:00 +0000
commita96eb69b0f1cb0f64b625881522bad58136c3f3b (patch)
treea7ddd9f757c35dac11de0f15fd538c6ebe22fcc3 /doc/src/05100-lib-read.md
parentd78288e6f78040590a2c6aceb3518b36c451c1a2 (diff)
downloadimag-a96eb69b0f1cb0f64b625881522bad58136c3f3b.tar.gz
imag-a96eb69b0f1cb0f64b625881522bad58136c3f3b.tar.xz
Diffstat (limited to 'doc/src/05100-lib-read.md')
-rw-r--r--doc/src/05100-lib-read.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/src/05100-lib-read.md b/doc/src/05100-lib-read.md
index 017654c3..1b5cd9f8 100644
--- a/doc/src/05100-lib-read.md
+++ b/doc/src/05100-lib-read.md
@@ -1,2 +1,10 @@
## libimagread
+This library is for the plumbing command `imag-read`.
+
+It extends the `Runtime` object and adds a `write_store_to(writer)` function (amongst others). After calling this function, the calling program cannot continue to do things, so this consumes the `Runtime` object and the calling program is expected to exit with the returned error code.
+
+The calling program is expected to _not_ print anything to stdout before or after calling this function.
+
+This library is intended for use with the `imag-read` command only.
+