Refs #100984 Add man page documentation for new ccnd strategy subcomm…

…ands.
ProjectCCNx · Sep 26, 2013 · 9e6ba88 · 9e6ba88
1 parent 3f81d94
commit 9e6ba88
Showing 2 changed files with 54 additions and 3 deletions.
diff --git a/doc/manpages/ccndc.1 b/doc/manpages/ccndc.1
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: ccndc
 .\"    Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 09/24/2013
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\"      Date: 09/26/2013
 .\"    Manual: \ \&
 .\"    Source: \ \& 0.8.1
 .\"  Language: English
 .\"
-.TH "CCNDC" "1" "09/24/2013" "\ \& 0\&.8\&.1" "\ \&"
+.TH "CCNDC" "1" "09/26/2013" "\ \& 0\&.8\&.1" "\ \&"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -45,6 +45,12 @@ ccndc \- manipulate CCNx forwarding table
 .sp
 \fBccndc\fR [\fB\-v\fR] \fBdestroyface\fR \fIfaceid\fR
 .sp
+\fBccndc\fR [\fB\-v\fR] \fBsetstrategy\fR \fIuri\fR \fIstrategy\fR [\fIparameters\fR [\fIlifetime\fR]]
+.sp
+\fBccndc\fR [\fB\-v\fR] \fBgetstrategy\fR \fIuri\fR
+.sp
+\fBccndc\fR [\fB\-v\fR] \fBremovestrategy\fR \fIuri\fR
+.sp
 \fBccndc\fR [\fB\-v\fR] [\fB\-t\fR \fIlifetime\fR] \fBsrv\fR
 .SH "DESCRIPTION"
 .sp
@@ -114,6 +120,28 @@ remove a face based on the parameters\&.
 destroy a face based on the numeric faceid\&.
 .RE
 .PP
+\fBsetstrategy\fR \fIuri\fR \fIstrategy\fR [\fIparameters\fR [\fIlifetime\fR]]
+.RS 4
+associate the named
+\fIstrategy\fR
+with the prefix
+\fIuri\fR\&. The
+\fIparameters\fR
+are passed along to the strategy; their interpretation is strategy\-specific\&. Lifetime is in seconds\&. Note \- lifetime is currently ignored by ccnd\&.
+.RE
+.PP
+\fBgetstrategy\fR \fIuri\fR
+.RS 4
+get strategy information associated with the prefix
+\fIuri\fR, and print on standard output\&. If no strategy has been associated the prefix, the inherited strategy and its prefix is printed instead\&.
+.RE
+.PP
+\fBremovestrategy\fR \fIuri\fR
+.RS 4
+remove the strategy associated with the prefix
+\fIuri\fR\&. output is the same as getstrategy\&.
+.RE
+.PP
 \fBsrv\fR
 .RS 4
 create a face and FIB entry (for ccnx:/) based on the results of an SRV lookup using the default DNS search rules\&. Queries _ccnx\&._tcp and _ccnx\&._udp\&.

diff --git a/doc/manpages/ccndc.1.txt b/doc/manpages/ccndc.1.txt
@@ -21,6 +21,12 @@ SYNOPSIS
 
 *ccndc* [*-v*] *destroyface* 'faceid'
 
+*ccndc* [*-v*] *setstrategy* 'uri' 'strategy' ['parameters' ['lifetime']]
+
+*ccndc* [*-v*] *getstrategy* 'uri'
+
+*ccndc* [*-v*] *removestrategy* 'uri'
+
 *ccndc* [*-v*] [*-t* 'lifetime'] *srv*
 
 DESCRIPTION
@@ -85,6 +91,23 @@ OPTIONS
 *destroyface* 'faceid'::
       destroy a face based on the numeric faceid.
 
+*setstrategy* 'uri' 'strategy' ['parameters' ['lifetime']]::
+    associate the named 'strategy' with the prefix 'uri'.
+    The 'parameters' are passed along to the strategy;
+    their interpretation is strategy-specific.
+    Lifetime is in seconds.
+    Note - lifetime is currently ignored by ccnd.
+
+*getstrategy* 'uri'::
+    get strategy information associated with the prefix 'uri',
+    and print on standard output.  If no strategy has been
+    associated the prefix, the inherited strategy and its
+    prefix is printed instead.
+
+*removestrategy* 'uri'::
+    remove the strategy associated with the prefix 'uri'.
+    output is the same as getstrategy.
+
 *srv*::
       create a face and FIB entry (for ccnx:/) based on the results of an
       SRV lookup using the default DNS search rules.  Queries _ccnx._tcp and