bincimap

Log | Files | Refs | LICENSE

bincimapd.1 (3465B)

      1 .TH bincimapd 1
      2 .SH "NAME"
      3 bincimapd \- IMAP4rev1 server
      4 
      5 .SH "SYNOPSIS"
      6 .B bincimap-up [ options... ] -- <authenticator> bincimapd
      7 
      8 .SH "DESCRIPTION"
      9 
     10 .B Binc IMAP
     11 is a simple
     12 .B xinetd
     13 /
     14 .B tcpserver
     15 invoked IMAP4rev1 server with support for
     16 .B Maildir.
     17 It is very easy to install and use.
     18 
     19 To configure
     20 .B Binc IMAP,
     21 use either command line arguments, configuration file
     22 entries, or a
     23 .B combination
     24 of both.
     25 
     26 Note that command line arguments always override config file options.
     27 
     28 .SH "OPTIONS"
     29 
     30 Command line arguments are optional. The default behavior is to
     31 inherit options from bincimap-up through the environment. Passing
     32 arguments to bincimapd will override settings inherited from
     33 bincimap-up.
     34 
     35 bincimapd takes one optional unqualified argument in addition to
     36 regular command line options: the \fBMailbox path\fR.  Appending a
     37 path as an option to bincimapd will override any mailbox path set by
     38 command line options or inherited from bincimap-up.
     39 
     40 For a complete listing of options for bincimapd, see the bincimap-up
     41 man page.
     42 
     43 Local options are read through the file .bincimap, located at the
     44 current working directory that bincimapd is invoked in, before it
     45 enters the depository path.
     46 
     47 .SH "FILES"
     48 
     49 All
     50 .B Binc IMAP's
     51 configuration files use the same
     52 .B Binc::Storage
     53 format. It's basically a sequence of named
     54 .B sections
     55 enclosed in
     56 .B {braces},
     57 each containing a set of comma separated
     58 .B key=value
     59 pairs. The
     60 .B keys
     61 must be alphanumeric, and the values can contain
     62 any character if it's
     63 .B quoted.
     64 
     65 .TP
     66 .I $HOME/.bincimap
     67 Local configurations file. This file has a similar structure to the
     68 global
     69 .I bincimap.conf
     70 file, and it can be set by each user to override both command line
     71 arguments and the global configuration. It only works for a few
     72 selected options, though.
     73 
     74 .TP
     75 .I $HOME/<maildepot>/.../bincimap-uidvalidity
     76 This file contains a version number, and the
     77 .B UIDNEXT
     78 and
     79 .B UIDVALIDITY
     80 values for the given mailbox.
     81 
     82 .TP
     83 .I $HOME/<maildepot>/.../bincimap-cache
     84 This file contains a version number, and it stores the
     85 .B UID
     86 values for each message, along with (optionally) some cached
     87 information.
     88 
     89 .SH "ENVIRONMENT"
     90 
     91 bincimapd reads its configuration from the environment, as passed by
     92 bincimap-up. In addition, bincimapd reads the variable
     93 .B BINCIMAP_LOGIN
     94 which contains a message from bincimap-up with the tag and command
     95 used to authenticate, separated by a +. If the tag and command used
     96 to authenticate were "1 LOGIN", then
     97 .B BINCIMAP_LOGIN
     98 would be set to "LOGIN+1".
     99 
    100 Note that it is essential that the authenticator invoked by
    101 bincimap-up does not clear the environment.
    102 
    103 .SH "COPYRIGHT"
    104 Copyright (C) 2002-2005 Andreas Aardal Hanssen
    105 
    106 This is free software; see the source for copying conditions. There is
    107 NO warranty.
    108 
    109 .SH "NOTE"
    110 Please report any bugs to the
    111 .B Binc IMAP
    112 mailing list. Before posting your bug, check out the
    113 .B Binc IMAP
    114 official home page for a list of mailing list archives
    115 to browse.
    116 
    117 .RS
    118 .nf
    119 Mailing list: <binc@bincimap.org>
    120 Developers' mailing list: <binc-dev@bincimap.org>
    121 Announcements list: <binc-news@bincimap.org>
    122 
    123 Subscribing to a mailing list: <binc-subscribe@bincimap.org>
    124 Home page: http://www.bincimap.org/
    125 .fi
    126 .RE
    127 
    128 .SH "AUTHOR"
    129 Andreas Aardal Hanssen <andreas-binc@bincimap.org>
    130 
    131 .RE
    132 .SH "SEE ALSO"
    133 multilog(8) supervise(8) tcpserver(1) bincimapd.conf(5) bincimap-up(1) xinetd(8) xinetd.conf(5)
    134 
    135 .B Note:
    136 The first three man pages are available for download from
    137 .I http://www.qmail.org/.