1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
.TH "rabid" "8" "0.70" "russell@coker.com.au" "Postal"
.SH "NAME"
rabid \- program to test POP server throughput.
.SH "SYNOPSIS"
.B rabid
.I [\-r max\-connections\-per\-minute] [\-p processes] [\-l local\-address]
.I [\-c messages\-per\-connection] [\-a] [\-s ssl\-percentage] [\-i imap\-percentage]
.I [\-b qmail\-pop] [\-d download\-percentage[:delete\-percentage]]
.I [\-[z|Z] debug\-file] [\-u]
.I pop\-server user\-list\-filename
.SH "DESCRIPTION"
This manual page documents briefly the
.BR rabid ,
program.
.P
It is designed to test the performance of POP email servers by reading all
messages from randomly selected accounts as fast as possible. A future version
will support rate limiting to provide a constant load (for testing SMTP
servers).
.P
The
.B pop\-server
parameter specifies the IP address or name of the mail server that the mail
is to downloaded from. If you want to specify a port other than port 110 then
enclose the host address in
square brackets and have the port address immidiately following. If you want
a DNS lookup for every connection (for testing round\-robin DNS) then
immediately preceed the host address with a '+' character.
.P
The
.B user\-list\-filename
is the name of a file which contains a list of user's email addresses and
passwords. It will have one address per line and the password follows the
address with a space to seperate.
.P
The
.B processes
parameter is the number of processes that should be forked off to attempt
seperate connections. A well configured mail server won't accept an unlimited
number of connections so make sure you don't specify a number larger than the
number your mail server is configured to handle. Also for sensible results
make sure that you don't use enough to make your server thrash as the results
won't be representative of real\-world use.
.P
The
.B max\-connections\-per\-minute
parameter is for limiting the number of connections that the program
makes. This is designed to be used when you want to test the performance
of other programs when the system is under load. The default is 24000
connections per minute.
.P
The
.B messages\-per\-connection
parameter specifies the maximum number of messages to download in a single POP
session. The default is \-1 (unlimited).
.P
The
.B local\-address
parameter specifies which local IP address(es) are used to make the outbound
connections. Specified in the same way as the remote address. This is good
for testing LocalDirectors or other devices that perform differently depending
on which source IP address was used.
.P
The
.B \-a
command turns on all logging. All message data received will be logged. This
will make it slow and it may not be able to saturate a fast Ethernet link...
.P
The
.B \-s
switch specifies the percentage of connections which are to use
.B TLS
AKA
.B SSL.
Use 0 for no SSL, or 100 for always SSL, or any number in between. Default is
0.
.P
The
.B \-i
switch specifies the percentage of IMAP connections (default is POP).
.P
The
.B \-b
switch allows you to specify breakage strings. Currently the only option is
for Qmail POP server which adds an extra blank line at the end of each
message.
.B \-b qmail\-pop
means to not report this as an error.
.P
.B \-d download\-percentage[:delete\-percentage]
allows you to specify what percentage of the messages are downloaded and what
percentage of the downloaded messages are deleted. Default is 100%.
.P
The
.B \-u
switch causes the domain of user-names to be ignored. This allows you to have
a single file with user-names and passwords which can be used by postal and
rabid. By default postal will ignore the password field, rabid may or may not
need the domain depending on the configuration of the POP server. The default
is to use the domain (which is required if the same user is present in
multiple domains), this switch causes the domain part to be stripped from the
user-name field.
.P
The
.B \-z
switch allows you to specify a debugging file base. From this base one file
is created for each thread (with a ':' and the thread number appended), each
file is used to log all IO performed by that thread for debugging purposes.
.P
The
.B \-Z
switch is the same but creates a separate file for each connection as well
with an attitional ':' appended followed by the connection number.
.SH "BUGS"
Doesn't actually do SSL or IMAP yet.
.SH "RETURN CODES"
.TP
.B 0
No Error
.TP
.B 1
Bad Parameters
.TP
.B 2
System Error, lack of memory or some other resource
.SH "AUTHOR"
This program, it's manual page, and the Debian package were written by
Russell Coker <russell@coker.com.au>.
.SH "AVAILABILITY"
The source is available from http://doc.coker.com.au/projects/postal/ .
.P
See http://etbe.coker.com.au/category/benchmark for further information.
.SH "SEE ALSO"
.BR postal (8), bhm (8)
|
