Import ezmlm-idx 0.40
[ezmlm] / ezmlm-sub.1
1 .TH ezmlm-sub 1
2 .SH NAME
3 ezmlm-sub \- manually add addresses to a mailing list
4 .SH SYNOPSIS
5 .B ezmlm-sub
6 [
7 .B \-HmMnNsSvV
8 ][
9 .B \-h
10 .I hash
11 ]
12 .B
13 .I dir
14 [
15 .I box\fB@\fIdomain
16 [
17 .I name
18 ]
19 .I ...
20 ]
21 .SH DESCRIPTION
22 .B ezmlm-sub
23 adds each address
24 .I box\fB@\fIdomain
25 to the mailing list stored in
26 .IR dir .
27 .I name
28 is added as a comment to the subscription log, if the
29 .B \-n
30 switch is used.
31
32 If no argument is given on the command line,
33 .B ezmlm-sub
34 processes stdin.
35
36 If
37 .I box\fB@\fIdomain
38 is already on the mailing list,
39 .B ezmlm-sub
40 leaves it there and does not modify the subscription log.
41
42 .B ezmlm-sub
43 converts
44 .I domain
45 to lowercase before adding
46 .I box\fB@\fIdomain
47 to the mailing list.
48
49 .I box\fB@\fIdomain
50 cannot be longer than 400 characters (255 characters with mysql support).
51 .SH "GENERAL OPTIONS"
52 .TP
53 .B \-n
54 Assume arguments are pairs of
55 .I box\fB@\fIdomain
56 and
57 .IR name
58 (or other subscriber info)
59 rather than addresses alone.
60 .B ezmlm-sub(1)
61 will add the first argument in each pair to the subscriber list. If it is
62 a new address,
63 .I name
64 will be added to the subscription log.
65 .TP
66 .B \-N
67 (Default.)
68 Arguments are all addresses of the type
69 .IR box\fB@\fIdomain .
70 .TP
71 .B \-v
72 Display
73 .B ezmlm-sub(1)
74 version information.
75 .TP
76 .B \-V
77 Display
78 .B ezmlm-sub(1)
79 version information.
80 .SH "MYSQL OPTIONS"
81 These option is silently ignored in the absence of mysql support.
82 .TP
83 .B \-h \fIhash
84 With mysql support the argument is used as the hash. The argument should
85 be between 1 and 99. The hash is used in
86 in the distribution of addresses between sublists. As the hash is normally
87 between 0 and 52, controlling the hash makes it possible to add addresses
88 that cannot be manipulated remotely.
89 .TP
90 .B \-m
91 (Default.)
92 Use SQL support if available.
93 .TP
94 .B \-M
95 Do not use SQL support even if available. This option can be used to build
96 a normal local subscriber database even for lists with SQL support. Use
97 in combination with
98 .B ezmlm-list(1)
99 to convert an SQL address db to a ezmlm standard address database.
100 .SH "SEE ALSO"
101 ezmlm-list(1),
102 ezmlm-manage(1),
103 ezmlm-make(1),
104 ezmlm-receipt(1),
105 ezmlm-send(1),
106 ezmlm-unsub(1),
107 ezmlm(5)