summaryrefslogtreecommitdiff
path: root/doc/src/05100-lib-write.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/05100-lib-write.md')
-rw-r--r--doc/src/05100-lib-write.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/src/05100-lib-write.md b/doc/src/05100-lib-write.md
new file mode 100644
index 0000000..bd837e3
--- /dev/null
+++ b/doc/src/05100-lib-write.md
@@ -0,0 +1,11 @@
+## libimagwrite
+
+This library is for the plumbing command `imag-write`.
+
+It extends the `Runtime` object and adds a `read_store_from(reader)` 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 or read anything to/from stdout/stdin before or after calling this function.
+
+This library is intended for use with the `imag-write` command only.
+
+