summaryrefslogtreecommitdiffstats
path: root/base
diff options
context:
space:
mode:
authorEndi S. Dewata <edewata@redhat.com>2015-06-29 16:04:16 -0400
committerEndi S. Dewata <edewata@redhat.com>2015-06-30 22:51:54 -0400
commitb9e461ca8a099b4535aa916886697c6eff01e431 (patch)
treef9e725ebcb4ba05bee608cf9455411a3ed247563 /base
parentc9180f086971dcf6f183ed5f627510f2183cc61e (diff)
downloadpki-b9e461ca8a099b4535aa916886697c6eff01e431.tar.gz
pki-b9e461ca8a099b4535aa916886697c6eff01e431.tar.xz
pki-b9e461ca8a099b4535aa916886697c6eff01e431.zip
Updated pki man page.
The pki man page has been updated to describe results paging parameters. https://fedorahosted.org/pki/ticket/1122
Diffstat (limited to 'base')
-rw-r--r--base/java-tools/man/man1/pki.125
1 files changed, 25 insertions, 0 deletions
diff --git a/base/java-tools/man/man1/pki.1 b/base/java-tools/man/man1/pki.1
index 9e174e11f..41ee3d3da 100644
--- a/base/java-tools/man/man1/pki.1
+++ b/base/java-tools/man/man1/pki.1
@@ -220,6 +220,31 @@ Client-side password files generally store a password in an equals-sign-delimite
.B foobar
where: token="internal" (default), password="foobar"
+.SS Results Paging
+
+Some commands (e.g. cert-find) may return multiple results. Since the number
+of results may be large, the results are split into multiple pages. By default
+the command will return only the first page (e.g. the first 20 results). To
+retrieve results from another page, additional paging parameters can be
+specified:
+
+.nf
+* start: index of the first result to return (default: 0)
+* size: number of results to return (default: 20)
+.fi
+
+For example, to retrieve the first page (index #0-#19):
+
+.B pki cert-find --start 0 --size 20
+
+To retrieve the second page (index #20-#39):
+
+.B pki cert-find --start 20 --size 20
+
+To retrieve the third page (index #40-#59):
+
+.B pki cert-find --start 40 --size 20
+
.SH FILES
.I /usr/bin/pki