diff options
author | Endi S. Dewata <edewata@redhat.com> | 2015-06-04 03:03:03 -0400 |
---|---|---|
committer | Endi S. Dewata <edewata@redhat.com> | 2015-06-08 09:51:45 -0400 |
commit | 78db4ceba7b17c1ab1d7ea9f55b8c8acc90e891e (patch) | |
tree | 5f0d97866053734f1796edf15e6047593ff12617 /base/java-tools | |
parent | 857bb2b11a235f57ff353ceab9ed66f49431e087 (diff) | |
download | pki-78db4ceba7b17c1ab1d7ea9f55b8c8acc90e891e.tar.gz pki-78db4ceba7b17c1ab1d7ea9f55b8c8acc90e891e.tar.xz pki-78db4ceba7b17c1ab1d7ea9f55b8c8acc90e891e.zip |
Added man page for pki group-member.
https://fedorahosted.org/pki/ticket/1064
Diffstat (limited to 'base/java-tools')
-rw-r--r-- | base/java-tools/man/man1/pki-group-member.1 | 95 | ||||
-rw-r--r-- | base/java-tools/man/man1/pki-group.1 | 45 | ||||
-rw-r--r-- | base/java-tools/man/man1/pki.1 | 6 |
3 files changed, 122 insertions, 24 deletions
diff --git a/base/java-tools/man/man1/pki-group-member.1 b/base/java-tools/man/man1/pki-group-member.1 new file mode 100644 index 000000000..cba3af152 --- /dev/null +++ b/base/java-tools/man/man1/pki-group-member.1 @@ -0,0 +1,95 @@ +.\" 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-group-member 1 "Jun 3, 2015" "version 10.2" "PKI Group Member 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 <n> insert n+1 empty lines +.\" for man page specific macros, see man(7) +.SH NAME +pki-group-member \- Command-Line Interface for managing Certificate System group members. + +.SH SYNOPSIS +.nf +\fBpki\fR [CLI options] \fB<subsystem>-group-member\fR +\fBpki\fR [CLI options] \fB<subsystem>-group-member-find\fR <group ID> [command options] +\fBpki\fR [CLI options] \fB<subsystem>-group-member-show\fR <group ID> <member ID> [command options] +\fBpki\fR [CLI options] \fB<subsystem>-group-member-add\fR <group ID> <member ID> [command options] +\fBpki\fR [CLI options] \fB<subsystem>-group-member-del\fR <group ID> <member ID> [command options] +.fi + +.SH DESCRIPTION +.PP +The \fBpki-group-member\fR commands provide command-line interfaces to manage group members on the specified subsystem. +.PP +Valid subsystems are \fBca\fR, \fBkra\fR, \fBocsp\fR, \fBtks\fR, and \fBtps\fR. +If the \fB<subsystem>-\fR prefix is omitted, it will default to \fBca\fR. +.PP +\fBpki\fR [CLI options] \fB<subsystem>-group-member\fR +.RS 4 +This command is to list available group member commands for the subsystem. +.RE +.PP +\fBpki\fR [CLI options] \fB<subsystem>-group-member-find\fR <group ID> [command options] +.RS 4 +This command is to list group members in the subsystem. +.RE +.PP +\fBpki\fR [CLI options] \fB<subsystem>-group-member-show\fR <group ID> <member ID> [command options] +.RS 4 +This command is to view a group member details in the subsystem. +.RE +.PP +\fBpki\fR [CLI options] \fB<subsystem>-group-member-add\fR <group ID> <member ID> [command options] +.RS 4 +This command is to add a member to a group in the subsystem. +.RE +.PP +\fBpki\fR [CLI options] \fB<subsystem>-group-member-del\fR <group ID> <member ID> [command options] +.RS 4 +This command is to delete a member from a group in the subsystem. +.RE + +.SH OPTIONS +The CLI options are described in \fBpki\fR(1). + +.SH OPERATIONS +To view available group commands, type \fBpki <subsystem>-group-member\fP. To view each command's usage, type \fB pki <subsystem>-group-member-<command> \-\-help\fP. + +All group commands must be executed as the subsystem administrator. + +For example, to list members of a CA group execute the following command: + +.B pki <CA admin authentication> ca-group-member-find testgroup + +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 admin authentication> ca-group-member-find --start 20 --size 10 + +The above command will return entries #20 to #29. + +To view a member of a CA group, specify the group ID and the member ID in the following command: + +.B pki <CA admin authentication> ca-group-member-show testgroup testuser + +To add a member to a CA group, specify the group ID and the member ID in the following command: + +.B pki <CA admin authentication> ca-group-member-add testgroup testuser + +To delete a member from a CA group, specify the group ID and the member ID in the following command: + +.B pki <CA admin authentication> ca-group-member-del testgroup testuser + +.SH AUTHORS +Endi S. Dewata <edewata@redhat.com> + +.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-group.1 b/base/java-tools/man/man1/pki-group.1 index 591f58b8c..f3c6b78b8 100644 --- a/base/java-tools/man/man1/pki-group.1 +++ b/base/java-tools/man/man1/pki-group.1 @@ -25,8 +25,6 @@ pki-group \- Command-Line Interface for managing Certificate System groups. \fBpki\fR [CLI options] \fB<subsystem>-group-add\fR <group ID> [command options] \fBpki\fR [CLI options] \fB<subsystem>-group-mod\fR <group ID> [command options] \fBpki\fR [CLI options] \fB<subsystem>-group-del\fR <group ID> [command options] -\fBpki\fR [CLI options] \fB<subsystem>-group-member-add\fR <group ID> <member ID> [command options] -\fBpki\fR [CLI options] \fB<subsystem>-group-member-del\fR <group ID> <member ID> [command options] .fi .SH DESCRIPTION @@ -65,16 +63,6 @@ This command is to modify a group in the subsystem. .RS 4 This command is to delete a group from the subsystem. .RE -.PP -\fBpki\fR [CLI options] \fB<subsystem>-group-member-add\fR <group ID> <member ID> [command options] -.RS 4 -This command is to add a member to a group. -.RE -.PP -\fBpki\fR [CLI options] \fB<subsystem>-group-member-del\fR <group ID> <member ID> [command options] -.RS 4 -This command is to delete a member from a group. -.RE .SH OPTIONS The CLI options are described in \fBpki\fR(1). @@ -84,29 +72,38 @@ To view available group commands, type \fBpki <subsystem>-group\fP. To view each All group commands must be executed as the subsystem administrator. -To list groups in CA, use \fBpki ca-group-find\fP. It is possible to select the page size to limit the number of entries returned. To list all groups: +For example, to list groups in CA execute the following command: -.B pki <admin authentication> ca-group-find +.B pki <CA admin authentication> ca-group-find -To view a particular group: +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 <admin authentication> ca-group-show <group ID> +.B pki <CA admin authentication> ca-group-find --start 20 --size 10 -To add a group: +The above command will return entries #20 to #29. -.B pki <admin authentication> ca-group-add <group ID> --description "description" +To view a CA group, specify the group ID in the following command: -To delete a group: +.B pki <CA admin authentication> ca-group-show testgroup -.B pki <admin authentication> ca-group-del <group ID> +To add a CA group, specify the group ID in the following command: -To add a user to a group: +.B pki <CA admin authentication> ca-group-add testgroup -.B pki <admin authentication> ca-group-member-add <group ID> <member ID> +To modify a CA group, specify the group ID and the attributes to be modified in the following command: -To delete a user from a group: +.B pki <CA admin authentication> ca-group-mod testgroup --description \*(lqTest Group\*(rq -.B pki <admin authentication> ca-group-member-del <group ID> <member ID> +To delete a CA group, specify the group ID in the following command: + +.B pki <CA admin authentication> ca-group-del testgroup + +.SH SEE ALSO +.PP +\fBpki-group-member\fR(1) +.RS 4 +Group member management commands +.RE .SH AUTHORS Ade Lee <alee@redhat.com>, Endi Dewata <edewata@redhat.com>, and Matthew Harmsen <mharmsen@redhat.com>. diff --git a/base/java-tools/man/man1/pki.1 b/base/java-tools/man/man1/pki.1 index 6995d3d16..9e174e11f 100644 --- a/base/java-tools/man/man1/pki.1 +++ b/base/java-tools/man/man1/pki.1 @@ -243,6 +243,12 @@ Group management commands .RE .PP +\fBpki-group-member\fR(1) +.RS 4 +Group member management commands +.RE + +.PP \fBpki-key\fR(1) .RS 4 Key management commands |