[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[Pki-devel] [PATCH] 622 Updated pki man page.



The pki man page has been updated to describe results paging
parameters.

https://fedorahosted.org/pki/ticket/1122

--
Endi S. Dewata
From b8f16d83c2f77ee059fbf86e2ed9b7160ff293b7 Mon Sep 17 00:00:00 2001
From: "Endi S. Dewata" <edewata redhat com>
Date: Mon, 29 Jun 2015 16:04:16 -0400
Subject: [PATCH] Updated pki man page.

The pki man page has been updated to describe results paging
parameters.

https://fedorahosted.org/pki/ticket/1122
---
 base/java-tools/man/man1/pki.1 | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/base/java-tools/man/man1/pki.1 b/base/java-tools/man/man1/pki.1
index 9e174e11fd2f88558dab421cb5ec87c8a6508622..41ee3d3da10adfa77fa94856d9829f5e6c2ecb78 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
 
-- 
1.9.3


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]