/[pkg-mixmaster]/trunk/Mix/mixmaster.1

Diff of /trunk/Mix/mixmaster.1

Parent Directory | Revision Log | View Patch Patch

-revision 105 by weaselp,
Wed Jul 24 09:00:11 2002 UTC
+revision 477 by weaselp,
Sat Feb 15 00:29:36 2003 UTC
 Line 1
  .TH MIX 1 "Mixmaster Version 3.0 beta"
- .\" $Id: mix.1,v 1.5 2002/07/24 09:00:10 weaselp Exp $
+ .\" $Id: mix.1,v 1.28 2003/02/15 00:29:35 weaselp Exp $
  .SH NAME
  mix \- anonymous remailer software
  .SH SYNOPSIS
 Line 32 
 In the non-interactive mode, Mixmaster r
  standard input or from a file.  Destination address and input file can
  be specified in the command line.  If no address is given in the
  command line, the input file is expected to contain a message complete
- with mail headers.  Messages to be send under a pseudonym must contain
+ with mail headers.  Messages to be sent under a pseudonym must contain
  a
  .I Nym:
  header rather than
 Line 42 
 header rather than
  .B "\-h, \-\-help"
  Print a summary of command line options.
  .TP
+ .B "\-\-config=\fIfilename"
+ Read configuration from an alternate file.
+ .TP
  .B "\-t, \-\-to=\fIuser@host"
  Add the destination address(es) to the message header. The input file
  contains the message body without headers.
-Line 107 
 Send the message(s) from the pool.
+Line 110 
 Send the message(s) from the pool.
  Output informational messages.
  .TP
  .B "\-f\fR [\fIfile\fR]"
- Read a mail folder. This function requires ncurses support.
+ Read a mail folder or news article. This function requires ncurses support.
  .TP
  .B "\-fr\fR [\fIfile\fR]"
  Reply to a message.
-Line 141 
 Reply chain latency.
+Line 144 
 Reply chain latency.
  Reply chain for the pseudonym.
  .SS Remailer options:
  .TP
+ .B "\-\-config=\fIfilename"
+ Read configuration from an alternate file.
+ .TP
  .B \-R, \-\-read\-mail
  Read a remailer message from standard input and store it in the pool.
  .TP
+ .B \-I, \-\-store\-mail
+ Read a remailer message from standard input and store it in the pool
+ without decrypting it immediately. It will be processed the next time
+ Mixmaster processes the queue (called with \fP-M\fP or in daemon mode).
+ .TP
  .B \-P, \-\-pop-mail
  Read mail from the POP3 servers listed in
  .BR pop3.cfg .
-Line 155 
 internal files up\-to\-date.
+Line 166 
 internal files up\-to\-date.
  .TP
  .B \-D, \-\-daemon
  Detach from the console and process the pool, get mail and update the
- internal files in regular intervals.
+ internal files at regular intervals.
+ .TP
+ .B \-\-no-detach
+ Run as daemon but do not detach from the terminal (This option is
+ only useful together with \fB--daemon\fP).
  .TP
  .B -G, \-\-generate\-key
  Generate a new remailer key.
-Line 223 
 Default:
+Line 238 
 Default:
  .B DISTANCE
  When selecting random remailers, the chain will contain
  .I DISTANCE
- other remailers between two occurences of the
+ other remailers between two occurrences of the
  same remailer in the chain. Default:
  .BR 2 .
  .TP
-Line 240 
 as the final remailer. Default:
+Line 255 
 as the final remailer. Default:
  .BR 99 .
  .TP
  .B MAXLAT
- Only select remailers with a latency of maximally
+ Only select remailers with a latency of at most
  .IR MAXLAT .
  Default:
  .BR 36h .
  .TP
  .B PGPPUBRING
  Path to your public PGP key ring. Default:
- .BR ~/.pgp/pubring.pgp .
+ .BR ~/.pgp/pubring.pkr .
  (Windows default: PGP registry value.)
  .TP
  .B PGPSECRING
  Path to your secret PGP key ring. Default:
- .BR ~/.pgp/secring.pgp .
+ .BR ~/.pgp/secring.skr .
  (Windows default: PGP registry value.)
  .SS Remailer configuration:
  .TP
-Line 275 
 rather than by
