bincimap-up.1 (7071B)
1 .TH bincimap-up 1 2 .SH "NAME" 3 bincimap-up \- Authentication stub for Binc IMAP 4 5 .SH "SYNOPSIS" 6 .B bincimap-up [ options... ] -- <authenticator> bincimapd [mailboxpath] 7 8 .SH "DESCRIPTION" 9 10 For more information about Binc IMAP, see the 11 .B bincimapd 12 man pages. 13 14 To configure this stub, use either command line arguments, config file 15 entries, or a 16 .B combination 17 of both. A subset of the config file options is available as command 18 line options. 19 20 Note that command line arguments always override config file options. 21 22 .SH "OPTIONS" 23 24 .TP 25 \fB\-a, \-\-allow-plain\fR 26 If set, allows plain text authentication in an unencrypted (SSL/TLS) 27 IMAP session. 28 29 .TP 30 \fB\ \-\-auth-penalty=<n>\fR 31 Server will sleep for <n> seconds if the client issues a 32 username/password pair that fails to authenticate. 33 34 .TP 35 \fB\-t, \-\-auth-timeout=<n>\fR 36 When the server is in unauthenticated mode, and does not detect any 37 client activity, it will wait <n> seconds before closing (t/o) the 38 connection. <n> can not be less than 30 seconds. 39 40 .TP 41 \fB\-f, \-\-ca-file=<file>\fR 42 A file with one or more certificate authority certificates. It is used 43 to help the client verify the SSL certificate. 44 45 .TP 46 \fB\-P, \-\-ca-path=<path>\fR 47 A path used by the underlying SSL support to search for files with 48 certificate authorities. 49 50 .TP 51 \fB\-l, \-\-cipher-list=<ciphers>\fR 52 Sets the list of available SSL ciphers. 53 54 .TP 55 \fB\-c, \-\-conf=<file>\fR 56 Location of 57 .I bincimap.conf 58 file. 59 60 .TP 61 \fB\-C, \-\-create-inbox\fR 62 If set, server will create the default mailbox 63 .B INBOX 64 on first login if it does not exist. 65 66 .TP 67 \fB\-C, \-\-depot=[Maildir++|IMAPdir]\fR 68 Sets whether to use a Maildir++ or an IMAPdir depot. Default is 69 Maildir++. 70 71 .TP 72 \fB\-d, \-\-disable-starttls\fR 73 Do not advertise the STARTTLS capability. Use this when running Binc 74 IMAP in plain text over an already SSL encrypted tunnel. Default: 75 .B no. 76 77 .TP 78 \fB\-h, -?, \-\-help\fR 79 Displays basic usage. 80 81 .TP 82 \fB\-I, \-\-ip\-variable=<var>\fR 83 For logging, suggests an environment variable that contains the 84 remote host IP address. 85 86 .TP 87 \fB\-i, \-\-idle-timeout=<n>\fR 88 When the server is in authenticated mode, and does not detect any 89 client activity, it will wait <n> seconds before closing (t/o) the 90 connection. <n> can not be less than 1800 seconds. 91 92 .TP 93 \fB\-J, \-\-jail-path=<path>\fR 94 Which path bincimap-up should chroot to after starting bincimapd. 95 96 .TP 97 \fB\-K, \-\-jail-user=<userid>\fR 98 Which user bincimap-up should become after starting bincimapd. 99 100 .TP 101 \fB\-j, \-\-jail-group=<groupid>\fR 102 Which user bincimap-up should become after starting bincimapd. 103 104 .TP 105 \fB\-L, \-\-logtype=[syslog|multilog]\fR 106 Which method 107 .B Binc IMAP 108 should use to log. 109 .I syslog 110 means to connect to syslog. 111 .I multilog 112 means to log to stderr(2). Typically used together with 113 the 114 .I multilog 115 utility. For xinetd, use 116 .I syslog. 117 For daemontools/supervise, use 118 .I multilog. Default: 119 .B syslog. 120 121 .TP 122 \fB\-m, \-\-mailbox-path=<path>\fR 123 Path to mailbox relative from user's home area. Typically 124 .B Maildir 125 for Maildir mailboxes, or the empty string "" if the home area is 126 equivalent to the Maildir directory. 127 128 .TP 129 \fB\-M, \-\-mailbox-type=<type>\fR 130 Which type of mailbox should the server use? Currently only supports 131 .B Maildir. 132 133 .TP 134 \fB\-p, \-\-pem-file=<file>\fR 135 The path to the SSL certificate file, in PEM format. 136 137 .TP 138 \fB\-s, \-\-ssl\fR 139 If set, 140 .B Binc 141 will go straight into SSL server mode. If this option 142 is not passed, 143 .B Binc 144 will still advertise 145 .B STARTTLS, 146 allowing clients to switch to SSL on need. Use 147 .B \-\-ssl 148 if running 149 .B Binc 150 on port 151 .B 993. 152 153 .TP 154 \fB\-S, \-\-subscribe-mailboxes=<mailboxes>\fR 155 If present, server will 156 automatically subscribe client to the given list of mailboxes on first 157 login. Mailbox list is given as a comma separated list with the 158 mailbox' full path, for example 159 .I INBOX,INBOX.Sent-Mail,INBOX.Trash 160 . 161 162 .TP 163 \fB\-b, \-\-transfer-buffersize=<n>\fR 164 The server will buffer up to <n> bytes of data before sending it off 165 to the client. A lower value will give smoother response from the 166 server, but is a bad idea for clients with a big RTT (for example 167 dial-ins). A high value gives better throughput, but a more bulky 168 transfer. 169 170 .TP 171 \fB\-T, \-\-transfer-timeout=<n>\fR 172 The server writes data to the client in bulks. Each bulk gets <n> 173 seconds to complete before the server times out. 174 175 .TP 176 \fB\-u, \-\-umask=<umask>\fR 177 Server will use this umask throughout session. Defaults to user's 178 default umask. 179 180 181 .TP 182 \fB\-V, \-\-verify-peer\fR 183 If set, server will attempt to verify peer certificate. 184 185 .TP 186 \fB\-v, \-\-version\fR 187 Shows Binc IMAP version. 188 189 .TP 190 \fB\-\-\fR 191 Marks the end of options to 192 .B bincimap-up. 193 After this comes the checkpassword compatible authenticator. 194 195 .TP 196 \fB(trailing arguments)\fR 197 Binc IMAP's authenticator. The first argument is invoked as an 198 authenticator subprocess of Binc, with the rest of the arguments 199 passed as the authenticator's local arguments. 200 201 .SH "EXAMPLE INVOCATION" 202 203 The following example shows how to invoke Binc IMAP using multilog, 204 with an example 205 .B /opt 206 location for the conf file and using 207 .I checkpassword 208 as the authenticator. Notice that both the authentication stub and the 209 authenticated daemon must both have command line arguments, and that 210 the authenticator comes after '--'. 211 212 Also notice that after bincimapd comes the mailbox path. This is 213 already set in bincimap.conf, so it's not necessary here, but shown 214 only for the sake of demonstration. 215 216 .RS 217 .nf 218 /opt/bincimap/bin/bincimap-up \\ 219 --conf=/opt/bincimap/etc/bincimap.conf \\ 220 -- \\ 221 /bin/checkpassword \\ 222 /opt/bincimap/bin/bincimapd Maildir 223 .fi 224 .RE 225 226 You will typically invoke 227 .B bincimapd 228 from either 229 .I xinetd 230 or 231 .I supervise. 232 233 .SH "FILES" 234 235 All 236 .B Binc IMAP's 237 configuration files use the same 238 .B Binc::Storage 239 format. It's basically a sequence of named 240 .B sections 241 enclosed in 242 .B {braces}, 243 each containing a set of comma separated 244 .B key=value 245 pairs. The 246 .B keys 247 must be alphanumeric, and the values can contain 248 any character if it's 249 .B quoted. 250 251 .TP 252 \fB.I bincimap.conf\fR 253 Global configurations file. All entries in this file can be overrun 254 with command line arguments. 255 256 .SH "COPYRIGHT" 257 Copyright (C) 2002-2005 Andreas Aardal Hanssen 258 259 This is free software; see the source for copying conditions. There is 260 NO warranty. 261 262 .SH "NOTE" 263 Please report any bugs to the 264 .B Binc IMAP 265 mailing list. Before posting your bug, check out the 266 .B Binc IMAP 267 official home page for a list of mailing list archives 268 to browse. 269 270 .RS 271 .nf 272 Mailing list: <binc@bincimap.org> 273 Developers' mailing list: <binc-dev@bincimap.org> 274 Announcements list: <binc-news@bincimap.org> 275 276 Subscribing to a mailing list: <binc-subscribe@bincimap.org> 277 Home page: http://www.bincimap.org/ 278 .fi 279 .RE 280 281 .SH "AUTHOR" 282 Andreas Aardal Hanssen <andreas-binc@bincimap.org> 283 284 .RE 285 .SH "SEE ALSO" 286 multilog(8) supervise(8) tcpserver(1) bincimapd(1) bincimap.conf(5) xinetd(8) xinetd.conf(5) 287 288 .B Note: 289 The first three man pages are available for download from 290 .I http://www.qmail.org/.