From d6b7840709288cd1fdd1d275986c4133856c5e2d Mon Sep 17 00:00:00 2001 From: dimitri staessens Date: Sun, 15 Oct 2017 21:56:26 +0200 Subject: doc: Add general documentation This adds user documentation for the Ouroboros User Manual in man sections 7 and 8. It consists of a general man page, a tutorial and a glossary. It also fixes and updates other manpages in the Ouroboros Programmer's Manual. --- doc/man/flow_read.3 | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'doc/man/flow_read.3') diff --git a/doc/man/flow_read.3 b/doc/man/flow_read.3 index 9e7842e5..db42301d 100644 --- a/doc/man/flow_read.3 +++ b/doc/man/flow_read.3 @@ -2,7 +2,7 @@ .\" Dimitri Staessens .\" Sander Vrijders -.TH FLOW_READ 3 2017-04-10 GNU "Ouroboros Programmer's Manual" +.TH FLOW_READ 3 2017-04-10 Ouroboros "Ouroboros Programmer's Manual" .SH NAME @@ -53,6 +53,9 @@ The flow was not allocated. .B -EFLOWDOWN The flow has been reported down. +.B -EMSGSIZE +The buffer was too large to be written. + .SH ATTRIBUTES For an explanation of the terms used in this section, see \fBattributes\fR(7). @@ -68,10 +71,14 @@ _ \fBflow_write\fR() & Thread safety & MT-Safe .TE +.SH TERMINOLOGY +Please see \fBouroboros-glossary\fR(7). + .SH SEE ALSO -.BR flow_alloc "(3), " flow_dealloc (3) +.BR fccntl "(3), " flow_alloc "(3), " fqueue "(3), " fset "(3), " \ +ouroboros (8) .SH COLOPHON This page is part of the Ouroboros project, found at -https://bitbucket.org/ouroboros-rina/ouroboros +http://ouroboros.ilabt.imec.be -- cgit v1.2.3