diff options
Diffstat (limited to 'doc/man')
| -rw-r--r-- | doc/man/CMakeLists.txt | 58 | ||||
| -rw-r--r-- | doc/man/fccntl.3 | 23 | ||||
| -rw-r--r-- | doc/man/flow_alloc.3 | 5 | ||||
| -rw-r--r-- | doc/man/flow_read.3 | 5 | ||||
| -rw-r--r-- | doc/man/fqueue.3 | 2 | ||||
| -rw-r--r-- | doc/man/fset.3 | 2 | ||||
| -rw-r--r-- | doc/man/ouroboros-glossary.7 | 2 | ||||
| -rw-r--r-- | doc/man/ouroboros-tutorial.7 | 2 | ||||
| -rw-r--r-- | doc/man/ouroboros.8 | 53 |
9 files changed, 64 insertions, 88 deletions
diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt deleted file mode 100644 index add68d62..00000000 --- a/doc/man/CMakeLists.txt +++ /dev/null @@ -1,58 +0,0 @@ -set(MAN_NAMES - # Add man page sources here - flow_accept.3 - flow_alloc.3 - flow_dealloc.3 - flow_read.3 - flow_write.3 - fccntl.3 - fqueue.3 - fqueue_create.3 - fqueue_destroy.3 - fqueue_next.3 - fevent.3 - fset.3 - fset_create.3 - fset_destroy.3 - fset_zero.3 - fset_add.3 - fset_del.3 - fset_has.3 - ouroboros-glossary.7 - ouroboros-tutorial.7 - ouroboros.8 - irmd.8 - irm.8 - ) - -macro(INSTALL_MAN __mans) - foreach (_man ${ARGV}) - string(REGEX REPLACE "^.+[.]([1-9]).gz" "\\1" _mansect ${_man}) - install(FILES ${_man} DESTINATION "${CMAKE_INSTALL_MANDIR}/man${_mansect}") - endforeach (_man) -endmacro(INSTALL_MAN __mans) - -find_program(GZIP_EXECUTABLE - NAMES gzip - DOC "Will gzip the man pages") - -mark_as_advanced(GZIP_EXECUTABLE) - -if (GZIP_EXECUTABLE) - foreach (m ${MAN_NAMES}) - set(md ${CMAKE_CURRENT_BINARY_DIR}/${m}.gz) - - add_custom_command( - OUTPUT ${md} - COMMAND ${GZIP_EXECUTABLE} - ARGS -c ${CMAKE_CURRENT_SOURCE_DIR}/${m} > ${md} - COMMENT "Compressing manpage ${m}" - VERBATIM) - - set(MAN_FILES ${MAN_FILES} ${md}) - endforeach () - - add_custom_target(man ALL DEPENDS ${MAN_FILES}) - - INSTALL_MAN(${MAN_FILES}) -endif () diff --git a/doc/man/fccntl.3 b/doc/man/fccntl.3 index 492cff46..767342b9 100644 --- a/doc/man/fccntl.3 +++ b/doc/man/fccntl.3 @@ -1,4 +1,4 @@ -.\" Ouroboros man pages CC-BY 2017 - 2021 +.\" Ouroboros man pages CC-BY 2017 - 2024 .\" Dimitri Staessens <dimitri@ouroboros.rocks> .\" Sander Vrijders <sander@ouroboros.rocks> @@ -40,8 +40,8 @@ disables the timeout. \fBFLOWGQOSSPEC\fR - retrieve the current QoS specification of the flow. Takes a \fBqosspec_t * \fIqs\fR as third argument. -\fBFLOWSFLAGS\fR - set flow flags. Takes flow flags as third -argument. Supported flags are: +\fBFLOWSFLAGS\fR - set flow flags. Takes flow \fBuint32_t\fR +\fIflags\fR as third argument. Supported flags are: .RS 8 \fIFLOWFRDONLY\fR - set flow to read-only. @@ -67,25 +67,30 @@ no partial writes). .RE -\fBFLOWGFLAGS\fR - get the current flow flags. Takes an \fBuint32_t +\fBFLOWGFLAGS\fR - get the current flow flags. Takes an \fBuint32_t * \fIflags\fR as third argument. \fBFLOWGRXQLEN\fR - get the current number of packets in the receive -buffer. Takes a \fBsize_t \fIqlen\fR as third argument. +buffer. Takes a \fBsize_t \fIqlen\fR * as third argument. \fBFLOWGTXQLEN\fR - get the current number of packets in the transmit -buffer. Takes a \fBsize_t \fIqlen\fR as third argument. +buffer. Takes a \fBsize_t \fIqlen\fR * as third argument. -\fBFRCTGFLAGS\fR - get the current flow flags. Takes an \fBuint16_t +\fBFRCTSFLAGS\fR - set the current flow flags. Takes an \fBuint16_t \fIflags\fR as third argument. Supported flags are: .RS 8 -\fIFRCTFRESCNTRL\fR - resource control enabled. +\fIFRCTFRESCNTL\fR - resource control enabled. + +\fIFRCTFRTX\fR - retransmission enabled. Cannot be modified and will +be ignored on set. -\fIFRCTFRTX\fR - retransmission enabled. +\fIFRCTFLINGER\fR - finish connection on flow deallocation. .RE +\fBFRCTGFLAGS\fR - get the current flow flags. Takes an \fBuint16_t * +\fIflags\fR as third argument. .SH RETURN VALUE diff --git a/doc/man/flow_alloc.3 b/doc/man/flow_alloc.3 index a357ee19..dbe5323c 100644 --- a/doc/man/flow_alloc.3 +++ b/doc/man/flow_alloc.3 @@ -1,4 +1,4 @@ -.\" Ouroboros man pages CC-BY 2017 - 2021 +.\" Ouroboros man pages CC-BY 2017 - 2024 .\" Dimitri Staessens <dimitri@ouroboros.rocks> .\" Sander Vrijders <sander@ouroboros.rocks> @@ -59,7 +59,8 @@ The \fBflow_join\fR() function allows applications to join a broadcast flow provided by a broadcast layer. The dst is the layer name. The \fBflow_dealloc\fR() function will release any resources -associated with the flow. +associated with the flow. This call may block and keep reliable flows +active until all packets are acknowledged. A \fBqosspec_t\fR specifies the following QoS characteristics of a flow: diff --git a/doc/man/flow_read.3 b/doc/man/flow_read.3 index 99f96544..acc1f61e 100644 --- a/doc/man/flow_read.3 +++ b/doc/man/flow_read.3 @@ -1,4 +1,4 @@ -.\" Ouroboros man pages CC-BY 2017 - 2021 +.\" Ouroboros man pages CC-BY 2017 - 2024 .\" Dimitri Staessens <dimitri@ouroboros.rocks> .\" Sander Vrijders <sander@ouroboros.rocks> @@ -58,6 +58,9 @@ The flow was not allocated. .B -EFLOWDOWN The flow has been reported down. +.B -EFLOWPEER +The flow's peer is unresponsive (flow timed out). + .B -EMSGSIZE The buffer was too large to be written. diff --git a/doc/man/fqueue.3 b/doc/man/fqueue.3 index 0c93aeff..72a0bc25 100644 --- a/doc/man/fqueue.3 +++ b/doc/man/fqueue.3 @@ -1,4 +1,4 @@ -.\" Ouroboros man pages CC-BY 2017 - 2021 +.\" Ouroboros man pages CC-BY 2017 - 2024 .\" Dimitri Staessens <dimitri@ouroboros.rocks> .\" Sander Vrijders <sander@ouroboros.rocks> diff --git a/doc/man/fset.3 b/doc/man/fset.3 index 6b17a026..87a7dc87 100644 --- a/doc/man/fset.3 +++ b/doc/man/fset.3 @@ -1,4 +1,4 @@ -.\" Ouroboros man pages CC-BY 2017 - 2021 +.\" Ouroboros man pages CC-BY 2017 - 2024 .\" Dimitri Staessens <dimitri@ouroboros.rocks> .\" Sander Vrijders <sander@ouroboros.rocks> diff --git a/doc/man/ouroboros-glossary.7 b/doc/man/ouroboros-glossary.7 index 50878c38..1f7ad882 100644 --- a/doc/man/ouroboros-glossary.7 +++ b/doc/man/ouroboros-glossary.7 @@ -1,4 +1,4 @@ -.\" Ouroboros man pages CC-BY 2017 - 2021 +.\" Ouroboros man pages CC-BY 2017 - 2024 .\" Dimitri Staessens <dimitri@ouroboros.rocks> .\" Sander Vrijders <sander@ouroboros.rocks> diff --git a/doc/man/ouroboros-tutorial.7 b/doc/man/ouroboros-tutorial.7 index 0f92a4e3..1fc02a02 100644 --- a/doc/man/ouroboros-tutorial.7 +++ b/doc/man/ouroboros-tutorial.7 @@ -1,4 +1,4 @@ -.\" Ouroboros man pages CC-BY 2017 - 2021 +.\" Ouroboros man pages CC-BY 2017 - 2024 .\" Dimitri Staessens <dimitri@ouroboros.rocks> .\" Sander Vrijders <sander@ouroboros.rocks> diff --git a/doc/man/ouroboros.8 b/doc/man/ouroboros.8 index 6e051673..759b1433 100644 --- a/doc/man/ouroboros.8 +++ b/doc/man/ouroboros.8 @@ -1,4 +1,4 @@ -.\" Ouroboros man pages CC-BY 2017 - 2021 +.\" Ouroboros man pages CC-BY 2017 - 2024 .\" Dimitri Staessens <dimitri@ouroboros.rocks> .\" Sander Vrijders <sander@ouroboros.rocks> @@ -127,7 +127,9 @@ creates an IPCP process of type \fItype\fR in the system with name .PP \fBeth-dix\fR - create an IPCP that attaches to Ethernet using DIX frames. .PP -\fBudp\fR - create an IPCP that attaches to a UDP socket. +\fBudp4\fR - create an IPCP that attaches to a UDP/IPv4 socket. +.PP +\fBudp6\fR - create an IPCP that attaches to a UDP/IPv6 socket. .PP \fBunicast\fR - create a unicast IPCP that uses lower level layers. .PP @@ -190,23 +192,35 @@ default: SHA3_256. .RE .PP -\fBudp\fR +\fBudp4\fR .RS 4 .PP -ip \fIip\fR specifies the local IP address to bind to +ip \fIip\fR specifies the local IPv4 address to bind to .PP -[dns \fdns\fR] specifies an optional DDNS server that will be used for +[dns \fIdns\fR] specifies an optional DDNS server that will be used for the directory. .PP -[cport \fcport\fR] specifies a client UDP port that will be used for -sending packets. +[port \fIport\fR] specifies a UDP port that is used for sending and +receiving ouroboros traffic. This must be the same for the entire UDP4 +layer. Parallel UDP4 layers should use different ports. This UDP port +needs to be forwarded if the server is behind a NAT and wants to +receive incoming requests. .br -default: A random UDP port in the ephemeral range +default: 3435 +.RE + +.PP +\fBudp6\fR +.RS 4 .PP -[sport \fsport\fR] specifies a server UDP port that is used for -receiving ouroboros traffic. This must be the same for the entire UDP -layer. Parallel UDP layers should use different ports. This UDP port -needs to be forwarded if the server is behind a NAT. +ip \fIip\fR specifies the local IPv6 address to bind to +.PP +[dns \fIdns\fR] specifies an optional DDNS server that will be used for +the directory. +.PP +[port \fIport\fR] specifies a UDP port that is used for sending and +receiving ouroboros traffic. This must be the same for the entire UDP6 +layer. Parallel UDP6 layers should use different ports. .br default: 3435 .RE @@ -374,12 +388,23 @@ not accept future flow allocation requests for \fIname\fR. .SH IRM NAME COMMANDS .PP -\fBirm name create \fIname\fR \fIlb\fR policy +\fBirm name create \fIname\fR lb \fIpolicy\fR +[sencpath \fI/path/to/server/enc.conf\fR] +[scrtpath \fI/path/to/server/crt.pem\fR] +[skeypath \fI/path/to/server/key.pem\fR] + +[cencpath \fI/path/to/client/enc.conf\fR] +[ccrtpath \fI/path/to/client/crt.pem\fR] +[ckeypath \fI/path/to/client/key.pem\fR] .RS 4 -Create a name \fIname\fR with a load-balancing policy +Create a name \fIname\fR with a load-balancing policy and security credentials .br \fIpolicy\fR: round-robin, spillover .br +\fI/path/to/enc.conf\fR: The path to the server and client encryption configuration. +\fI/path/to/pem\fR: The path to the server and client certificates and +private keys, in pem format. +.br .RE .PP |
