beginning first draft (barely)

1 files changed, 104 insertions, 0 deletions

diff --git a/modutil.xml b/modutil.xml
new file mode 100644
index 0000000..e0277dc
--- /dev/null
+++ b/modutil.xml
@@ -0,0 +1,104 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<refentry>
+
+  <refentryinfo>
+    <date>August 2010</date>
+<!-- this should be one word -->
+	<refentrytitle>modutil</refentrytitle>
+    <manvolnum>1</manvolnum>
+<!-- end  -->
+  </refentryinfo>
+
+  <refnamediv>
+    <refname>modutil</refname>
+    <refpurpose>Manage PKCS #11 module information within the security module database.</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>modutil</command>
+      <arg><replaceable>options</replaceable></arg>
+      <arg>[<replaceable>arguments</replaceable>]</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsection id="description">
+    <title>Description</title>
+    <para>The Security Module Database Tool is a command-line utility for managing PKCS #11 module information within secmod.db files or within hardware tokens. You can use the tool to add and delete PKCS #11 modules, change passwords, set defaults, list module contents, enable or disable slots, enable or disable FIPS 140-2 compliance, and assign default providers for cryptographic operations. This tool can also create key3.db, cert8.db, and secmod.db security database files.</para>
+
+	<para>The tasks associated with security module database management are part of a process that typically also involves managing key databases (key3.db files) and certificate databases (cert8.db files). The key, certificate, and PKCS #11 module management process generally begins with creating the keys and key database necessary to generate and manage certificates and the certificate database.</para>
+  </refsection>
+  
+  <refsection id="options">
+    <title>Options</title>
+	<para>
+		Running <command>modutil</command> always requires one (and only one) option to specify the type of module operation. Each option may take arguments, anywhere from none to multiple arguments.
+	</para>
+   	<para><command>Options</command></para> 
+
+	<variablelist>
+      <varlistentry>
+        <term>--upgrade-merge</term>
+        <listitem><para>Upgrade an old database and merge it into a new database.</para></listitem>
+      </varlistentry>
+	</variablelist>
+
+	<para><command>Arguments</command></para>
+    <variablelist>
+
+      <varlistentry>
+        <term>-A </term>
+        <listitem><para>Add an existing certificate to a certificate database. The certificate database should already exist; if one is not present, this option will initialize one by default. </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>
+<programlisting>% blah blah
+     line 2
+   line 3</programlisting>
+  </refsection>
+
+  <refsection id="examples">
+    <title>Extended Examples</title>
+    <para>The following example will do this and that
+    </para>
+<programlisting>% blah blah</programlisting>
+  </refsection>
+
+  <refsection id="seealso">
+    <title>See Also</title>
+    <para>certutil (1)</para>
+    <para>pk12util (1)</para>
+  </refsection>
+
+<!-- don't change -->
+  <refsection id="resources">
+    <title>Additional Resources</title>
+    <para>NSS is maintained in conjunction with PKI and security-related projects through Mozilla dn Fedora. The most closely-related project is Dogtag PKI, with a project wiki at <ulink url="http://pki.fedoraproject.org/wiki/">http://pki.fedoraproject.org/wiki/</ulink>. </para>
+	<para>For information specifically about NSS, the NSS project wiki is located at <ulink url="http://www.mozilla.org/projects/security/pki/nss/">http://www.mozilla.org/projects/security/pki/nss/</ulink>. The NSS site relates directly to NSS code changes and releases.</para>
+	<para>Mailing lists: pki-devel@redhat.com and pki-users@redhat.com</para>
+	<para>IRC: Freenode at #dogtag-pki</para>
+  </refsection>
+
+<!-- fill in your name first; keep the other names for reference -->
+  <refsection id="authors">
+    <title>Authors</title>
+    <para>The NSS tools were written and maintained by developers with Netscape and now with Red Hat.</para>
+	<para>
+		Authors: Elio Maldonado &lt;emaldona@redhat.com>, Deon Lackey &lt;dlackey@redhat.com>.
+	</para>
+  </refsection>
+
+<!-- don't change -->
+  <refsection id="copyright">
+    <title>Copyright</title>
+    <para>(c) 2010, Red Hat, Inc. Licensed under the GNU Public License version 2.</para>
+  </refsection>
+
+</refentry>