1 .rn '' }` |
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13 |
2 ''' $RCSfile$$Revision$$Date$ |
2 .\" |
3 ''' |
3 .\" Standard preamble: |
4 ''' $Log$ |
4 .\" ======================================================================== |
5 ''' |
5 .de Sh \" Subsection heading |
6 .de Sh |
|
7 .br |
6 .br |
8 .if t .Sp |
7 .if t .Sp |
9 .ne 5 |
8 .ne 5 |
10 .PP |
9 .PP |
11 \fB\\$1\fR |
10 \fB\\$1\fR |
12 .PP |
11 .PP |
13 .. |
12 .. |
14 .de Sp |
13 .de Sp \" Vertical space (when we can't use .PP) |
15 .if t .sp .5v |
14 .if t .sp .5v |
16 .if n .sp |
15 .if n .sp |
17 .. |
16 .. |
18 .de Ip |
17 .de Vb \" Begin verbatim text |
19 .br |
|
20 .ie \\n(.$>=3 .ne \\$3 |
|
21 .el .ne 3 |
|
22 .IP "\\$1" \\$2 |
|
23 .. |
|
24 .de Vb |
|
25 .ft CW |
18 .ft CW |
26 .nf |
19 .nf |
27 .ne \\$1 |
20 .ne \\$1 |
28 .. |
21 .. |
29 .de Ve |
22 .de Ve \" End verbatim text |
30 .ft R |
23 .ft R |
31 |
|
32 .fi |
24 .fi |
33 .. |
25 .. |
34 ''' |
26 .\" Set up some character translations and predefined strings. \*(-- will |
35 ''' |
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
36 ''' Set up \*(-- to give an unbreakable dash; |
28 .\" double quote, and \*(R" will give a right double quote. | will give a |
37 ''' string Tr holds user defined translation string. |
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
38 ''' Bell System Logo is used as a dummy character. |
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
39 ''' |
31 .\" expand to `' in nroff, nothing in troff, for use with C<>. |
40 .tr \(*W-|\(bv\*(Tr |
32 .tr \(*W-|\(bv\*(Tr |
|
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
41 .ie n \{\ |
34 .ie n \{\ |
42 .ds -- \(*W- |
35 . ds -- \(*W- |
43 .ds PI pi |
36 . ds PI pi |
44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
46 .ds L" "" |
39 . ds L" "" |
47 .ds R" "" |
40 . ds R" "" |
48 ''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of |
41 . ds C` "" |
49 ''' \*(L" and \*(R", except that they are used on ".xx" lines, |
42 . ds C' "" |
50 ''' such as .IP and .SH, which do another additional levels of |
|
51 ''' double-quote interpretation |
|
52 .ds M" """ |
|
53 .ds S" """ |
|
54 .ds N" """"" |
|
55 .ds T" """"" |
|
56 .ds L' ' |
|
57 .ds R' ' |
|
58 .ds M' ' |
|
59 .ds S' ' |
|
60 .ds N' ' |
|
61 .ds T' ' |
|
62 'br\} |
43 'br\} |
63 .el\{\ |
44 .el\{\ |
64 .ds -- \(em\| |
45 . ds -- \|\(em\| |
65 .tr \*(Tr |
46 . ds PI \(*p |
66 .ds L" `` |
47 . ds L" `` |
67 .ds R" '' |
48 . ds R" '' |
68 .ds M" `` |
|
69 .ds S" '' |
|
70 .ds N" `` |
|
71 .ds T" '' |
|
72 .ds L' ` |
|
73 .ds R' ' |
|
74 .ds M' ` |
|
75 .ds S' ' |
|
76 .ds N' ` |
|
77 .ds T' ' |
|
78 .ds PI \(*p |
|
79 'br\} |
49 'br\} |
80 .\" If the F register is turned on, we'll generate |
50 .\" |
81 .\" index entries out stderr for the following things: |
51 .\" If the F register is turned on, we'll generate index entries on stderr for |
82 .\" TH Title |
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
83 .\" SH Header |
53 .\" entries marked with X<> in POD. Of course, you'll have to process the |
84 .\" Sh Subsection |
54 .\" output yourself in some meaningful fashion. |
85 .\" Ip Item |
55 .if \nF \{\ |
86 .\" X<> Xref (embedded |
56 . de IX |
87 .\" Of course, you have to process the output yourself |
57 . tm Index:\\$1\t\\n%\t"\\$2" |
88 .\" in some meaninful fashion. |
|
89 .if \nF \{ |
|
90 .de IX |
|
91 .tm Index:\\$1\t\\n%\t"\\$2" |
|
92 .. |
58 .. |
93 .nr % 0 |
59 . nr % 0 |
94 .rr F |
60 . rr F |
95 .\} |
61 .\} |
96 .TH VAUTHENTICATE 1 "vmailmgr 0.96.9" "2000-09-30" "VMailMgr Tools Documentation" |
62 .\" |
97 .UC |
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
98 .if n .hy 0 |
64 .\" way too many mistakes in technical documents. |
|
65 .hy 0 |
99 .if n .na |
66 .if n .na |
100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
67 .\" |
101 .de CQ \" put $1 in typewriter font |
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
102 .ft CW |
69 .\" Fear. Run. Save yourself. No user-serviceable parts. |
103 'if n "\c |
70 . \" fudge factors for nroff and troff |
104 'if t \\&\\$1\c |
|
105 'if n \\&\\$1\c |
|
106 'if n \&" |
|
107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 |
|
108 '.ft R |
|
109 .. |
|
110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 |
|
111 . \" AM - accent mark definitions |
|
112 .bd B 3 |
|
113 . \" fudge factors for nroff and troff |
|
114 .if n \{\ |
71 .if n \{\ |
115 . ds #H 0 |
72 . ds #H 0 |
116 . ds #V .8m |
73 . ds #V .8m |
117 . ds #F .3m |
74 . ds #F .3m |
118 . ds #[ \f1 |
75 . ds #[ \f1 |
119 . ds #] \fP |
76 . ds #] \fP |
120 .\} |
77 .\} |
121 .if t \{\ |
78 .if t \{\ |
122 . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
123 . ds #V .6m |
80 . ds #V .6m |
124 . ds #F 0 |
81 . ds #F 0 |
125 . ds #[ \& |
82 . ds #[ \& |
126 . ds #] \& |
83 . ds #] \& |
127 .\} |
84 .\} |
128 . \" simple accents for nroff and troff |
85 . \" simple accents for nroff and troff |
129 .if n \{\ |
86 .if n \{\ |
130 . ds ' \& |
87 . ds ' \& |
131 . ds ` \& |
88 . ds ` \& |
132 . ds ^ \& |
89 . ds ^ \& |
133 . ds , \& |
90 . ds , \& |
134 . ds ~ ~ |
91 . ds ~ ~ |
135 . ds ? ? |
92 . ds / |
136 . ds ! ! |
|
137 . ds / |
|
138 . ds q |
|
139 .\} |
93 .\} |
140 .if t \{\ |
94 .if t \{\ |
141 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
142 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
143 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
144 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
145 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
146 . ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' |
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
147 . ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' |
|
148 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
|
149 . ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' |
|
150 .\} |
101 .\} |
151 . \" troff and (daisy-wheel) nroff accents |
102 . \" troff and (daisy-wheel) nroff accents |
152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] |
|
155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' |
|
156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' |
|
157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] |
|
158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
163 .ds ae a\h'-(\w'a'u*4/10)'e |
110 .ds ae a\h'-(\w'a'u*4/10)'e |
164 .ds Ae A\h'-(\w'A'u*4/10)'E |
111 .ds Ae A\h'-(\w'A'u*4/10)'E |
165 .ds oe o\h'-(\w'o'u*4/10)'e |
112 . \" corrections for vroff |
166 .ds Oe O\h'-(\w'O'u*4/10)'E |
|
167 . \" corrections for vroff |
|
168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
170 . \" for low resolution devices (crt and lpr) |
115 . \" for low resolution devices (crt and lpr) |
171 .if \n(.H>23 .if \n(.V>19 \ |
116 .if \n(.H>23 .if \n(.V>19 \ |
172 \{\ |
117 \{\ |
173 . ds : e |
118 . ds : e |
174 . ds 8 ss |
119 . ds 8 ss |
175 . ds v \h'-1'\o'\(aa\(ga' |
120 . ds o a |
176 . ds _ \h'-1'^ |
121 . ds d- d\h'-1'\(ga |
177 . ds . \h'-1'. |
122 . ds D- D\h'-1'\(hy |
178 . ds 3 3 |
123 . ds th \o'bp' |
179 . ds o a |
124 . ds Th \o'LP' |
180 . ds d- d\h'-1'\(ga |
125 . ds ae ae |
181 . ds D- D\h'-1'\(hy |
126 . ds Ae AE |
182 . ds th \o'bp' |
|
183 . ds Th \o'LP' |
|
184 . ds ae ae |
|
185 . ds Ae AE |
|
186 . ds oe oe |
|
187 . ds Oe OE |
|
188 .\} |
127 .\} |
189 .rm #[ #] #H #V #F C |
128 .rm #[ #] #H #V #F C |
|
129 .\" ======================================================================== |
|
130 .\" |
|
131 .IX Title "VAUTHENTICATE 1" |
|
132 .TH VAUTHENTICATE 1 "2003-12-01" "vmailmgr 0.97" "VMailMgr Tools Documentation" |
190 .SH "NAME" |
133 .SH "NAME" |
191 vauthenticate \- Authenticate a virtual user |
134 vauthenticate \- Authenticate a virtual user |
192 .SH "SYNOPSIS" |
135 .SH "SYNOPSIS" |
193 \fBvauthenticate\fR |
136 .IX Header "SYNOPSIS" |
|
137 \&\fBvauthenticate\fR |
194 .SH "DESCRIPTION" |
138 .SH "DESCRIPTION" |
195 \fIvauthenticate\fR reads a domain name, user name, and pass phrase from |
139 .IX Header "DESCRIPTION" |
|
140 \&\fIvauthenticate\fR reads a domain name, user name, and pass phrase from |
196 standard input, and authenticates the virtual user. If authentication |
141 standard input, and authenticates the virtual user. If authentication |
197 is successful, it prints out information about the virtual user on |
142 is successful, it prints out information about the virtual user on |
198 stdout |
143 stdout |
199 .PP |
144 .PP |
200 The domain name, user name, and pass phrase are passed to |
145 The domain name, user name, and pass phrase are passed to |
201 \fIvauthenticate\fR on standard input each seperated by a NUL byte. |
146 \&\fIvauthenticate\fR on standard input each seperated by a \s-1NUL\s0 byte. |
202 .PP |
147 .PP |
203 The output consists of a series of lines containing an identifier, an |
148 The output consists of a series of lines containing an identifier, an |
204 equal sign, and the data for that identifier, terminated by a newline. |
149 equal sign, and the data for that identifier, terminated by a newline. |
205 The identifiers are: |
150 The identifiers are: |
206 .Ip "\s-1UID\s0" 4 |
151 .IP "\s-1UID\s0" 4 |
|
152 .IX Item "UID" |
207 The base user's numerical user \s-1ID\s0. |
153 The base user's numerical user \s-1ID\s0. |
208 .Ip "\s-1GID\s0" 4 |
154 .IP "\s-1GID\s0" 4 |
|
155 .IX Item "GID" |
209 The base user's numerical group \s-1ID\s0. |
156 The base user's numerical group \s-1ID\s0. |
210 .Ip "\s-1USER\s0" 4 |
157 .IP "\s-1USER\s0" 4 |
|
158 .IX Item "USER" |
211 The base user's name. |
159 The base user's name. |
212 .Ip "\s-1HOME\s0" 4 |
160 .IP "\s-1HOME\s0" 4 |
|
161 .IX Item "HOME" |
213 The base user's home directory. |
162 The base user's home directory. |
214 .Ip "\s-1MAILDIR\s0" 4 |
163 .IP "\s-1MAILDIR\s0" 4 |
215 The virtual user's mailbox directory, relative to \f(CWHOME\fR. |
164 .IX Item "MAILDIR" |
216 .Ip "\s-1VUSER\s0" 4 |
165 The virtual user's mailbox directory, relative to \f(CW\*(C`HOME\*(C'\fR. |
|
166 .IP "\s-1VUSER\s0" 4 |
|
167 .IX Item "VUSER" |
217 The virtual user's name. |
168 The virtual user's name. |
218 .SH "OPTIONS" |
169 .SH "OPTIONS" |
|
170 .IX Header "OPTIONS" |
219 None |
171 None |
220 .SH "RETURN VALUE" |
172 .SH "RETURN VALUE" |
|
173 .IX Header "RETURN VALUE" |
221 Returns 0 if authentication succeeds, and non-zero otherwise. |
174 Returns 0 if authentication succeeds, and non-zero otherwise. |
222 .SH "SEE ALSO" |
175 .SH "SEE ALSO" |
223 \fIvmailmgr\fR\|(7) |
176 .IX Header "SEE ALSO" |
|
177 \&\fIvmailmgr\fR\|(7) |
224 .SH "CAVEATS" |
178 .SH "CAVEATS" |
|
179 .IX Header "CAVEATS" |
225 Although the output from \fIvauthenticate\fR appears to be suitable for |
180 Although the output from \fIvauthenticate\fR appears to be suitable for |
226 using as shell input, care must be taken to escape characters that |
181 using as shell input, care must be taken to escape characters that |
227 would cause the shell to misbehave, such as semicolons. |
182 would cause the shell to misbehave, such as semicolons. |
228 .SH "RESTRICTIONS" |
183 .SH "RESTRICTIONS" |
|
184 .IX Header "RESTRICTIONS" |
229 This program will not authenticate non-virtual users. |
185 This program will not authenticate non-virtual users. |
230 .SH "AUTHOR" |
186 .SH "AUTHOR" |
|
187 .IX Header "AUTHOR" |
231 Bruce Guenter <bruceg@em.ca> |
188 Bruce Guenter <bruceg@em.ca> |
232 |
|
233 .rn }` '' |
|
234 .IX Title "VAUTHENTICATE 1" |
|
235 .IX Name "vauthenticate - Authenticate a virtual user" |
|
236 |
|
237 .IX Header "NAME" |
|
238 |
|
239 .IX Header "SYNOPSIS" |
|
240 |
|
241 .IX Header "DESCRIPTION" |
|
242 |
|
243 .IX Item "\s-1UID\s0" |
|
244 |
|
245 .IX Item "\s-1GID\s0" |
|
246 |
|
247 .IX Item "\s-1USER\s0" |
|
248 |
|
249 .IX Item "\s-1HOME\s0" |
|
250 |
|
251 .IX Item "\s-1MAILDIR\s0" |
|
252 |
|
253 .IX Item "\s-1VUSER\s0" |
|
254 |
|
255 .IX Header "OPTIONS" |
|
256 |
|
257 .IX Header "RETURN VALUE" |
|
258 |
|
259 .IX Header "SEE ALSO" |
|
260 |
|
261 .IX Header "CAVEATS" |
|
262 |
|
263 .IX Header "RESTRICTIONS" |
|
264 |
|
265 .IX Header "AUTHOR" |
|
266 |
|