summaryrefslogtreecommitdiff
path: root/doc/man/ouroboros.8
diff options
context:
space:
mode:
authorDimitri Staessens <dimitri.staessens@ugent.be>2018-03-22 11:02:15 +0100
committerSander Vrijders <sander.vrijders@ugent.be>2018-03-22 12:36:58 +0100
commit751fb58bcf5fdb31c0627a5153684e96126cffb6 (patch)
tree5c4e8d8b2b2b323738703644c422a7e6c7095d5e /doc/man/ouroboros.8
parentfd5508b8daec47e9f646c086d4cc310583154b97 (diff)
downloadouroboros-751fb58bcf5fdb31c0627a5153684e96126cffb6.tar.gz
ouroboros-751fb58bcf5fdb31c0627a5153684e96126cffb6.zip
lib: Simplify reg/unreg API
The reg/unreg API is simplified to registering and unregistering a single name with a single IPCP. The functionality associated with registering names was moved from the IRMd to the irm tool. The function to list IPCPs was simplified to return all IPCPs in the system with their basic properties needed for management. The above changes led to some needed changes in the irm tool and the management functions that were depending on the previous behaviour of list_ipcps. Command line functionality to list IPCPs in the system is also added to the irm tool. Some older code was refactored. Signed-off-by: Dimitri Staessens <dimitri.staessens@ugent.be> Signed-off-by: Sander Vrijders <sander.vrijders@ugent.be>
Diffstat (limited to 'doc/man/ouroboros.8')
-rw-r--r--doc/man/ouroboros.815
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/man/ouroboros.8 b/doc/man/ouroboros.8
index 063f5e8d..95d17a05 100644
--- a/doc/man/ouroboros.8
+++ b/doc/man/ouroboros.8
@@ -272,6 +272,11 @@ disconnects \fIcomponent\fR (\fBdt\fR or \fBmgmt\fR) of a normal IPCP
with name \fIname\fR from that component of the destination IPCP within the
same layer.
.RE
+
+\fBirm ipcp list\fR type \fItype\fR name \fIname\fR layer \fIlayer\fR
+.RS 4
+lists IPCPs in the system. You can filter by type, by name or by layer.
+.RE
.RE
.SH IRM COMMANDS
@@ -329,15 +334,17 @@ not accept future flow allocation requests for \fIname\fR.
.RE
.PP
-\fBirm reg\fR name \fIname\fR layer \fIlayer\fR [layer \fIlayer\fR ...]
+\fBirm reg\fR name \fIname\fR \fIipcp\fR ipcp [\fIipcp\fR ...]
+layer [layer \fIlayer\fR ...]
.RS 4
-Register name \fIname\fR in layers \fIlayer\fR.
+Register name \fIname\fR in ipcps \fIipcp\fR ipcp and layers \fIlayer\fR.
.RE
.PP
-\fBirm unreg\fR name \fIname\fR layer \fIlayer\fR [layer \fIlayer\fR ...]
+\fBirm unreg\fR name \fIname\fR \fIipcp\fR ipcp [\fIipcp\fR ...]
+layer [layer \fIlayer\fR ...]
.RS 4
-Unregister name \fIname\fR in layers \fIlayer\fR.
+Unregister name \fIname\fR in ipcps \fIipcp\fR ipcp and layers \fIlayer\fR.
.RE
.SH TERMINOLOGY