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

Diff of /trunk/Mix/mixmaster.1

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 220 by rabbi, Fri Sep 6 21:04:16 2002 UTC revision 397 by weaselp, Thu Dec 12 16:06:16 2002 UTC
# Line 1  Line 1 
1  .TH MIX 1 "Mixmaster Version 3.0 beta"  .TH MIX 1 "Mixmaster Version 3.0 beta"
2  .\" $Id: mix.1,v 1.16 2002/09/06 21:04:15 rabbi Exp $  .\" $Id: mix.1,v 1.26 2002/12/12 16:06:16 weaselp Exp $
3  .SH NAME  .SH NAME
4  mix \- anonymous remailer software  mix \- anonymous remailer software
5  .SH SYNOPSIS  .SH SYNOPSIS
# Line 32  In the non-interactive mode, Mixmaster r Line 32  In the non-interactive mode, Mixmaster r
32  standard input or from a file.  Destination address and input file can  standard input or from a file.  Destination address and input file can
33  be specified in the command line.  If no address is given in the  be specified in the command line.  If no address is given in the
34  command line, the input file is expected to contain a message complete  command line, the input file is expected to contain a message complete
35  with mail headers.  Messages to be send under a pseudonym must contain  with mail headers.  Messages to be sent under a pseudonym must contain
36  a  a
37  .I Nym:  .I Nym:
38  header rather than  header rather than
# Line 42  header rather than Line 42  header rather than
42  .B "\-h, \-\-help"  .B "\-h, \-\-help"
43  Print a summary of command line options.  Print a summary of command line options.
44  .TP  .TP
45    .B "\-\-config=\fIfilename"
46    Read configuration from an alternate file.
47    .TP
48  .B "\-t, \-\-to=\fIuser@host"  .B "\-t, \-\-to=\fIuser@host"
49  Add the destination address(es) to the message header. The input file  Add the destination address(es) to the message header. The input file
50  contains the message body without headers.  contains the message body without headers.
# Line 107  Send the message(s) from the pool. Line 110  Send the message(s) from the pool.
110  Output informational messages.  Output informational messages.
111  .TP  .TP
112  .B "\-f\fR [\fIfile\fR]"  .B "\-f\fR [\fIfile\fR]"
113  Read a mail folder. This function requires ncurses support.  Read a mail folder or news article. This function requires ncurses support.
114  .TP  .TP
115  .B "\-fr\fR [\fIfile\fR]"  .B "\-fr\fR [\fIfile\fR]"
116  Reply to a message.  Reply to a message.
# Line 141  Reply chain latency. Line 144  Reply chain latency.
144  Reply chain for the pseudonym.  Reply chain for the pseudonym.
145  .SS Remailer options:  .SS Remailer options:
146  .TP  .TP
147    .B "\-\-config=\fIfilename"
148    Read configuration from an alternate file.
149    .TP
150  .B \-R, \-\-read\-mail  .B \-R, \-\-read\-mail
151  Read a remailer message from standard input and store it in the pool.  Read a remailer message from standard input and store it in the pool.
152  .TP  .TP
# Line 160  internal files up\-to\-date. Line 166  internal files up\-to\-date.
166  .TP  .TP
167  .B \-D, \-\-daemon  .B \-D, \-\-daemon
168  Detach from the console and process the pool, get mail and update the  Detach from the console and process the pool, get mail and update the
169  internal files in regular intervals.  internal files at regular intervals.
170  .TP  .TP
171  .B \-\-no-detach  .B \-\-no-detach
172  Run as daemon but do not detach from the terminal (This option is  Run as daemon but do not detach from the terminal (This option is
# Line 249  as the final remailer. Default: Line 255  as the final remailer. Default:
255  .BR 99 .  .BR 99 .
256  .TP  .TP
257  .B MAXLAT  .B MAXLAT
258  Only select remailers with a latency of maximally  Only select remailers with a latency of at most
259  .IR MAXLAT .  .IR MAXLAT .
260  Default:  Default:
261  .BR 36h .  .BR 36h .
# Line 284  rather than by Line 290  rather than by
290  .BR sendmail (1).  .BR sendmail (1).
291  .TP  .TP
292  .B HELONAME  .B HELONAME
293  Name used in the SMTP dialogue.  Host name used in the SMTP dialogue.
294  Default: The  Default: The
295  .I ENVFROM  .I ENVFROM
296  host name or the current network name associated with the socket.  host name or the current network name associated with the socket.
297  .TP  .TP
298    .B SMTPUSERNAME
299    Some mail servers require authentication for sending mail. This is
300    the authenticated SMTP user name.
301    .B SMTPPASSWORD
302    Password for authenticated SMTP.
303    .TP
304  .B ENVFROM  .B ENVFROM
305  Envelope from address used in the SMTP dialogue. (When the client is  Envelope from address used in the SMTP dialogue. (When the client is
306  used to send non-anonymous messages,  used to send non-anonymous messages,
# Line 374  is Line 386  is
386  Default:  Default:
387  .BR mbox .  .BR mbox .
388  .TP  .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 incredible bad idea to set this the same as \fBMAILBOX\fP.  
 .TP  
389  .B MAILABUSE  .B MAILABUSE
390  Mail folder for messages sent to the  Mail folder for messages sent to the
391  .I COMPLAINTS  .I COMPLAINTS
# Line 419  errors. Default: Line 421  errors. Default:
421  Mail folder for bounce messages. Default:  Mail folder for bounce messages. Default:
422  .IR MAILBOX .  .IR MAILBOX .
423  .TP  .TP
424    .B MAILIN
425    If defined an additional mail folder where Mixmaster should read messages from
426    when processing its pool. If it ends with a
427    .B /
428    it is treated as a Maildir, otherwise a standard mbox format file
429    is expected. All messages are removed from the folder after reading.
430    .B MAILIN
431    is not set by default.
432    It is an incredibly bad idea to set this the same as \fBMAILBOX\fP.
433    .TP
434  .B VERBOSE  .B VERBOSE
435  If  If
436  .B VERBOSE  .B VERBOSE
# Line 427  is set to Line 439  is set to
439  Mixmaster will log error  Mixmaster will log error
440  messages only. If it is set to  messages only. If it is set to
441  .BR 1 ,  .BR 1 ,
442  error message and warnings are logged. If  error messages and warnings are logged. If
443  .B VERBOSE  .B VERBOSE
444  is set to  is set to
445  .BR 2 ,  .BR 2 ,
# Line 459  Enable remailer functionality. Default: Line 471  Enable remailer functionality. Default:
471  .TP  .TP
472  .B MIDDLEMAN  .B MIDDLEMAN
473  Act as an intermediate hop only, forward anonymized  Act as an intermediate hop only, forward anonymized
474  messages to an other remailer. This mode can be used  messages to another remailer. This mode can be used
475  where complaints about anonymous messages must be  where complaints about anonymous messages must be
476  avoided. (The variable  avoided. (The variable
477  .B FORWARDTO  .B FORWARDTO
478  specifies the remailer  specifies the remailer
479  chain to be used; default:  chain to be used; default:
480  .BR * .)  .BR * .)
481  Default:  Default:
482  .BR n .  .BR n .
# Line 523  file by sending the remailer a message c Line 535  file by sending the remailer a message c
535  .BR destination-block .  .BR destination-block .
536  Default:  Default:
537  .BR y .  .BR y .
538    .TP
539    .B STATSDETAILS
540    List statistics on intermediate vs. final delivery in remailer-stats.
541    Default:
542    .BR y .
543  .PP  .PP
544  The following variables have numeric values:  The following variables have numeric values:
545  .TP  .TP
# Line 534  Client default: Line 551  Client default:
551  .BR 0 .  .BR 0 .
552  .TP  .TP
553  .B RATE  .B RATE
554  Percentage of messages from the pool to be sent. Remailer default:  Percentage of messages from the pool to be sent. Remailer default:
555  .BR 95 .  .BR 95 .
556  Client default:  Client default:
557  .BR 100 .  .BR 100 .
558  Lower values cause the pool to increase in size when  Lower values cause the pool to increase in size when
559  many messages are received at a time, reducing the effect  many messages are received at a time, reducing the effect
# Line 544  of flooding attacks. Line 561  of flooding attacks.
561  .TP  .TP
562  .B INDUMMYP  .B INDUMMYP
563  Probability that Mixmaster will generate dummy messages upon  Probability that Mixmaster will generate dummy messages upon
564  receipt of incoming mail. Larger numbers mean more dummy  receipt of incoming mail. Larger numbers mean more dummy
565  messages on average. For instance,  messages on average. For instance,
566  .B 10  .B 10
567  means that on average one in nine incoming messages will trigger  means that on average one in nine incoming messages will trigger
568  a dummy generation, and  a dummy generation, and
569  .B 20  .B 20
570  means that one in four will.  means that one in four will.
571  .B 0  .B 0
572  means no dummy messages. Remailer default:  means no dummy messages. Remailer default:
573  .BR 20 .  .BR 20 .
574  Client default:  Client default:
575  .BR 3 .  .BR 3 .
576  .TP  .TP
577  .B OUTDUMMYP  .B OUTDUMMYP
578  Probability that Mixmaster will generate dummy messages at  Probability that Mixmaster will generate dummy messages at
579  .B SENDPOOL  .B SENDPOOL
580  time. If the pool is processed frequently, this should be a lower value  time. If the pool is processed frequently, this should be a lower value
581  than if there are long intervals between pool processing. Examples:  than if there are long intervals between pool processing. Examples:
582  .B 50  .B 50
583  means on average, one dummy message will be generated per pool  means on average, one dummy message will be generated per pool
584  processing.  processing.
585  .B 80  .B 80
586  means four will be generated.  means four will be generated.
587  .B 0  .B 0
588  means no dummy messages. Remailer default:  means no dummy messages. Remailer default:
589  .BR 67 .  .BR 67 .
# Line 574  Client default: Line 591  Client default:
591  .BR 3 .  .BR 3 .
592  .TP  .TP
593  .B SIZELIMIT  .B SIZELIMIT
594  Maximal size for anonymous messages in kB.  Maximum size for anonymous messages in kB.
595  .B 0  .B 0
596  means no limit.  means no limit.
597  Default:  Default:
598  .BR 0 .  .BR 0 .
599  .TP  .TP
600  .B POP3SIZELIMIT  .B POP3SIZELIMIT
601  Maximal size for incoming messages in kB when using POP3.  Maximum size for incoming messages in kB when using POP3.
602  .B 0  .B 0
603  means no limit.  means no limit.
604  Default:  Default:
# Line 593  is set to Line 610  is set to
610  and left on the server otherwise.  and left on the server otherwise.
611  .TP  .TP
612  .B INFLATEMAX  .B INFLATEMAX
613  Maximal size for  Maximum size for
614  .B Inflate:  .B Inflate:
615  padding in kB.  padding in kB.
616  .B 0  .B 0
# Line 603  Default: Line 620  Default:
620  .BR kB .  .BR kB .
621  .TP  .TP
622  .B MAXRANDHOPS  .B MAXRANDHOPS
623  Maximal chain length for message forwarding requested by  Maximum chain length for message forwarding requested by
624  .B Rand-Hop  .B Rand-Hop
625  directives.  directives.
626  Default:  Default:
# Line 617  How often Mixmaster should check the poo Line 634  How often Mixmaster should check the poo
634  to be sent. Remailer default:  to be sent. Remailer default:
635  .BR 1h .  .BR 1h .
636  Client default:  Client default:
637  .BR 6h .  .BR 0h .
638  .TP  .TP
639  .B POP3TIME  .B POP3TIME
640  How often Mixmaster should check the POP3 accounts  How often Mixmaster should check the POP3 accounts
# Line 630  Default: Line 647  Default:
647  .B MAILINTIME  .B MAILINTIME
648  How often Mixmaster should read mail from  How often Mixmaster should read mail from
649  .BR MAILIN  .BR MAILIN
650  and process mails fetched via POP3. Processing here means to  and process mails fetched via POP3. Processing here means to
651  answer remailer-xxx requests and decrypt messages to the Mixmaster  answer remailer-xxx requests and decrypt messages to the Mixmaster
652  and place them in the pool. No other processing of the pool is  and place them in the pool. No other processing of the pool is
653  done. This action is always performed sending out messages from the pool (at  done. This action is always performed sending out messages from the pool (at
# Line 641  intervals). Default: Line 658  intervals). Default:
658  .BR 5m .  .BR 5m .
659  .TP  .TP
660  .B PACKETEXP  .B PACKETEXP
661  How long to store parts of incomplete multipart messages and other  How long to store parts of incomplete multipart messages and other
662  temporary pool files.  temporary pool files.
663  Default:  Default:
664  .BR 7d .  .BR 7d .
# Line 661  no log is kept. Line 678  no log is kept.
678  .PP  .PP
679  The following strings must be specified at compile-time in  The following strings must be specified at compile-time in
680  .BR config.h .  .BR config.h .
681  Usually it is not necessary to modify any of these:  It is not usually necessary to modify any of these:
682  .TP  .TP
683  .B  .B
684  DISCLAIMER  DISCLAIMER
# Line 686  file is available. Line 703  file is available.
703  .TP  .TP
704  .B MSGFOOTER  .B MSGFOOTER
705  A default string to be inserted at the bottom of the message body  A default string to be inserted at the bottom of the message body
706  of all anonymous messages and no  of all anonymous messages if no
707  .B footer.txt  .B footer.txt
708  file is available.  file is available.
709  .TP  .TP
# Line 698  the remailer is configured to filter out Line 715  the remailer is configured to filter out
715  The character set used for MIME-encoded header lines.  The character set used for MIME-encoded header lines.
716  .TP  .TP
717  .B DESTBLOCK  .B DESTBLOCK
718  A quoted list of files that contain blocked addresses.  A quoted list of files that contain blocked addresses.
719  Files must be separated by one space. Mixmaster will choose  Files must be separated by one space. Mixmaster will choose
720  the first file for writing  the first file for writing if
721  .B AUTOBLOCK  .B AUTOBLOCK
722  is enabled.  is enabled.
723  .PP  .PP
# Line 715  casual attackers. You can use Line 732  casual attackers. You can use
732  .B `make PASS="\fIyour passphrase\fB"'  .B `make PASS="\fIyour passphrase\fB"'
733  to set a passphrase. This should  to set a passphrase. This should
734  .I not  .I not
735  be the same as the client passphrase. This option is now deprecated in  be the same as the client passphrase. This option is now deprecated in
736  favor of the configuration file option  favor of the configuration file option
737  .BR PASSPHRASE .  .BR PASSPHRASE .
738  .TP  .TP
# Line 786  Type 2 remailer keys (\fBPUBRING\fP). Line 803  Type 2 remailer keys (\fBPUBRING\fP).
803  .B rlist.txt  .B rlist.txt
804  List of reliable type 1 remailers (\fBTYPE1LIST\fP).  List of reliable type 1 remailers (\fBTYPE1LIST\fP).
805  .TP  .TP
806  .B mlist.txt  .B mlist.txt
807  List of reliable type 2 remailers (\fBTYPE2REL\fP).  List of reliable type 2 remailers (\fBTYPE2REL\fP).
808  .TP  .TP
809  .B type2.list  .B type2.list
810  List of known type 2 remailers (optional) (\fBTYPE2LIST\fP).  List of known type 2 remailers (optional) (\fBTYPE2LIST\fP).
811    .TP
812    .B starex.txt
813    List of remailers which should not be used in randomly generated
814    remailer chains (\fBSTAREX\fP).
815  .SS Remailer files:  .SS Remailer files:
816  .TP  .TP
817  .B disclaim.txt  .B disclaim.txt
# Line 861  Mixmaster does not send mail to the bloc Line 882  Mixmaster does not send mail to the bloc
882  .B rab.blk  .B rab.blk
883  Identical to  Identical to
884  .BR dest.blk ,  .BR dest.blk ,
885  except that Mixmaster will not write to this file.  except Mixmaster will not write to this file.
886  For use with external remailer abuse blocklists.  For use with external remailer abuse blocklists.
887  .TP  .TP
888  .B source.blk  .B source.blk
889  List of blocked source addresses.  If an incoming message originates  List of blocked source addresses.  If an incoming message originates
890  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
891  feature can be used to avoid spam and other abusive mail (\fBSOURCEBLOCK\fP).  feature can be used to avoid spam and other abusive mail (\fBSOURCEBLOCK\fP).
892  .TP  .TP
893  .B header.blk  .B header.blk
894  List of unwanted header fields. The file is used to delete unwanted  List of unwanted header fields. The file is used to delete unwanted
895  header lines (e.g. lines that indicate a false identity, or Usenet  header lines (e.g. lines that indicate a false identity, or Usenet
896  control messages), and do other header filtering (\fBHDRFILTER\fP).  control messages), and do other header filtering (\fBHDRFILTER\fP).
897  .PP  
898  A destination address or header line is left out if it contains a  A destination address or header line is left out if it contains a
899  search string or matches a regular expression specified in the block  search string or matches a regular expression specified in the block
900  file. Lines in the block file that begin and end with a slash  file. Lines in the block file that begin and end with a slash
# Line 907  Random seed file (\fBMIXRAND\fP). Line 928  Random seed file (\fBMIXRAND\fP).
928  List of your nyms with configuration data (encrypted) (\fBNYMDB\fP).  List of your nyms with configuration data (encrypted) (\fBNYMDB\fP).
929  .TP  .TP
930  .B nymsec.pgp  .B nymsec.pgp
931  Your nyms' secret PGP keys (encrypted) (\fBNYMSECRING\fP).  Your nym's secret PGP keys (encrypted) (\fBNYMSECRING\fP).
932  .TP  .TP
933  .B secring.pgp  .B secring.pgp
934  Remailer type 1 secret keys (\fBPGPREMSECRING\fP).  Remailer type 1 secret keys (\fBPGPREMSECRING\fP).
# Line 919  Remailer type 2 secret keys (\fBSECRING\ Line 940  Remailer type 2 secret keys (\fBSECRING\
940  The public type 1 remailer key (\fBPGPKEY\fP).  The public type 1 remailer key (\fBPGPKEY\fP).
941  .TP  .TP
942  .B key.txt  .B key.txt
943  The public type 2 remailer key (\fB\fP).  The public type 2 remailer key (\fBKEYFILE\fP).
944  .TP  .TP
945  .B id.log  .B id.log
946  Log file of messages already processed (\fBKEYFILE\fP).  Log file of messages already processed (\fBKEYFILE\fP).
# Line 936  Public Diffie-Hellman parameters used fo Line 957  Public Diffie-Hellman parameters used fo
957  .B dsaparam.mix  .B dsaparam.mix
958  Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).  Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).
959  .TP  .TP
960    .B mix.pid
961    Pid file in daemon mode (\fBPIDFILE\fP).
962    .TP
963    .BI pool/
964    Message pool directory (\fBPOOL\fP).
965    .TP
966  .BI pool/m *  .BI pool/m *
967  Message pool.  Message pool files.
968  .TP  .TP
969  .BI pool/p *  .BI pool/p *
970  Partial messages.  Partial messages.
Legend:
Removed from v.220  
changed lines
  Added in v.397
  ViewVC Help
Powered by ViewVC 1.1.5