new template file for tools

1 files changed, 114 insertions, 0 deletions

diff --git a/example.xml b/example.xml
new file mode 100644
index 0000000..6372d62
--- /dev/null
+++ b/example.xml
@@ -0,0 +1,114 @@
+<?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>toolname</refentrytitle>
+<!-- end  -->
+    <manvolnum>1</manvolnum>
+  </refentryinfo>
+
+  <refnamediv>
+    <refname> % tool name here % </refname>
+    <refpurpose>Manage keys and certificate in the the NSS database</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>% tool name here %</command>
+<!-- this isn't the ideal formatting, since docbook can handle reqiored/optional formatting automatically, but let's make it explicit -->
+      <arg>--required option 1</arg>
+	<arg>[--optional option 2]</arg>
+	<arg>[--optional group 1 | --optional group 2]</arg>
+	<arg>--required option | --with alternatives</arg>
+	<arg>--option <replaceable>&lt;with_parameters></replaceable></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsection id="description">
+    <title>Description</title>
+
+    <para><command>certutil</command> is an interactive command-line tool to manage keys and certificates in the nss database.</para>
+	<para>
+		We allow two types of formatting tags: <emphasis>italics</emphasis> and <command>bold</command> characters. Italics can be defined with emphasis, parameter, and replaceable tags in a para tag. Bold can be defined using a command, option, or filename tag.
+	</para>
+	<para>
+		Note: I have noticed some weirdness if a sentence ends with bold or italics tag and then has a period after it. The next sentence comes out garbled.
+	</para>
+  </refsection>
+  
+  <refsection id="options">
+    <title>Options</title>
+
+<!-- for the moment, I can't find a way for italics and bold tags to work in varlist entries --> 
+    <variablelist>
+      <varlistentry>
+        <term>-h</term>
+        <listitem><para>Display short help text.</para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>-o</term>
+        <listitem><para>Display other short help text.</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>
+<!-- i'm working on a decent way to do embedded subsections; for now, just use a bold tag to show a new section -->
+	<para><command>Subsection</command></para>
+	<para>
+		sentence #2
+	</para>
+	<para>
+		sentence #3
+	</para>
+  </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> % reference to other tool here %</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>, Gerhardus Geldenhuis &lt;gerhardus.geldenhuis@gmail.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>