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/ouroboros-glossary.7 | 122 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 122 insertions(+) create mode 100644 doc/man/ouroboros-glossary.7 (limited to 'doc/man/ouroboros-glossary.7') diff --git a/doc/man/ouroboros-glossary.7 b/doc/man/ouroboros-glossary.7 new file mode 100644 index 00000000..cb397c76 --- /dev/null +++ b/doc/man/ouroboros-glossary.7 @@ -0,0 +1,122 @@ +.\" Ouroboros man pages (C) 2017 +.\" Dimitri Staessens +.\" Sander Vrijders + +.TH OUROBOROS-GLOSSARY 7 2017-10-15 Ouroboros "Ouroboros User Manual" + +.SH NAME + +ouroboros-glossary - The Ouroboros Glossary + +.SH SYNOPSIS + * + +.SH USER MANUAL GLOSSARY +.PP +address +.RS 4 +an element of a partially ordered set (POSET) consisting of data +transfer component namespaces within an IPC process +.RE + +.PP +bind a name +.RS 4 +to associate a name with a program or process. This mapping is stored +in the IRMd. +.RE + +.PP +bootstrap +.RS 4 +to configure an IPCP and start it as the first member of a DIF. +.RE + +.PP +congestion control +.RS 4 +the mechanism by which a server DIF controls its resources and +prevents its client processes from sending more information than it +can currently handle. This is orthogonal to flow control. +.RE + +.PP +directory +.RS 4 +the database that keeps a mapping between an address and a registered +hash. In Ouroboros, the default implementation is a Distributed Hash +Table. +.RE + +.PP +distributed IPC facility (DIF) +.RS 4 +deprecate? +.RE + +.PP +enrolment +.RS 4 +the action of connecting to a member of an existing DIF, retrieving +the bootstrap information and starting the IPCP as a new member of +that DIF. +.RE + +.PP +flow +.RS 4 +the system and network resources over which two application processes +can send information. A flow is an abstraction of the actual +underlying IPC mechanism and has a quality of service (QoS) associated +with it, which reflects externally measurable quantities such as +delay, jitter, bandwidth, loss and bit error rate. +.RE + +.PP +flow allocator +.RS 4 +the component of an IPCP that reserves the resources for a flow +towards a given registered hash. +.RE + +.PP +flow control +.RS 4 +the mechanism with which the destination endpoint of a connection +controls the source to prevent the source from sending more +information than the destination can currently handle. This is +orthogonal to congestion control. +.RE + +.PP +flow descriptor +.RS 4 +an integer used as a handle to a flow (a port ID) within an +application. +.RE + +.PP +inter process communication (IPC) +.RS 4 +the mechanisms that allow processes to share information. +.RE + +.PP +IPC process +.RS 4 +a process that allocates and manages the necessary resources within a +layer to allow IPC between processes that are clients of that layer. +.RE + +.PP +IPC resource manager (IRM) +.RS 4 +the process that manages local IPC and IPCPs (providing remote IPC). +.RE + +.SH SEE ALSO +\fBouroboros-tutorial\fR(7)\fB, ouroboros\fR(8) + +.SH COLOPHON +This page is part of the Ouroboros project, found at +http://ouroboros.ilabt.imec.be -- cgit v1.2.3