summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDeon Lackey <dlackey@redhat.com>2010-08-18 20:02:03 -0400
committerDeon Lackey <dlackey@redhat.com>2010-08-18 20:02:03 -0400
commit832c228cad1c06077f6080e0bb8c20646e1ec687 (patch)
tree0c81a243defb163d4516175e682ffc4b02ac4904
parent0a6dbdebbe0c5518d41038d826d2656c400331af (diff)
downloadrepo-832c228cad1c06077f6080e0bb8c20646e1ec687.tar.gz
repo-832c228cad1c06077f6080e0bb8c20646e1ec687.tar.xz
repo-832c228cad1c06077f6080e0bb8c20646e1ec687.zip
editing command synopsis
-rw-r--r--pk12util.xml88
1 files changed, 46 insertions, 42 deletions
diff --git a/pk12util.xml b/pk12util.xml
index 8e83b87..93b8344 100644
--- a/pk12util.xml
+++ b/pk12util.xml
@@ -9,13 +9,10 @@
<date>August 2010</date>
<!-- this should be one word -->
<refentrytitle>pk12util</refentrytitle>
+ <manvolnum>1</manvolnum>
<!-- end -->
</refentryinfo>
- <refmeta>
- <manvolnum>1</manvolnum>
- </refmeta>
-
<refnamediv>
<refname>pk12util</refname>
<refpurpose>Export and import keys and certificate to or from a PKCS #12 file and the NSS database</refpurpose>
@@ -24,9 +21,16 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>pk12util</command>
- <arg><option>-i<replaceable>p12file</replaceable></option></arg>
- <arg><option>-l <replaceable>p12file</replaceable></option></arg>
- <arg><option>-o <replaceable>p12file</replaceable></option></arg>
+ <arg>-i p12File [-h tokenname] [-v] [common-options] </arg>
+ <arg>
+ -l p12File [-h tokenname] [-r] [common-options] </arg>
+ <arg>
+ -o p12File -n certname [-c keyCipher] [-C certCipher] [-m|--key_len keyLen] [-n|--cert_key_len certKeyLen] [common-options] </arg>
+ <arg>
+
+common-options are:
+[-d dir] [-P dbprefix] [-k slotPasswordFile|-K slotPassword] [-w p12filePasswordFile|-W p12filePassword]
+ </arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -39,95 +43,95 @@
<title>Options</title>
<variablelist>
<varlistentry>
- <term><option>-i </option> <replaceable>p12file</replaceable></term>
- <listitem><simpara>Import keys and certs from p12file into the nss database.</simpara></listitem>
+ <term>-i p12file</term>
+ <listitem><para>Import keys and certs from p12file into the nss database.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-l </option> <replaceable>p12file</replaceable></term>
- <listitem><simpara>List the keys and certs in p12file.</simpara></listitem>
+ <term>-l p12file</term>
+ <listitem><para>List the keys and certs in p12file.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-o </option> <replaceable>p12file</replaceable></term>
- <listitem><simpara>Export keys and certs from the nss database to 12file.</simpara></listitem>
+ <term>-o p12file</term>
+ <listitem><para>Export keys and certs from the nss database to 12file.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-n </option> <replaceable>certname</replaceable></term>
- <listitem><simpara>Specify the nickname of the cert and private key to export.</simpara></listitem>
+ <term>-n certname</term>
+ <listitem><para>Specify the nickname of the cert and private key to export.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-d </option> <replaceable>dir</replaceable></term>
- <listitem><simpara>Specify the database directory into which to import to or export from certificates and keys.
+ <term>-d dir</term>
+ <listitem><para>Specify the database directory into which to import to or export from certificates and keys.
If not specified the directory defaults to $HOME/.netscape (when $HOME exists in the environment),
- or to ./.netscape (when $HOME does not exist in the environment.</simpara>
+ or to ./.netscape (when $HOME does not exist in the environment.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-P </option> <replaceable>prefix</replaceable></term>
- <listitem><simpara>Specify the prefix used on the cert8.db and key3.db files
+ <term>-P prefix</term>
+ <listitem><para>Specify the prefix used on the cert8.db and key3.db files
(for example, my_cert8.db and my_key3.db). This option is provided as a special case.
- Changing the names of the certificate and key databases is not recommended.</simpara></listitem>
+ Changing the names of the certificate and key databases is not recommended.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-h </option> <replaceable>tokenname</replaceable></term>
- <listitem><simpara>Specify the name of the token to import into or export from.</simpara></listitem>
+ <term>-h tokenname</term>
+ <listitem><para>Specify the name of the token to import into or export from.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-v </option></term>
- <listitem><simpara>Enable debug logging when importing.</simpara></listitem>
+ <term>-v </term>
+ <listitem><para>Enable debug logging when importing.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-k </option> <replaceable>slotPasswordFile</replaceable></term>
- <listitem><simpara>Specify the text file containing the slot's password.</simpara></listitem>
+ <term>-k slotPasswordFile</term>
+ <listitem><para>Specify the text file containing the slot's password.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-K </option> <replaceable>slotPassword</replaceable></term>
- <listitem><simpara>Specify the slot's password.</simpara></listitem>
+ <term>-K slotPassword</term>
+ <listitem><para>Specify the slot's password.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-w </option> <replaceable>p12filePasswordFile</replaceable></term>
- <listitem><simpara>Specify the text file containing the pkcs #12 file password.</simpara></listitem>
+ <term>-w p12filePasswordFile</term>
+ <listitem><para>Specify the text file containing the pkcs #12 file password.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-W </option> <replaceable>p12filePassword</replaceable></term>
- <listitem><simpara>Specify the pkcs #12 file password.</simpara></listitem>
+ <term>-W p12filePassword</term>
+ <listitem><para>Specify the pkcs #12 file password.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-c </option> <replaceable>keyCipher</replaceable></term>
- <listitem><simpara>Specify the key encryption algorithm.</simpara></listitem>
+ <term>-c keyCipher</term>
+ <listitem><para>Specify the key encryption algorithm.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-C </option> <replaceable>certCipher</replaceable></term>
- <listitem><simpara>Specify the key cert (overall package) encryption algorithm.</simpara></listitem>
+ <term>-C certCipher</term>
+ <listitem><para>Specify the key cert (overall package) encryption algorithm.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-m | --key-len</option> <replaceable>keyLength</replaceable></term>
- <listitem><simpara>Specify the desired length of the symmetric key to be used to encrypt the private key.</simpara></listitem>
+ <term>-m | --key-len keyLength</term>
+ <listitem><para>Specify the desired length of the symmetric key to be used to encrypt the private key.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>-m | --cert-key-len</option> <replaceable>certKeyLength</replaceable></term>
- <listitem><simpara>Specify the desired length of the symmetric key to be used to encrypt the certificates and other meta-data.</simpara></listitem>
+ <term>-m | --cert-key-len certKeyLength</term>
+ <listitem><para>Specify the desired length of the symmetric key to be used to encrypt the certificates and other meta-data.</para></listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection id="basic-usage">
<title>Basic Usage</title>
- <para>The <option>following</option> example will do <emphasis>this</emphasis> and that
+ <para>The following example will do <emphasis>this</emphasis> and that
</para>
<programlisting>% blah blah
line 2