+Line 290 
 rather than by
  .BR sendmail (1).
  .TP
  .B HELONAME
- Name used in the SMTP dialogue.
+ Host name used in the SMTP dialogue.
  Default: The
  .I ENVFROM
  host name or the current network name associated with the socket.
  .TP
+ .B SMTPUSERNAME
+ Some mail servers require authentication for sending mail. This is
+ the authenticated SMTP user name.
+ .B SMTPPASSWORD
+ Password for authenticated SMTP.
+ .TP
  .B ENVFROM
  Envelope from address used in the SMTP dialogue. (When the client is
  used to send non-anonymous messages,
-Line 355 
 it specifies the path to a program. If i
+Line 376 
 it specifies the path to a program. If i
  .B @
  sign, the message is forwarded to the given address (with an
  .B X-Loop:
- header to prevent mail loops), otherwise the message is appended
+ header to prevent mail loops). If it ends with a
+ .B /
+ it is treated as a Maildir, otherwise the message is appended
  to the given file name or written to standard output if
- .B MAIL
+ .B MAILBOX
  is
  .BR stdout .
  Default:
-Line 398 
 errors. Default:
+Line 421 
 errors. Default:
  Mail folder for bounce messages. Default:
  .IR MAILBOX .
  .TP
+ .B MAILIN
+ If defined an additional mail folder where Mixmaster should read messages from
+ when processing its pool. If it ends with a
+ .B /
+ it is treated as a Maildir, otherwise a standard mbox format file
+ is expected. All messages are removed from the folder after reading.
+ .B MAILIN
+ is not set by default.
+ It is an incredibly bad idea to set this the same as \fBMAILBOX\fP.
+ .TP
  .B VERBOSE
  If
  .B VERBOSE
-Line 406 
 is set to
+Line 439 
 is set to
  Mixmaster will log error
  messages only. If it is set to
  .BR 1 ,
- error message and warnings are logged. If
+ error messages and warnings are logged. If
  .B VERBOSE
  is set to
  .BR 2 ,
-Line 434 
 or
+Line 467 
 or
  .TP
  .B REMAIL
  Enable remailer functionality. Default:
- .BR y .
+ .BR n .
  .TP
  .B MIDDLEMAN
  Act as an intermediate hop only, forward anonymized
- messages to an other remailer. This mode can be used
+ messages to another remailer. This mode can be used
  where complaints about anonymous messages must be
  avoided. (The variable
  .B FORWARDTO
  specifies the remailer
  chain to be used; default:
  .BR * .)
  Default:
  .BR n .
-Line 480 
 Default:
+Line 513 
 Default:
  Filter out binary attachments. Default:
  .BR n .
  .TP
+ .B LISTSUPPORTED
+ List known remailers and their keys in remailer-conf reply. Default:
+ .BR y .
+ .TP
  .B MID
  Use a hash of the message body as Message-ID, to avoid
  Usenet spam. Default:
-Line 498 
 file by sending the remailer a message c
+Line 535 
 file by sending the remailer a message c
  .BR destination-block .
  Default:
  .BR y .
+ .TP
+ .B STATSDETAILS
+ List statistics on intermediate vs. final delivery in remailer-stats.
+ Default:
+ .BR y .
  .PP
  The following variables have numeric values:
  .TP
  .B POOLSIZE
  The size of the Mixmaster reordering pool. Larger sizes
- imply higher security and longer delays. Default:
+ imply higher security and longer delays. Remailer default:
+ .BR 20 .
+ Client default:
  .BR 0 .
  .TP
  .B RATE
- Percentage of messages from the pool to be sent. Default:
+ Percentage of messages from the pool to be sent. Remailer default:
+ .BR 95 .
+ Client default:
  .BR 100 .
  Lower values cause the pool to increase in size when
- many messages are recieved at a time, reducing the effect
+ many messages are received at a time, reducing the effect
  of flooding attacks.
  .TP
