$Id: README 21 2004-02-11 03:06:06Z kirk $

INSTALLATION

  Get a .remailers file if you don't already have one.  An easy way to do
  this is by asking Antonym to fetch one for you:

    antonym update

  Create your configuration file, '$HOME/.antonym'.  See the included
  'dot.antonym' (in PREFIX/share/examples/antonym) for instructions.
  This is probably the hardest part of using antonym, but it's not really
  *that* difficult, and you only have to change it again when you're
  creating a new nym.  Hint: the 'phrase' and 'password' commands can be
  helpful when writing your new reply block.


USAGE

  antonym has quite a few commands and options.  You can get a list of these
  by running antonym without any arguments.


EXAMPLES

  Creating a reply block:

    $ antonym create mynewalias > newreplyblock.txt

  Decrypting a file that has been send to you:

    $ antonym decrypt infile.txt outfile.txt

  Reading a file that's been send to you, but without writing it out to a
  file:

    $ antonym decrypt infile.txt | less

  Calculating typical reliability and latency of the chain of remailers in
  your reply block:

    $ antonym chainstat dizum cracker austria
                        this hop           cumulative
    ##  remailer    latency     prob    latency     prob
    --  --------   --------  -------   --------  -------
     1  dizum       0:04:37  100.00%    0:04:37  100.00%
     2  cracker     1:02:13   95.11%    1:06:50   95.11%
     3  austria     0:06:24   99.96%    1:13:14   95.07%

    Probability of success: 95.07%
    Expected latency      : 1:13:14

  Encrypting an email you've written in Gnus before sending it to your
  nymserver:

    $ cat email.txt
    From: mynewalias
    Subject: Another test
    To: kirk@strauser.com
    Gcc: nnml:sent.mail
    --text follows this line--
    Thanks for antonym!

    $ antonym --mailinformat=gnus nymcrypt email.txt

  Encrypting an email you've written, then passing it through several
  remailers:

    $ cat email.txt
    From: mynewalias
    Subject: Yet another test
    To: kirk@strauser.com

    This is wonderful!  I love antonym!

    $ antonym nymcrypt | antonym remcrypt freedom austria | sendmail -t

  Creating a reply block, encrypting it to several remailers, then sending
  it:

    $ antonym create mynewalias | antonym remcrypt aarg xganon2 dizum | sendmail -t

  Validating your reply blocks:

    $ ./antonym validate all

    Alias: mynewalias
    ----------------------------------------
    Hop: havenco
        Address: mix@remailer.havenco.com
        A password is set.

    Hop: aarg
        Address: remailer@aarg.net
        A password is set.

    Hop: austria
        Address: mixmaster@remailer.privacy.at
        A password is set.

    Hop: freedom
        Address: remailer@freedom.gmsociety.org
        A password is set.

    Hop: xganon2
        Address: remailer@remailer.xganon.com
        A password is set.

    Hop: lcs
        Address: mail2news@anon.lcs.mit.edu
        A password is set.

    This replyblock seems valid.



TODO

  Add support for:

    Encrypting a file to a remailer
    Verifying that reply blocks link to valid remailers
    Generating random reply blocks
    Editing encrypted files (i.e. with a pipe to vi)


BUGS

  GnuPG support isn't even close to working.


AUTHORS

  Antonym was written by Kirk Strauser <kirk@strauser.com>.  It is available
  at http://subwiki.honeypot.net/cgi-bin/view/Computing/AntoNym .


COPYRIGHT

  Copyright (C) 2004  Kirk Strauser

  This program is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by the Free
  Software Foundation; either version 2 of the License, or (at your option)
  any later version.

  This program is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  for more details.
