From a3794134536cb7108654bc64ab0028704d114368 Mon Sep 17 00:00:00 2001 From: "Endi S. Dewata" Date: Wed, 3 Jun 2015 16:39:00 -0400 Subject: [PATCH] Added man page for pki user-cert. https://fedorahosted.org/pki/ticket/849 --- base/java-tools/man/man1/pki-user-cert.1 | 98 ++++++++++++++++++++++++++++++++ base/java-tools/man/man1/pki-user.1 | 7 +++ base/java-tools/man/man1/pki.1 | 6 ++ specs/pki-core.spec | 1 + 4 files changed, 112 insertions(+) create mode 100644 base/java-tools/man/man1/pki-user-cert.1 diff --git a/base/java-tools/man/man1/pki-user-cert.1 b/base/java-tools/man/man1/pki-user-cert.1 new file mode 100644 index 0000000000000000000000000000000000000000..77a6c2bc76055dd63c0a6749b818b7dcace7e22d --- /dev/null +++ b/base/java-tools/man/man1/pki-user-cert.1 @@ -0,0 +1,98 @@ +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH pki-user-cert 1 "Jun 3, 2015" "version 10.2" "PKI User Certificate Management Commands" Dogtag Team +.\" Please adjust this date whenever revising the man page. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for man page specific macros, see man(7) +.SH NAME +pki-user-cert \- Command-Line Interface for managing Certificate System user certificates. + +.SH SYNOPSIS +.nf +\fBpki\fR [CLI options] \fB-user-cert\fR +\fBpki\fR [CLI options] \fB-user-cert-find\fR [command options] +\fBpki\fR [CLI options] \fB-user-cert-show\fR [command options] +\fBpki\fR [CLI options] \fB-user-cert-add\fR [command options] +\fBpki\fR [CLI options] \fB-user-cert-del\fR [command options] +.fi + +.SH DESCRIPTION +.PP +The \fBpki-user-cert\fR commands provide command-line interfaces to manage user certificates on the specified subsystem. +.PP +Valid subsystems are \fBca\fR, \fBkra\fR, \fBocsp\fR, \fBtks\fR, and \fBtps\fR. If the \fB-\fR prefix is omitted, it will default to \fBca\fR. +.PP +\fBpki\fR [CLI options] \fB-user-cert\fR +.RS 4 +This command is to list available user certificate commands for the subsystem. +.RE +.PP +\fBpki\fR [CLI options] \fB-user-cert-find\fR [command options] +.RS 4 +This command is to list certificates owned by the subsystem user. +.RE +.PP +\fBpki\fR [CLI options] \fB-user-cert-show\fR [command options] +.RS 4 +This command is to view the details of a certificate owned to the subsystem user. +.RE +.PP +\fBpki\fR [CLI options] \fB-user-cert-add\fR [command options] +.RS 4 +This command is to add a certificate to the subsystem user. +.RE +.PP +\fBpki\fR [CLI options] \fB-user-cert-del\fR [command options] +.RS 4 +This command is to delete a certificate from the subsystem user. +.RE + +.SH OPTIONS +The CLI options are described in \fBpki\fR(1). + +.SH OPERATIONS +To view available user certificate commands, type \fBpki -user-cert\fP. To view each command's usage, type \fB pki -user-cert- \-\-help\fP. + +All user certificate commands must be executed as the subsystem administrator. + +For example, to list certificates owned by a CA user execute the following command: + +.B pki ca-user-cert-find testuser + +The results can be paged by specifying the (0-based) index of the first entry to return and the maximum number of entries returned: + +.B pki ca-user-cert-find testuser --start 20 --size 10 + +The above command will return entries #20 to #29. + +To view a certificate owned by a CA user, specify the user ID and the certificate ID in the following command: + +.B pki ca-user-show testuser \*(lq2;11;CN=CA Signing Certificate,O=EXAMPLE;UID=testuser\*(rq + +To add a certificate to a CA user from a file, specify the user ID and the input file: + +.B pki ca-user-add testuser --input testuser.crt + +To add a certificate to a CA user from the certificate repository, specify the user ID and the serial number: + +.B pki ca-user-add testuser --serial 0x80 + +To delete a certificate from a CA user, specify the user ID and the certificate ID in the following command: + +.B pki ca-user-del testuser \*(lq2;11;CN=CA Signing Certificate,O=EXAMPLE;UID=testuser\*(rq + +.SH AUTHORS +Endi S. Dewata . + +.SH COPYRIGHT +Copyright (c) 2015 Red Hat, Inc. This is licensed under the GNU General Public License, version 2 (GPLv2). A copy of this license is available at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt. diff --git a/base/java-tools/man/man1/pki-user.1 b/base/java-tools/man/man1/pki-user.1 index 7bd2fa780531d1e4d3e6003bcc97886ed755400f..eb87be17fff32266f975214ed6b357191cdcb6e6 100644 --- a/base/java-tools/man/man1/pki-user.1 +++ b/base/java-tools/man/man1/pki-user.1 @@ -97,6 +97,13 @@ To delete a CA user, specify the user ID in the following command: .B pki ca-user-del testuser +.SH SEE ALSO +.PP +\fBpki-user-cert\fR(1) +.RS 4 +User certificate management commands +.RE + .SH AUTHORS Ade Lee , Endi Dewata , and Matthew Harmsen . diff --git a/base/java-tools/man/man1/pki.1 b/base/java-tools/man/man1/pki.1 index ac85f131469a28011c2ded4713185563a5b7e62b..6995d3d16fefd89999d6f03e342407567fdccb10 100644 --- a/base/java-tools/man/man1/pki.1 +++ b/base/java-tools/man/man1/pki.1 @@ -261,6 +261,12 @@ User management commands .RE .PP +\fBpki-user-cert\fR(1) +.RS 4 +User certificate management commands +.RE + +.PP \fBpki-ca-profile\fR(1) .RS 4 Profile management commands diff --git a/specs/pki-core.spec b/specs/pki-core.spec index 4a083928d6aa88e25e8339c292a6a8b6ad46a0ff..0af01e9e5811f73b150459eddc834aa121540cde 100644 --- a/specs/pki-core.spec +++ b/specs/pki-core.spec @@ -857,6 +857,7 @@ systemctl daemon-reload %{_mandir}/man1/pki-key.1.gz %{_mandir}/man1/pki-securitydomain.1.gz %{_mandir}/man1/pki-user.1.gz +%{_mandir}/man1/pki-user-cert.1.gz %{_mandir}/man1/pki-ca-profile.1.gz -- 1.9.3