summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Drung <benjamin.drung@profitbricks.com>2014-09-09 19:54:25 +0300
committerAde Lee <alee@redhat.com>2014-09-09 14:42:19 -0400
commit7fa89c850bf244e64a077bcf176046c9684cb94a (patch)
tree8164645f26b1f07bd0f149e7a5c0f14bcc0144fd
parentf59d3a6fa097e359aa903af493580e6b1c7ef6d6 (diff)
downloadpki-7fa89c850bf244e64a077bcf176046c9684cb94a.tar.gz
pki-7fa89c850bf244e64a077bcf176046c9684cb94a.tar.xz
pki-7fa89c850bf244e64a077bcf176046c9684cb94a.zip
Fix manpage errors
This patch fixes manpage-has-errors-from-man and hyphen-used-as-minus-sign found by lintian tool on Debian.
-rw-r--r--base/java-tools/man/man1/pki-cert.18
-rw-r--r--base/java-tools/man/man1/pki-client.12
-rw-r--r--base/java-tools/man/man1/pki-group.12
-rw-r--r--base/java-tools/man/man1/pki-key.12
-rw-r--r--base/java-tools/man/man1/pki-securitydomain.14
-rw-r--r--base/java-tools/man/man1/pki-user.12
-rw-r--r--base/java-tools/man/man1/pki.12
-rw-r--r--base/server/man/man8/pkidestroy.82
-rw-r--r--base/server/man/man8/pkispawn.826
9 files changed, 25 insertions, 25 deletions
diff --git a/base/java-tools/man/man1/pki-cert.1 b/base/java-tools/man/man1/pki-cert.1
index 88a470cd2..ad2f56617 100644
--- a/base/java-tools/man/man1/pki-cert.1
+++ b/base/java-tools/man/man1/pki-cert.1
@@ -101,7 +101,7 @@ To list all certificates in the CA:
.B pki ca-cert-find
-It is also possible to search for and list specific certificates by adding a search filter. Use \fBpki ca-cert-find --help\fP to see options. For example, to search based on issuance date:
+It is also possible to search for and list specific certificates by adding a search filter. Use \fBpki ca-cert-find \-\-help\fP to see options. For example, to search based on issuance date:
.B pki ca-cert-find --issuedOnFrom 2012-06-15
@@ -132,7 +132,7 @@ The list of profiles can be viewed using the CLI command:
The XML template file for a profile type can be created by calling the ca-cert-request-profile-show CLI command. For example:
-\fBpki ca-cert-request-profile-show <profileID> --output <file to store the XML template>\fP
+\fBpki ca-cert-request-profile-show <profileID> \-\-output <file to store the XML template>\fP
will store the XML template of the request in the specified output file.
@@ -144,9 +144,9 @@ Then, an agent needs to review the request by running the following command:
.B pki <agent authentication> ca-cert-request-review <request ID> --file <file to store the certificate request>
-The --file <filename> and --action <action> options are mutually exclusive (i. e. - only one or the other may be specified during command invocation).
+The \-\-file <filename> and \-\-action <action> options are mutually exclusive (i. e. - only one or the other may be specified during command invocation).
-If the --file <filename> option is specified, the certificate request, as well as the defaults and constraints of the enrollment profile, will be retrieved and stored in the output file provided by the --file option. The agent can examine the file and override any values if necessary. To process the request, enter the appropriate action when prompted:
+If the \-\-file <filename> option is specified, the certificate request, as well as the defaults and constraints of the enrollment profile, will be retrieved and stored in the output file provided by the \-\-file option. The agent can examine the file and override any values if necessary. To process the request, enter the appropriate action when prompted:
.B Action (approve/reject/cancel/update/validate/assign/unassign):
diff --git a/base/java-tools/man/man1/pki-client.1 b/base/java-tools/man/man1/pki-client.1
index b43be0ea5..9b92c66d6 100644
--- a/base/java-tools/man/man1/pki-client.1
+++ b/base/java-tools/man/man1/pki-client.1
@@ -58,7 +58,7 @@ This command is to delete a certificate from the client security database.
The CLI options are described in \fBpki\fR(1).
.SH OPERATIONS
-To view available client commands, type \fBpki client\fP. To view each command's usage, type \fB pki client-<command> --help\fP.
+To view available client commands, type \fBpki client\fP. To view each command's usage, type \fB pki client-<command> \-\-help\fP.
To create a new database execute the following command:
diff --git a/base/java-tools/man/man1/pki-group.1 b/base/java-tools/man/man1/pki-group.1
index d84033a18..591f58b8c 100644
--- a/base/java-tools/man/man1/pki-group.1
+++ b/base/java-tools/man/man1/pki-group.1
@@ -80,7 +80,7 @@ This command is to delete a member from a group.
The CLI options are described in \fBpki\fR(1).
.SH OPERATIONS
-To view available group commands, type \fBpki <subsystem>-group\fP. To view each command's usage, type \fB pki <subsystem>-group-<command> --help\fP.
+To view available group commands, type \fBpki <subsystem>-group\fP. To view each command's usage, type \fB pki <subsystem>-group-<command> \-\-help\fP.
All group commands must be executed as the subsystem administrator.
diff --git a/base/java-tools/man/man1/pki-key.1 b/base/java-tools/man/man1/pki-key.1
index a34a3879f..30ac909e1 100644
--- a/base/java-tools/man/man1/pki-key.1
+++ b/base/java-tools/man/man1/pki-key.1
@@ -109,7 +109,7 @@ This command is to review a key request submitted ot the DRM.
The CLI options are described in \fBpki\fR(1).
.SH OPERATIONS
-To view available key commands, type \fBpki <subsystem>-key\fP. To view each command's usage, type \fB pki <subsystem>-key-<command> --help\fP.
+To view available key commands, type \fBpki <subsystem>-key\fP. To view each command's usage, type \fB pki <subsystem>-key-<command> \-\-help\fP.
All the key commands require agent authentication.
diff --git a/base/java-tools/man/man1/pki-securitydomain.1 b/base/java-tools/man/man1/pki-securitydomain.1
index d902d4703..a8c36c556 100644
--- a/base/java-tools/man/man1/pki-securitydomain.1
+++ b/base/java-tools/man/man1/pki-securitydomain.1
@@ -47,11 +47,11 @@ This command is to show the contents of the security domain.
The CLI options are described in \fBpki\fR(1).
.SH OPERATIONS
-To view available security domain commands, type \fBpki securitydomain\fP. To view each command's usage, type \fB pki securitydomain-<command> --help\fP.
+To view available security domain commands, type \fBpki securitydomain\fP. To view each command's usage, type \fB pki securitydomain-<command> \-\-help\fP.
To get an installation token (used when installing a new subsystem within a security domain):
-\fBpki <security domain admin authentication> securitydomain-get-install-token --hostname <hostname> --subsystem <subsystem>\fP
+\fBpki <security domain admin authentication> securitydomain-get-install-token \-\-hostname <hostname> \-\-subsystem <subsystem>\fP
To show the contents of the security domain:
diff --git a/base/java-tools/man/man1/pki-user.1 b/base/java-tools/man/man1/pki-user.1
index a591047d3..c7b9920c8 100644
--- a/base/java-tools/man/man1/pki-user.1
+++ b/base/java-tools/man/man1/pki-user.1
@@ -67,7 +67,7 @@ This command is to delete a user from the subsystem.
The CLI options are described in \fBpki\fR(1).
.SH OPERATIONS
-To view available user commands, type \fBpki <subsystem>-user\fP. To view each command's usage, type \fB pki <subsystem>-user-<command> --help\fP.
+To view available user commands, type \fBpki <subsystem>-user\fP. To view each command's usage, type \fB pki <subsystem>-user-<command> \-\-help\fP.
All user commands must be executed as the subsystem administrator.
diff --git a/base/java-tools/man/man1/pki.1 b/base/java-tools/man/man1/pki.1
index 4e77bd6eb..8e6af9fab 100644
--- a/base/java-tools/man/man1/pki.1
+++ b/base/java-tools/man/man1/pki.1
@@ -85,7 +85,7 @@ Specifies the file which contains the user password (mutually exclusive to the '
.SH OPERATIONS
To view available commands and options, simply type \fBpki\fP. Some commands have sub-commands.
To view the sub-commands, type \fBpki <command>\fP.
-To view each command's usage, type \fB pki <command> --help\fP.
+To view each command's usage, type \fB pki <command> \-\-help\fP.
A client security database is needed to execute commands that require SSL connection or client certificate
for authentication. See \fBpki-client\fR(1) for more information.
diff --git a/base/server/man/man8/pkidestroy.8 b/base/server/man/man8/pkidestroy.8
index ef32b274a..e45e3e586 100644
--- a/base/server/man/man8/pkidestroy.8
+++ b/base/server/man/man8/pkidestroy.8
@@ -18,7 +18,7 @@
pkidestroy \- Removes a subsystem from an instance of Certificate Server.
.SH SYNOPSIS
-pkidestroy -s <subsystem> -i <instance> [-u <secutiry domain username>] [-W <security domain password file>] [-h] [-v] [-p <prefix>]
+pkidestroy \-s <subsystem> \-i <instance> [\-u <secutiry domain username>] [\-W <security domain password file>] [\-h] [\-v] [\-p <prefix>]
.SH DESCRIPTION
Removes a subsystem from an instance of Certificate Server. This utility removes any of the Java-based Certificate Server subsystems (CA, KRA, OCSP, and TKS).
diff --git a/base/server/man/man8/pkispawn.8 b/base/server/man/man8/pkispawn.8
index 13c00ee55..1b8f49e4b 100644
--- a/base/server/man/man8/pkispawn.8
+++ b/base/server/man/man8/pkispawn.8
@@ -18,7 +18,7 @@
pkispawn \- Sets up an instance of Certificate Server.
.SH SYNOPSIS
-pkispawn -s <subsystem> -f <config_file> [-h] [-v] [-p <prefix>]
+pkispawn \-s <subsystem> \-f <config_file> [\-h] [\-v] [\-p <prefix>]
.SH DESCRIPTION
Sets up an instance of Certificate Server. This utility creates any of the Java-based Certificate Server subsystems (CA, KRA, OCSP, and TKS).
@@ -86,7 +86,7 @@ for details.
If no options are specified, pkispawn will provide an interactive menu to collect the parameters needed to install
the Certificate Server instance. Note that only the most basic installation options are provided. This includes root CAs,
KRAs, OCSPs and TKS, connecting to the LDAP port of a directory server. More complicated setups such as: cloned subsystems, subordinate or externally signed CAs, subsystems that connect to the directory server using LDAPS, and subsystems that are customized beyond the options described below - require the use of a configuration file with the
--f option.
+\-f option.
.PP
The interactive option is most useful for those users getting familiar with Certificate Server. The parameters collected are
written to the installation file of the subsystem, which can be found at \fB/etc/sysconfig/pki/tomcat/<instance name>/<subsystem>/deployment.cfg.\fP
@@ -96,7 +96,7 @@ The following parameters are queried interactively during the installation proce
\fBSubsystem Type\fP
.TP
\fISubsystem (CA/KRA/OCSP/TKS):\fP
-the type of subsystem to be installed. Prompted when the -s option is not specified. The default value chosen is CA.
+the type of subsystem to be installed. Prompted when the \-s option is not specified. The default value chosen is CA.
.PP
\fBInstance Specific Parameters\fP
.TP
@@ -117,7 +117,7 @@ the AJP port of the Tomcat instance. The default value is 8009.
\fIManagement port:\fP
the management port of the Tomcat instance. The default value is 8005.
.PP
-\fBAdministrative User Parameters\f
+\fBAdministrative User Parameters\fP
.TP
\fIUsername:\fP
the username of the administrator of this subsystem. The default value is <ca/kra/tks/ocsp>admin.
@@ -131,7 +131,7 @@ An optional parameter that can be used to import an already available CA admin c
\fIExport certificate:\fP
setup the path where the admin certificate of this <subsystem> should be stored. The default value is /root/.dogtag/pki-tomcat/<ca/kra/tks/ocsp>_admin.cert.
.PP
-\fBDirectory Server Parameters\f
+\fBDirectory Server Parameters\fP
.TP
\fIHostname:\fP
Hostname of the directory server instance. The default value is the hostname of the system.
@@ -148,7 +148,7 @@ the bind DN required to connect for the directory server. This user must have su
\fIPassword:\fP
password for the bind DN.
.PP
-\fBSecurity Domain Parameters\f
+\fBSecurity Domain Parameters\fP
.TP
\fIName:\fP
the name of the security domain. Required only if installing a root CA. Default value: <DNS domain name> Security Domain.
@@ -167,7 +167,7 @@ password for the security domain administrator. Required for all subsystems that
.SH EXAMPLES
.SS CA using default configuration
-\x'-1'\fBpkispawn -s CA -f myconfig.txt\fR
+\x'-1'\fBpkispawn \-s CA \-f myconfig.txt\fR
.PP
where \fImyconfig.txt\fP contains the following text:
.IP
@@ -194,7 +194,7 @@ A PKCS #12 file containing the administrator certificate is created in \fI$HOME/
.PP
To access the agent pages, first import the CA certificate by accessing the CA End Entity Pages and clicking on the Retrieval Tab. Be sure to trust the CA certificate. Then, import the administrator certificate in the PKCS #12 file.
.SS KRA, OCSP, or TKS using default configuration
-\x'-1'\fBpkispawn -s <subsystem> -f myconfig.txt\fR
+\x'-1'\fBpkispawn \-s <subsystem> \-f myconfig.txt\fR
.PP
where subsystem is KRA, OCSP, or TKS, and \fImyconfig.txt\fP contains the following text:
.IP
@@ -208,7 +208,7 @@ pki_security_domain_password=\fIpassword123\fP
.PP
The \fBpki_security_domain_password\fP is the admin password of the CA installed in the same default instance. This command should be run after a CA is installed. This installs another subsystem within the same default instance using the certificate generated for the CA administrator for the subsystem's administrator. This allows a user to access both subsystems on the browser with a single administrator certificate. To access the new subsystem's functionality, simply point the browser to https://<hostname>:8443 and click the relevant top-level links.
.SS KRA, OCSP, or TKS connecting to a remote CA
-\x'-1'\fBpkispawn -s <subsystem> -f myconfig.txt\fR
+\x'-1'\fBpkispawn \-s <subsystem> \-f myconfig.txt\fR
.PP
where subsystem is KRA, OCSP, or TKS, and \fImyconfig.txt\fP contains the following text:
.IP
@@ -233,7 +233,7 @@ The subsystem section is [KRA], [OCSP], or [TKS]. This example assumes that the
.PP
A new administrator certificate is generated for the new subsystem and stored in a PKCS #12 file in \fI$HOME/.dogtag/pki-tomcat\fP.
.SS Installing a CA clone
-\x'-1'\fBpkispawn -s CA -f myconfig.txt\fR
+\x'-1'\fBpkispawn \-s CA \-f myconfig.txt\fR
.PP
where \fImyconfig.txt\fP contains the following text:
.IP
@@ -260,7 +260,7 @@ A cloned CA is a CA which uses the same signing, OCSP signing, and audit signing
Before the clone can be generated, the Directory Server must be created that is separate from the master CA's Directory Server. The example assumes that the master CA and cloned CA are on different machines, and that their Directory Servers are on port 389. In addition, the master's system certs and keys have been stored in a PKCS #12 file that is copied over to the clone subsystem in the location specified in <path_to_pkcs12_file>. This file is created when the master CA is installed; it can also be generated using \fBPKCS12Export\fP. The file needs to be readable by the user the Certificate Server runs as (by default, pkiuser) and be given the SELinux context pki_tomcat_cert_t.
.PP
.SS Installing a KRA, OCSP, or TKS clone
-\x'-1'\fBpkispawn -s <subsystem> -f myconfig.txt\fR
+\x'-1'\fBpkispawn \-s <subsystem> \-f myconfig.txt\fR
.PP
where subsystem is KRA, OCSP, or TKS, and \fImyconfig.txt\fP contains the following text:
.IP
@@ -287,7 +287,7 @@ As with a CA clone, a KRA, OCSP, or TKS clone uses the same certificates and bas
.PP
The subsystem section is [KRA], [OCSP], or [TKS].
.SS Installing a subordinate CA
-\x'-1'\fBpkispawn -s CA -f myconfig.txt\fR
+\x'-1'\fBpkispawn \-s CA \-f myconfig.txt\fR
.PP
where \fImyconfig.txt\fP contains the following text:
.IP
@@ -311,7 +311,7 @@ A sub-CA derives its certificate configuration -- such as allowed extensions and
.PP
\fBNote:\fP The value of \fBpki_ca_signing_subject_dn\fP of a subordinate CA should be different from the root CA's signing subject DN.
.SS Installing an externally signed CA
-\x'-1'\fBpkispawn -s CA -f myconfig.txt\fR
+\x'-1'\fBpkispawn \-s CA \-f myconfig.txt\fR
.PP
This is a two step process.
.PP