summaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/CMakeLists.txt58
-rw-r--r--doc/man/ouroboros.843
2 files changed, 36 insertions, 65 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/ouroboros.8 b/doc/man/ouroboros.8
index df328fcc..759b1433 100644
--- a/doc/man/ouroboros.8
+++ b/doc/man/ouroboros.8
@@ -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,17 +192,17 @@ 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 \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 UDP
-layer. Parallel UDP layers should use different ports. This UDP port
+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
@@ -208,6 +210,22 @@ default: 3435
.RE
.PP
+\fBudp6\fR
+.RS 4
+.PP
+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
+
+.PP
\fBunicast\fR
.RS 4
.PP
@@ -370,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