+ .B INDUMMYP
+ Probability that Mixmaster will generate dummy messages upon
+ receipt of incoming mail. Larger numbers mean more dummy
+ messages on average. For instance,
+ .B 10
+ means that on average one in nine incoming messages will trigger
+ a dummy generation, and
+ .B 20
+ means that one in four will.
+ .B 0
+ means no dummy messages. Remailer default:
+ .BR 20 .
+ Client default:
+ .BR 3 .
+ .TP
+ .B OUTDUMMYP
+ Probability that Mixmaster will generate dummy messages at
+ .B SENDPOOL
+ time. If the pool is processed frequently, this should be a lower value
+ than if there are long intervals between pool processing. Examples:
+ .B 50
+ means on average, one dummy message will be generated per pool
+ processing.
+ .B 80
+ means four will be generated.
+ .B 0
+ means no dummy messages. Remailer default:
+ .BR 67 .
+ Client default:
+ .BR 3 .
+ .TP
  .B SIZELIMIT
- Maximal size for anonymous messages in kB.
+ Maximum size for anonymous messages in kB.
  .B 0
  means no limit.
  Default:
  .BR 0 .
  .TP
  .B POP3SIZELIMIT
- Maximal size for incoming messages in kB when using POP3.
+ Maximum size for incoming messages in kB when using POP3.
  .B 0
  means no limit.
  Default:
-Line 533 
 is set to
+Line 610 
 is set to
  and left on the server otherwise.
  .TP
  .B INFLATEMAX
- Maximal size for
+ Maximum size for
  .B Inflate:
  padding in kB.
  .B 0
-Line 543 
 Default:
+Line 620 
 Default:
  .BR kB .
  .TP
  .B MAXRANDHOPS
- Maximal chain length for message forwarding requested by
+ Maximum chain length for message forwarding requested by
  .B Rand-Hop
  directives.
  Default:
-Line 554 
 minutes.
+Line 631 
 minutes.
  .TP
  .B SENDPOOLTIME
  How often Mixmaster should check the pool for messages
- to be sent. Default:
+ to be sent. Remailer default:
  .BR 1h .
+ Client default:
+ .BR 0h .
  .TP
  .B POP3TIME
  How often Mixmaster should check the POP3 accounts
-Line 565 
 for new mail.
+Line 644 
 for new mail.
  Default:
  .BR 1h .
  .TP
+ .B MAILINTIME
+ How often Mixmaster should read mail from
+ .BR MAILIN
+ and process mails fetched via POP3. Processing here means to
+ answer remailer-xxx requests and decrypt messages to the Mixmaster
+ and place them in the pool. No other processing of the pool is
+ done. This action is always performed sending out messages from the pool (at
+ .BR SENDPOOLTIME
+ intervals) or receiving mail via POP3 (at
+ .BR POP3TIME
+ intervals). Default:
+ .BR 5m .
+ .TP
  .B PACKETEXP
- How long to store parts of incomplete multipart messages.
+ How long to store parts of incomplete multipart messages and other
+ temporary pool files.
  Default:
  .BR 7d .
  .TP
-Line 585 
 no log is kept.
+Line 678 
 no log is kept.
  .PP
  The following strings must be specified at compile-time in
  .BR config.h .
- Usually it is not necessary to modify any of these:
+ It is not usually necessary to modify any of these:
  .TP
  .B
  DISCLAIMER
-Line 608 
 line and no
+Line 701 
 line and no
  .B fromdscl.txt
  file is available.
  .TP
+ .B MSGFOOTER
+ A default string to be inserted at the bottom of the message body
+ of all anonymous messages if no
+ .B footer.txt
+ file is available.
+ .TP
  .B BINDISCLAIMER
  A string to replace the body of a binary attachment when
  the remailer is configured to filter out binaries.
-Line 616 
 the remailer is configured to filter out
+Line 715 
 the remailer is configured to filter out
  The character set used for MIME-encoded header lines.
  .TP
  .B DESTBLOCK
  A quoted list of files that contain blocked addresses.
  Files must be separated by one space. Mixmaster will choose
- the first file for writing
+ the first file for writing if
  .B AUTOBLOCK
  is enabled.
  .PP
-Line 633 
 casual attackers. You can use
