[Nym3-commit] r342 - trunk/nymbaron/doc

[laurent at conuropsis.org]

Author: laurent
Date: 2005-10-12 22:29:09 +0200 (Wed, 12 Oct 2005)
New Revision: 342

Modified:
   trunk/nymbaron/doc/nymbaron.xml
Log:
Write a more complete GETTING STARTED section for the client.


Modified: trunk/nymbaron/doc/nymbaron.xml
===================================================================
--- trunk/nymbaron/doc/nymbaron.xml	2005-10-12 18:24:02 UTC (rev 341)
+++ trunk/nymbaron/doc/nymbaron.xml	2005-10-12 20:29:09 UTC (rev 342)
@@ -205,15 +205,93 @@
 </refsect1>
 
 <refsect1><title>GETTING STARTED</title>
+<orderedlist>
+<listitem>
 <para>
-    TODO : writeme.
+    In order to start receiving and sending emails under a
+    pseudonymous identity, you need to create an account at a
+    nymserver. This server will hold your emails and some associated
+    data, and give you an email address. This is done with the
+    following command:
 </para>
+    <synopsis>nymbaron create
+    </synopsis>
+<para>
+    You will be asked a nickname for this account. This is how you
+    will refer to this account locally. You will have to chose a
+    nymserver where you want this account registered: currently the
+    only running nymserver is <email>mbox:nym3 at nowwhat</email>. You
+    will also need to enter a choice of several usernames: that will
+    be the localpart in the assigned email address for this account,
+    and the server assigns the first free requested username. You will
+    also be asked for the prefered email address for returning
+    messages.
+</para>
+</listitem>
+<listitem>
+<para>
+    Then, be patient. The messages are sent and returned via the
+    anonymous mixminion network which, despite being usually quite
+    fast and reliable, can experience slowdowns or packet loss. If you
+    don't see any returning message after some time, you may want to
+    resend your account creation request. See the
+    <command>resend-command</command> command.
+</para>
+</listitem>
+<listitem>
+<para>
+    If all goes well you will get a reply from the server via the
+    email address you mentioned earlier. You can't possibly mistake
+    this email from other "normal" emails. Save the email to a file
+    and ask <command>nymbaron</command> to process it:
+</para>
+    <synopsis>nymbaron mprocess -f file
+    </synopsis>
+
+<para>
+    You should have a reply confirming the creation of the account.
+    You can recall the accounts list at any time with the
+    <command>list-accounts</command> command.
+</para>
+</listitem>
+<listitem>
+<para>
+    You can now start receiving or sending email to or from this
+    account. Depending on you account preferences and various
+    parameters like the number of remaining SURBs for your account,
+    the server will either decide to send you whole emails, or email
+    summaries (called <emphasis>synopsis</emphasis> in this document),
+    or a mixture of both, or nothing (and then you'll have to poll the
+    server).
+</para>
+<para>
+    Requesting synopsis is done via the <command>summarize</command>.
+    For an email for which you have the synopsis, you can request the
+    whole email via the <command>get</command> command. Once you
+    fetched an email, you can <command>delete</command> it to save
+    some space on the server. For security reasons, fetched emails are
+    stored encrypted in an opaque data structure in your account. You
+    need to <command>export</command> them to a file first to read
+    them.
+</para>
+<para>
+    Don't forget to regularly send <emphasis>SURBs</emphasis> to the
+    server or you won't be able to get answers from the server. That's
+    it, you're ready to use your account. More complete documentation
+    for each command is displayed with the <option>--help</option>
+    flag.
+</para>
+</listitem>
+</orderedlist>
 </refsect1>
 
 <refsect1><title>AUTHORS</title>
 <para>
     Laurent Fousse <email>laurent at komite.net</email> and Jean-René
-    Reinhard <email>jr at komite.net</email>.
+    Reinhard
+    <email>jr at komite.net</email>.
+    <ulink
+    url="http://www.komite.net/laurent/soft/nymbaron/">Homepage</ulink>
 </para>
 </refsect1>
 <refsect1><title>COPYRIGHT</title>