summaryrefslogtreecommitdiffstats
path: root/doc/src/05100-lib-read.md
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2017-08-25 18:34:11 +0200
committerGitHub <noreply@github.com>2017-08-25 18:34:11 +0200
commit0f436d5b88f2794159c6837cc914bd5fa8bcce55 (patch)
tree1b0a347232800c03b0c3f9c03a063222f25550b2 /doc/src/05100-lib-read.md
parent057d9192398e19f03297c094d9fbaf8932cadfa0 (diff)
parent3001288442a338fc1c829f5e4ce126ed8d5445ad (diff)
downloadimag-0f436d5b88f2794159c6837cc914bd5fa8bcce55.tar.gz
imag-0f436d5b88f2794159c6837cc914bd5fa8bcce55.tar.xz
Diffstat (limited to 'doc/src/05100-lib-read.md')
-rw-r--r--doc/src/05100-lib-read.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/src/05100-lib-read.md b/doc/src/05100-lib-read.md
new file mode 100644
index 00000000..1b5cd9f8
--- /dev/null
+++ b/doc/src/05100-lib-read.md
@@ -0,0 +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.
+