matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Basic documentation for read/write libs

Browse source
This commit is contained in:
Matthias Beyer 2017-08-12 15:48:00 +00:00
parent d78288e6f7
commit a96eb69b0f
2 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/src/05100-lib-read.md
View file

@ -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.

9
doc/src/05100-lib-write.md
View file

@ -1,2 +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.