>From 45f1a7b061d0c7b25bd1cf4fa2627af80ae02dbe Mon Sep 17 00:00:00 2001
From: Abhishek Koneru <akoneru@redhat.com>
Date: Tue, 30 Sep 2014 14:48:00 -0400
Subject: [PATCH] Add a man page for profile CLI commands.

---
 base/java-tools/man/man1/pki-profile.1 | 144 +++++++++++++++++++++++++++++++++
 base/java-tools/man/man1/pki.1         |   6 ++
 specs/pki-core.spec                    |   1 +
 3 files changed, 151 insertions(+)
 create mode 100644 base/java-tools/man/man1/pki-profile.1

diff --git a/base/java-tools/man/man1/pki-profile.1 b/base/java-tools/man/man1/pki-profile.1
new file mode 100644
index 0000000000000000000000000000000000000000..70dc36ca00df4d9adcfbddac7b3c550996481e59
--- /dev/null
+++ b/base/java-tools/man/man1/pki-profile.1
@@ -0,0 +1,144 @@
+.\" 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-profile 1 "Sep 30, 2014" "version 10.2" "PKI Profile 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-profile \- Command-Line Interface for managing Certificate System profiles.
+
+.SH SYNOPSIS
+.nf
+\fBpki\fR [CLI options] \fB<subsystem>-profile\fR
+\fBpki\fR [CLI options] \fB<subsystem>-profile-find\fR [command options]
+\fBpki\fR [CLI options] \fB<subsystem>-profile-show <Profile ID> \fR [command options]
+\fBpki\fR [CLI options] \fB<subsystem>-profile-add <Input file path> \fR [command options]
+\fBpki\fR [CLI options] \fB<subsystem>-profile-mod <Input file path> \fR [command options]
+\fBpki\fR [CLI options] \fB<subsystem>-profile-del <Profile ID> \fR [command options]
+\fBpki\fR [CLI options] \fB<subsystem>-profile-enable <Profile ID> \fR [command options]
+\fBpki\fR [CLI options] \fB<subsystem>-profile-disable <Profile ID> \fR  [command options]
+.fi
+
+.SH DESCRIPTION
+.PP
+The \fBpki <subsystem>-profile\fR commands provide command-line interfaces to manage profiles on the CA.
+.PP
+The only valid subsystem is \fBca\fR.
+.PP
+\fBpki\fR [CLI options] \fB<subsystem>-profile-find\fR [command options]
+.RS 4
+This command is to list the profiles.
+.RE
+.PP
+\fBpki\fR [CLI options] \fB<subsystem>-profile-show <Profile ID>\fR [command options]
+.RS 4
+This command is to view the details of a profile.
+.RE
+.PP
+\fBpki\fR [CLI options] \fB<subsystem>-profile-add\fR <Input file path> [command options]
+.RS 4
+This command is to create a new profile.
+.RE
+.PP
+\fBpki\fR [CLI options] \fB<subsystem>-profile-mod <Input file path> \fR [command options]
+.RS 4
+This command is to modify an existing profile.
+.RE
+.PP
+\fBpki\fR [CLI options] \fB<subsystem>-profile-del\fR <Profile ID> [command options]
+.RS 4
+This command is to delete a profile.
+.RE
+.PP
+\fBpki\fR [CLI options] \fB<subsystem>-profile-enable\fR <Profile ID> [command options]
+.RS 4
+This command is to enable a profile.
+.RE
+.PP
+\fBpki\fR [CLI options] \fB<subsystem>-profile-disable\fR <Profile ID> [command options]
+.RS 4
+This command is to disable a profile.
+.RE
+.SH OPTIONS
+The CLI options are described in \fBpki\fR(1).
+
+.SH OPERATIONS
+
+To view available profile commands, type \fBpki ca-profile\fP. To view each command's usage, type \fB pki ca-profile-<command> \-\-help\fP.
+
+All the ca-profile commands require agent authentication.
+
+.SS Viewing the profiles
+
+.B pki <agent authentication> profile-find
+
+The \fBstart\fR and \fBsize\fR options can be used to specify the beginning and the size of the list.
+
+To view the contents of a profile:
+
+A set of profile inputs, profile outputs, authenticators, policies and constraints are defined in a profile.
+These contents can be viewed using the following command:
+
+.B pki <agent authentication> profile-show <Profile ID>
+
+To store the output of the above operation, the output option must be specified.
+
+.B pki <agent authentication> profile-show <Profile ID> --output <FILE_PATH>
+
+This output file can be used for modifying the profile.
+It can be used as a template for certificate enrollment as well but, a more suitable template can be fetched using the \fBpki cert-request-profile-show\fR command.
+The \fBpki cert-request-profile-show\fR command does not require an agent/administrator level authentication and contains only the profile inputs section (which is required for certificate enrollment).
+
+.SS Add/Modify/Delete a profile
+
+.B pki <admin authentication> profile-add <Input file path>
+
+The contents of the input file must be in an XML format returned by the profile-show command.
+This data will be marshaled by the CLI client to create a new profile in the CA.
+The profile must be disabled before it is modified. It must be enabled after modification to be used for
+certificate enrollment.
+
+To modify an existing profile:
+
+.B pki <admin authentication> profile-mod <Input file path>
+
+The profile data can be retrieved using the profile-show command and after editing the file,
+it can be provided to the profile-mod command to modify an existing profile.
+
+To delete a profile in the CA:
+
+.B pki <admin authentication> profile-delete <Profile ID>
+
+.SS Enabling/Disabling a profile in the CA
+
+To enable a profile in the CA:
+
+.B pki <agent authenticaton> profile-enable <Profile ID>
+
+A profile must be enabled before it can be used.
+
+To disable a profile in the CA:
+
+.B pki <agent authentication> profile-disable <Profile ID>
+
+A profile must be disabled before it can be modified.
+
+.SH AUTHORS
+Abhishek Koneru <akoneru@redhat.com>.
+
+.SH COPYRIGHT
+Copyright (c) 2014 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.
+
+.SH SEE ALSO
+.BR pkispawn(8),
+.BR pki(1)
diff --git a/base/java-tools/man/man1/pki.1 b/base/java-tools/man/man1/pki.1
index 8e6af9fab72794116cc49466ee222f372b0e1afa..9f895fa4e1b11674142b065a1797d87c7b999e28 100644
--- a/base/java-tools/man/man1/pki.1
+++ b/base/java-tools/man/man1/pki.1
@@ -260,6 +260,12 @@ Security domain management commands
 User management commands
 .RE
 
+.PP
+\fBpki-profile\fR(1)
+.RS 4
+User management commands
+.RE
+
 .SH AUTHORS
 Ade Lee <alee@redhat.com>, Endi Dewata <edewata@redhat.com>, and Matthew Harmsen <mharmsen@redhat.com>.
 
diff --git a/specs/pki-core.spec b/specs/pki-core.spec
index a7bec33308a292c5b85fd788fb7c936bccb35a59..21ac868ef11d1371a50272bbe9bb72a7a3a26046 100644
--- a/specs/pki-core.spec
+++ b/specs/pki-core.spec
@@ -733,6 +733,7 @@ echo >> /var/log/pki/pki-server-upgrade-%{version}.log 2>&1
 %{_mandir}/man1/pki-key.1.gz
 %{_mandir}/man1/pki-securitydomain.1.gz
 %{_mandir}/man1/pki-user.1.gz
+%{_mandir}/man1/pki-profile.1.gz
 
 
 %if %{with server}
-- 
1.8.5.3

