[Nym3-commit] r332 - trunk/nymbaron/doc
laurent at conuropsis.org
laurent at conuropsis.org
Wed Oct 12 15:49:26 CEST 2005
Author: laurent
Date: 2005-10-12 15:49:25 +0200 (Wed, 12 Oct 2005)
New Revision: 332
Added:
trunk/nymbaron/doc/nymbaron.xml
Log:
Start of the nymbaron manpage, in docbook format.
Added: trunk/nymbaron/doc/nymbaron.xml
===================================================================
--- trunk/nymbaron/doc/nymbaron.xml 2005-10-11 19:48:36 UTC (rev 331)
+++ trunk/nymbaron/doc/nymbaron.xml 2005-10-12 13:49:25 UTC (rev 332)
@@ -0,0 +1,247 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<refentry>
+<refmeta>
+<refentrytitle>NYMBARON</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class='source'>October 12, 2005</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>nymbaron</refname>
+<refpurpose>type III nymserver client</refpurpose>
+</refnamediv>
+<!-- body begins here -->
+<refsynopsisdiv id='synopsis'>
+<cmdsynopsis>
+ <command>nymbaron</command>
+ <arg choice='plain'>command</arg>
+ <arg choice='opt'>command-args</arg>
+ <sbr/>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+<para>A nymserver is a mail server which stores emails on behalf of anonymous
+users. It provides long-term pseudonymous identities which can receive and send
+emails through the server, without revealing the user controling those
+identities.</para>
+
+<para>nymbaron is a client working with the type III nymserver, which
+is built upon the mixminion remailer network.</para>
+
+<para>WARNING: this is still considered alpha quality software. Do NOT use
+ it if you require strong anonymity.</para>
+
+<para>
+ For quickstart instruction, skip to the <link>GETTING
+ STARTED</link> section.
+</para>
+</refsect1>
+
+<refsect1 id='bounds'><title>COMMANDS</title>
+<variablelist>
+<varlistentry>
+ <term><command>create</command></term>
+ <listitem>
+ <para>
+ Send an account creation request at specified server.
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>send</command></term>
+ <listitem>
+ <para>
+ Send an email message through a nymserver.
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>summarize</command></term>
+ <listitem>
+ <para>
+ Send a request for synopsis for specified account.
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>delete</command></term>
+ <listitem>
+ <para>
+ Request email deletion.
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>get</command></term>
+ <listitem>
+ <para>
+ Retrieve email
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>process</command></term>
+ <listitem>
+ <para>
+ Process returning server messages
+ </para>
+ </listitem>
+</varlistentry>
+<varlistentry>
+ <term><command>mprocess</command></term>
+ <listitem>
+ <para>
+ Process returning minion messages
+ </para>
+ </listitem>
+</varlistentry>
+<varlistentry>
+ <term><command>list-syn</command></term>
+ <listitem>
+ <para>
+ List already fetched summaries
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>dump-syn</command></term>
+ <listitem>
+ <para>
+ Dump already fetched summaries
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>list-mbox</command></term>
+ <listitem>
+ <para>
+ List already fetched emails
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>list-journal</command></term>
+ <listitem>
+ <para>
+ List commands recorded in the journal (sent but not acknowledged yet)
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>send-surb</command></term>
+ <listitem>
+ <para>
+ Send SURBs
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>export</command></term>
+ <listitem>
+ <para>
+ Export already fetched emails to a file
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>resend-command</command></term>
+ <listitem>
+ <para>
+ Resend a command that has been sent but not acknowledged yet
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>ldelete</command></term>
+ <listitem>
+ <para>
+ Delete messages from the local mbox
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>ldelete-syn</command></term>
+ <listitem>
+ <para>
+ Delete messages from the local synbox
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>list-accounts</command></term>
+ <listitem>
+ <para>
+ List the accounts of the user
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><command>passwd</command></term>
+ <listitem>
+ <para>
+ Change the passphrase that protects the user keyring
+ </para>
+ </listitem>
+</varlistentry>
+</variablelist>
+</refsect1>
+
+<refsect1><title>GETTING STARTED</title>
+<para>
+ TODO : writeme.
+</para>
+</refsect1>
+
+<refsect1><title>AUTHORS</title>
+<para>
+ Laurent Fousse <email>laurent at komite.net</email> and Jean-René
+ Reinhard <email>jr at komite.net</email>.
+</para>
+</refsect1>
+<refsect1><title>COPYRIGHT</title>
+<para>
+Copyright © 2004,2005 Jean-René Reinhard
+<email>jr at komite.net</email>
+and Laurent Fousse <email>laurent at komite.net</email>.
+</para>
+<para>
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to
+do so, provided that the above copyright notice(s) and this permission
+notice appear in all copies of the Software and that both the above
+copyright notice(s) and this permission notice appear in supporting
+documentation.
+</para>
+<para>
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE
+LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR
+ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+</para>
+</refsect1>
+</refentry>
More information about the Nym3-commit
mailing list