From 26a23f16f2d28bb8588f14c45bf81a871fffcb82 Mon Sep 17 00:00:00 2001 From: "Endi S. Dewata" Date: Mon, 24 Aug 2015 21:17:40 +0200 Subject: Added pki-user-membership man page. A new man page has been added for pki -user-membership commands. The pki-user-cert man page has been modified to fix some errors. https://fedorahosted.org/pki/ticket/1584 (cherry picked from commit 997c8ec32ed483f3af47d692039720e62fa65c94) --- base/java-tools/man/man1/pki-user-cert.1 | 8 +-- base/java-tools/man/man1/pki-user-membership.1 | 84 ++++++++++++++++++++++++++ base/java-tools/man/man1/pki.1 | 6 ++ 3 files changed, 94 insertions(+), 4 deletions(-) create mode 100644 base/java-tools/man/man1/pki-user-membership.1 (limited to 'base/java-tools') diff --git a/base/java-tools/man/man1/pki-user-cert.1 b/base/java-tools/man/man1/pki-user-cert.1 index 77a6c2bc7..4ecc45090 100644 --- a/base/java-tools/man/man1/pki-user-cert.1 +++ b/base/java-tools/man/man1/pki-user-cert.1 @@ -77,19 +77,19 @@ 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 +.B pki ca-user-cert-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 +.B pki ca-user-cert-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 +.B pki ca-user-cert-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 +.B pki ca-user-cert-del testuser \*(lq2;11;CN=CA Signing Certificate,O=EXAMPLE;UID=testuser\*(rq .SH AUTHORS Endi S. Dewata . diff --git a/base/java-tools/man/man1/pki-user-membership.1 b/base/java-tools/man/man1/pki-user-membership.1 new file mode 100644 index 000000000..7f6c1986b --- /dev/null +++ b/base/java-tools/man/man1/pki-user-membership.1 @@ -0,0 +1,84 @@ +.\" 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-membership 1 "Aug 24, 2015" "version 10.2" "PKI User Membership 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-membership \- Command-Line Interface for managing Certificate System user memberships. + +.SH SYNOPSIS +.nf +\fBpki\fR [CLI options] \fB-user-membership\fR +\fBpki\fR [CLI options] \fB-user-membership-find\fR [command options] +\fBpki\fR [CLI options] \fB-user-membership-add\fR [command options] +\fBpki\fR [CLI options] \fB-user-membership-del\fR [command options] +.fi + +.SH DESCRIPTION +.PP +The \fBpki-user-membership\fR commands provide command-line interfaces to manage user memberships 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-membership\fR +.RS 4 +This command is to list available user membership commands for the subsystem. +.RE +.PP +\fBpki\fR [CLI options] \fB-user-membership-find\fR [command options] +.RS 4 +This command is to list groups in which the subsystem user is a member. +.RE +.PP +\fBpki\fR [CLI options] \fB-user-membership-add\fR [command options] +.RS 4 +This command is to add the subsystem user into a group. +.RE +.PP +\fBpki\fR [CLI options] \fB-user-membership-del\fR [command options] +.RS 4 +This command is to delete the subsystem user from a group. +.RE + +.SH OPTIONS +The CLI options are described in \fBpki\fR(1). + +.SH OPERATIONS +To view available user membership commands, type \fBpki -user-membership\fP. To view each command's usage, type \fB pki -user-membership- \-\-help\fP. + +All user membership commands must be executed as the subsystem administrator. + +For example, to list groups in which a CA user is a member execute the following command: + +.B pki ca-user-membership-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-membership-find testuser --start 20 --size 10 + +The above command will return entries #20 to #29. + +To add a CA user into a group, specify the user ID and the group ID in the following command: + +.B pki ca-user-membership-add testuser Administrators + +To delete a CA user from a group, specify the user ID and the group ID in the following command: + +.B pki ca-user-membership-del testuser Administrators + +.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.1 b/base/java-tools/man/man1/pki.1 index 3de8f6e92..60c19f4dd 100644 --- a/base/java-tools/man/man1/pki.1 +++ b/base/java-tools/man/man1/pki.1 @@ -303,6 +303,12 @@ User management commands User certificate management commands .RE +.PP +\fBpki-user-membership\fR(1) +.RS 4 +User membership management commands +.RE + .PP \fBpki-ca-profile\fR(1) .RS 4 -- cgit