debian/rules: Use `git' potty wrapper.
[qmail] / qmail-users.9
1 .TH qmail-users 5
2 .SH NAME
3 qmail-users \- assign mail addresses to users
4 .SH OVERVIEW
5 The file
6 .B QMAILHOME/users/assign
7 assigns addresses to users. For example,
8
9 .EX
10 =joe.shmoe:joe:503:78:/home/joe:::
11 .EE
12
13 says that mail for
14 .B joe.shmoe
15 should be delivered to user
16 .BR joe ,
17 with uid 503 and gid 78,
18 as specified by
19 .BR /home/joe/.qmail .
20
21 Assignments fed to
22 .B qmail-newu
23 will be used by
24 .B qmail-lspawn
25 to control
26 .BR qmail-local 's
27 deliveries.
28 See
29 .BR qmail-newu (8).
30 A change to
31 .B QMAILHOME/users/assign
32 will have no effect until
33 .B qmail-newu
34 is run.
35 .SH STRUCTURE
36 .B QMAILHOME/users/assign
37 is a series of assignments, one per line.
38 It ends with a line containing a single dot.
39 Lines must not contain NUL.
40 .SH "SIMPLE ASSIGNMENTS"
41 A simple assignment is a line of the form
42
43 .EX
44 =local:user:uid:gid:homedir:dash:ext:
45 .EE
46
47 Here
48 .I local
49 is an address;
50 .IR user ,
51 .IR uid ,
52 and
53 .I gid
54 are the account name, uid, and gid
55 of the user in charge of
56 .IR local ;
57 and messages to
58 .I local
59 will be controlled by
60 .IR homedir\fB/.qmail\fIdashext .
61
62 If there are several assignments for the same
63 .I local
64 address,
65 .B qmail-lspawn
66 will use the first one.
67
68 .I local
69 is interpreted without regard to case.
70 .SH "WILDCARD ASSIGNMENTS"
71 A wildcard assignment is a line of the form
72
73 .EX
74 +loc:user:uid:gid:homedir:dash:pre:
75 .EE
76
77 This assignment applies to any address beginning with
78 .IR loc ,
79 including
80 .I loc
81 itself.
82 It means the same as
83
84 .EX
85 =locext:user:uid:gid:homedir:dash:preext:
86 .EE
87
88 for every string
89 .IR ext .
90
91 A more specific wildcard assignment overrides a less specific
92 assignment, and a simple assignment overrides any wildcard assignment.
93 For example:
94
95 .EX
96 +:alias:7790:2108:QMAILHOME/alias:-::
97 +joe-:joe:507:100:/home/joe:-::
98 =joe:joe:507:100:/home/joe:::
99 .EE
100
101 The address
102 .B joe
103 is handled by the third line;
104 the address
105 .B joe-direct
106 is handled by the second line;
107 the address
108 .B bill
109 is handled by the first line.
110 .SH "SEE ALSO"
111 qmail-pw2u(8),
112 qmail-newu(8),
113 qmail-lspawn(8)