+Line 732 
 casual attackers. You can use
  .B `make PASS="\fIyour passphrase\fB"'
  to set a passphrase. This should
  .I not
  be the same as the client passphrase. This option is now deprecated in
  favor of the configuration file option
  .BR PASSPHRASE .
  .TP
-Line 689 
 The
+Line 788 
 The
  .BR getdomainname (2)
  function is available.
  .SH FILES
- These filenames can be overriden by setting the corresponding configuration
+ These filenames can be overridden by setting the corresponding configuration
  option (given in parentheses).
  .TP
  .B mix.cfg
-Line 704 
 Type 2 remailer keys (\fBPUBRING\fP).
+Line 803 
 Type 2 remailer keys (\fBPUBRING\fP).
  .B rlist.txt
  List of reliable type 1 remailers (\fBTYPE1LIST\fP).
  .TP
  .B mlist.txt
  List of reliable type 2 remailers (\fBTYPE2REL\fP).
  .TP
  .B type2.list
  List of known type 2 remailers (optional) (\fBTYPE2LIST\fP).
+ .TP
+ .B starex.txt
+ List of remailers which should not be used in randomly generated
+ remailer chains (\fBSTAREX\fP).
  .SS Remailer files:
  .TP
  .B disclaim.txt
-Line 721 
 if an anonymous message contains a user-
+Line 824 
 if an anonymous message contains a user-
  .B From:
  line (\fBFROMDSCLFILE\fP).
  .TP
+ .TP
+ .B footer.txt
+ A string to be inserted at the bottom of the message body
+ of all anonymous messages (\fBMSGFOOTERFILE\fP).
+ .TP
  .B help.txt
  Help file sent in response to
  .B remailer-help
-Line 774 
 Mixmaster does not send mail to the bloc
+Line 882 
 Mixmaster does not send mail to the bloc
  .B rab.blk
  Identical to
  .BR dest.blk ,
- except that Mixmaster will not write to this file.
+ except Mixmaster will not write to this file.
  For use with external remailer abuse blocklists.
  .TP
  .B source.blk
  List of blocked source addresses.  If an incoming message originates
- from an address or IP in this in this list, it will be ignored. This
+ from an address or IP in this list, it will be ignored. This
  feature can be used to avoid spam and other abusive mail (\fBSOURCEBLOCK\fP).
  .TP
  .B header.blk
  List of unwanted header fields. The file is used to delete unwanted
  header lines (e.g. lines that indicate a false identity, or Usenet
  control messages), and do other header filtering (\fBHDRFILTER\fP).
- .PP
  A destination address or header line is left out if it contains a
  search string or matches a regular expression specified in the block
  file. Lines in the block file that begin and end with a slash
-Line 800 
 entry in
+Line 908 
 entry in
  .BR header.blk ,
  the entire message is deleted.
- In addition, regular expressions can be substituted. Backreferences
+ In addition, regular expressions can be substituted. Back-references
  are supported. For example
   /^From: *([^@]*) <.*>/From: $1/
-Line 832 
 Remailer type 2 secret keys (\fBSECRING\
+Line 940 
 Remailer type 2 secret keys (\fBSECRING\
  The public type 1 remailer key (\fBPGPKEY\fP).
  .TP
  .B key.txt
- The public type 2 remailer key (\fB\fP).
+ The public type 2 remailer key (\fBKEYFILE\fP).
  .TP
  .B id.log
  Log file of messages already processed (\fBKEYFILE\fP).
-Line 840 
 Log file of messages already processed (
+Line 948 
 Log file of messages already processed (
  .B stats.log
  Log file for remailer statistics (\fBSTATS\fP).
  .TP
+ .B pgpmaxcount.log
+ Log file for PGP Max-Count statistics (\fBPGPMAXCOUNT\fP).
+ .TP
  .B time.log
  Time for periodic remailer actions (\fBREGULAR\fP).
  .TP
-Line 849 
 Public Diffie-Hellman parameters used fo
+Line 960 
 Public Diffie-Hellman parameters used fo
  .B dsaparam.mix
  Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).
  .TP
+ .B mix.pid
+ Pid file in daemon mode (\fBPIDFILE\fP).
+ .TP
+ .BI pool/
+ Message pool directory (\fBPOOL\fP).
+ .TP
  .BI pool/m *
- Message pool.
+ Message pool files.
  .TP
  .BI pool/p *
  Partial messages.

 Legend:



Removed from v.105
 


changed lines


 
Added in v.477
 Legend:



Removed from v.105
 


changed lines


 
Added in v.477
-Removed from v.105
+Added in v.477

	ViewVC Help
Powered by ViewVC 1.1.5