security/nss/doc/pp.xml

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/security/nss/doc/pp.xml	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,109 @@
     1.4 +<?xml version="1.0" encoding="UTF-8"?>
     1.5 +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
     1.6 +  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
     1.7 +<!ENTITY date SYSTEM "date.xml">
     1.8 +<!ENTITY version SYSTEM "version.xml">
     1.9 +]>
    1.10 +
    1.11 +<refentry id="pp">
    1.12 +
    1.13 +  <refentryinfo>
    1.14 +    <date>&date;</date>
    1.15 +    <title>NSS Security Tools</title>
    1.16 +    <productname>nss-tools</productname>
    1.17 +    <productnumber>&version;</productnumber>
    1.18 +  </refentryinfo>
    1.19 +
    1.20 +  <refmeta>
    1.21 +    <refentrytitle>PP</refentrytitle>
    1.22 +    <manvolnum>1</manvolnum>
    1.23 +  </refmeta>
    1.24 +
    1.25 +  <refnamediv>
    1.26 +    <refname>pp</refname>
    1.27 +    <refpurpose>Prints certificates, keys, crls, and pkcs7 files</refpurpose>
    1.28 +  </refnamediv>
    1.29 +
    1.30 +  <refsynopsisdiv>
    1.31 +    <cmdsynopsis>
    1.32 +      <command>pp -t type [-a] [-i input] [-o output]</command>
    1.33 +    </cmdsynopsis>
    1.34 +  </refsynopsisdiv>
    1.35 +  
    1.36 +  <refsection>
    1.37 +    <title>STATUS</title>
    1.38 +    <para>This documentation is still work in progress. Please contribute to the initial review in <ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=836477">Mozilla NSS bug 836477</ulink>
    1.39 +    </para>
    1.40 +  </refsection>
    1.41 +
    1.42 +  <refsection>
    1.43 +    <title>Description</title>
    1.44 +
    1.45 +    <para><command>pp </command>pretty-prints private and public key, certificate, certificate-request,
    1.46 +                     pkcs7 or crl files
    1.47 +    </para>
    1.48 +
    1.49 +  </refsection>
    1.50 +
    1.51 +<refsection>
    1.52 +    <title>Options</title>
    1.53 +    
    1.54 +    <variablelist>
    1.55 +
    1.56 +      <varlistentry>
    1.57 +        <term><option>-t </option> <replaceable>type</replaceable></term>
    1.58 +        <listitem>
    1.59 +          <simpara>specify the input, one of {private-key | public-key | certificate | certificate-request | pkcs7 | crl}</simpara>
    1.60 +          <simpara></simpara>
    1.61 +        </listitem>
    1.62 +      </varlistentry>
    1.63 +
    1.64 +      <varlistentry>
    1.65 +        <term><option>-a </option></term>
    1.66 +        <listitem>
    1.67 +          <simpara>Input is in ascii encoded form (RFC1113)</simpara>
    1.68 +        </listitem>
    1.69 +      </varlistentry>
    1.70 +
    1.71 +      <varlistentry>
    1.72 +        <term><option>-i </option> <replaceable>inputfile</replaceable></term>
    1.73 +        <listitem>
    1.74 +          <simpara>Define an input file to use (default is stdin)</simpara>
    1.75 +        </listitem>
    1.76 +      </varlistentry>
    1.77 +
    1.78 +      <varlistentry>
    1.79 +        <term><option>-u </option> <replaceable>outputfile</replaceable></term>
    1.80 +        <listitem>
    1.81 +          <simpara>Define an output file to use (default is stdout)</simpara>
    1.82 +        </listitem>
    1.83 +      </varlistentry>
    1.84 +
    1.85 +    </variablelist>
    1.86 +  </refsection>
    1.87 +
    1.88 +  <refsection id="resources">
    1.89 +    <title>Additional Resources</title>
    1.90 +    <para>NSS is maintained in conjunction with PKI and security-related projects through Mozilla and Fedora. The most closely-related project is Dogtag PKI, with a project wiki at <ulink url="http://pki.fedoraproject.org/wiki/">PKI Wiki</ulink>. </para>
    1.91 +	<para>For information specifically about NSS, the NSS project wiki is located at <ulink url="http://www.mozilla.org/projects/security/pki/nss/">Mozilla NSS site</ulink>. The NSS site relates directly to NSS code changes and releases.</para>
    1.92 +	<para>Mailing lists: pki-devel@redhat.com and pki-users@redhat.com</para>
    1.93 +	<para>IRC: Freenode at #dogtag-pki</para>
    1.94 +  </refsection>
    1.95 +
    1.96 +<!-- fill in your name first; keep the other names for reference -->
    1.97 +  <refsection id="authors">
    1.98 +    <title>Authors</title>
    1.99 +    <para>The NSS tools were written and maintained by developers with Netscape, Red Hat,  Sun, Oracle, Mozilla, and Google.</para>
   1.100 +    <para>
   1.101 +	Authors: Elio Maldonado &lt;emaldona@redhat.com>, Deon Lackey &lt;dlackey@redhat.com>.
   1.102 +    </para>
   1.103 +  </refsection>
   1.104 +
   1.105 +<!-- don't change -->
   1.106 +  <refsection id="license">
   1.107 +    <title>LICENSE</title>
   1.108 +    <para>Licensed under the Mozilla Public License, v. 2.0.  If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
   1.109 +    </para>
   1.110 +  </refsection>
   1.111 +
   1.112 +</refentry>

mercurial