summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/man/ouroboros.821
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/man/ouroboros.8 b/doc/man/ouroboros.8
index 634eb3f7..3a969d22 100644
--- a/doc/man/ouroboros.8
+++ b/doc/man/ouroboros.8
@@ -97,7 +97,7 @@ In order to enroll an IPC process in a DIF, some other member will
have to be reachable over a lower DIF. Shim IPCPs are all bootstrapped
and thus need not enroll as they work directly over a physical
connection. Ouroboros currently supports shim IPCPs over shared memory
-(local), L2 (shim-eth-llc), L1 (raptor, experimental) and L3
+(local), L1 (raptor, experimental), L2 (shim-eth-llc) and L3
(shim-udp). The normal DIF requires connections to be established
between IPCP components for its operation.
@@ -121,6 +121,8 @@ creates an IPCP process of type \fItype\fR in the system with name
.PP
\fBlocal\fR - create a loopback IPCP.
.PP
+\fBraptor\fR - create an IPCP that attaches to a raptor NetFPGA device.
+.PP
\fBshim-eth-llc\fR - create an IPCP that attaches to an Ethernet adapter.
.PP
\fBshim-udp\fR - create an IPCP that attaches to a UDP socket.
@@ -145,13 +147,28 @@ Values for [\fIparam\fR] are dependent on \fItype\fR:
.PP
\fBlocal\fR
.RS 4
-does not take additional parameters.
+.PP
+[hash \fIpolicy\fR] specifies the hash function used for the directory,
+.br
+\fIpolicy\fR: SHA3_224, SHA3_256, SHA3_384, SHA3_512.
+.RE
+
+\fBraptor\fR
+.RS 4
+.PP
+[hash \fIpolicy\fR] specifies the hash function used for the directory,
+.br
+\fIpolicy\fR: SHA3_224, SHA3_256, SHA3_384, SHA3_512.
.RE
.PP
\fBshim-eth-llc\fR
.RS 4
if_name \fIinterface\fR specifies the interface to bind the shim to.
+.PP
+[hash \fIpolicy\fR] specifies the hash function used for the directory,
+.br
+\fIpolicy\fR: SHA3_224, SHA3_256, SHA3_384, SHA3_512.
.RE
.PP