is a program for indexing and searching email messages stored in maildir, MH or mbox folders.
| mairixrc.5 (mairix-0.23) | : | mairixrc.5 (mairix-0.24) |
|---|
| | |
| skipping to change at line 25 | | skipping to change at line 25 |
|---|
| The directives base, mfolder, and database must always appear in the file
. There must also be some | | The directives base, mfolder, and database must always appear in the file
. There must also be some |
| folder definitions (using the maildir, mh, or mbox) directives. | | folder definitions (using the maildir, mh, or mbox) directives. |
| | |
| Comments | | Comments |
| Any line starting with a '#' character is treated as a comment. | | Any line starting with a '#' character is treated as a comment. |
| | |
| Directives | | Directives |
| base=base-directory | | base=base-directory |
| This defines the path to the common parent directory of all your m
aildir folders. | | This defines the path to the common parent directory of all your m
aildir folders. |
| | |
|
| If the path is relative, it is treated as relative to the location | | imap_server=hostname |
| of the mairixrc file. | | If any IMAP source folders are specified or the results folder i |
| | s an IMAP folder, this defines |
| | the host name of the IMAP server. The port is currently always 14 |
| | 3. This option is mutually |
| | exclusive with the |
| | |
| | imap_pipe=shell-command |
| | If any IMAP source folders are specified or the results folder is |
| | an IMAP folder, this defines a |
| | shell command that can be used to connect to the IMAP server and t |
| | alk to it over UNIX pipes |
| | instead of a TCP/IP connection. This option is mutually ex |
| | clusive with the 'imap_server' |
| | option. |
| | |
| | imap_username=username |
| | If any IMAP source folders are specified or the results folder is |
| | an IMAP folder, this defines |
| | the user name to use to log in to the IMAP server. This parameter |
| | is optional, but IMAP servers |
| | normally require clients to log in, so it is normally necessary to |
| | specify it. One example of a |
| | case where it is not required is if the 'imap_pipe' option i |
| | s in use the the shell command |
| | established a connection with an IMAP server in pre-autenticated s |
| | tate. |
| | |
| | imap_password=password |
| | If any IMAP source folders are specified or the results folder is |
| | an IMAP folder, this defines |
| | the password to use to log in to the IMAP server. This parameter |
| | is optional, but IMAP servers |
| | normally require clients to log in, so it is normally necessary to |
| | specify it. |
| | |
| maildir=list-of-folder-specifications | | maildir=list-of-folder-specifications |
|
| This is a colon-separated list of the Maildir folders (rel | | This is a colon-separated list of the Maildir folders (relative |
| ative to `base') that you want | | to `base') that you want |
| indexed. Any entry that ends `...' is recursively scanned to find | | indexed. Any entry that ends `...' is recursively scanned to f |
| any Maildir folders under- | | ind any Maildir folders under- |
| neath it. | | neath it. |
| | |
|
| More than one line starting with `maildir' can be included. | | More than one line starting with `maildir' can be included. In t |
| In this case, mairix joins the | | his case, mairix joins the |
| lines together with colons as though a single list of folders had | | lines together with colons as though a single list of folders h |
| been given on a single very | | ad been given on a single very |
| long line. | | long line. |
| | |
|
| Each colon-separated entry may be a wildcard. See the discuss
ion under mbox (below) for the | | Each colon-separated entry may be a wildcard. See the discussion
under mbox (below) for the |
| wildcard syntax. For example | | wildcard syntax. For example |
| | |
| maildir=zzz/foo*... | | maildir=zzz/foo*... |
| | |
| will match maildir folders like these (relative to the base-direct
ory) | | will match maildir folders like these (relative to the base-direct
ory) |
| | |
| zzz/foobar/xyz | | zzz/foobar/xyz |
| zzz/fooquux | | zzz/fooquux |
| zzz/foo | | zzz/foo |
| zzz/fooabc/u/v/w | | zzz/fooabc/u/v/w |
| | |
| skipping to change at line 59 | | skipping to change at line 80 |
|---|
| | |
| maildir=zzz/foo[abc]* | | maildir=zzz/foo[abc]* |
| | |
| will match maildir folders like these (relative to the folder_base
) | | will match maildir folders like these (relative to the folder_base
) |
| | |
| zzz/fooa | | zzz/fooa |
| zzz/fooaaaxyz | | zzz/fooaaaxyz |
| zzz/foobcd | | zzz/foobcd |
| zzz/fooccccccc | | zzz/fooccccccc |
| | |
|
| If a folder name contains a colon, you can write this by using the | | If a folder name contains a colon, you can write this by using t |
| sequence '\:' to escape the | | he sequence '\:' to escape the |
| colon. Otherwise, the backslash character is treated normally. | | colon. Otherwise, the backslash character is treated normally. ( |
| (If the folder name actually | | If the folder name actually |
| contains the sequence '\:', you're out of luck.) | | contains the sequence '\:', you're out of luck.) |
| | |
| mh=list-of-folder-specifications | | mh=list-of-folder-specifications |
|
| This is a colon-separated list of the MH folders (relative to `bas
e') that you want indexed. | | This is a colon-separated list of the MH folders (relative to
`base') that you want indexed. |
| Any entry that ends '...' is recursively scanned to find any MH fo
lders underneath it. | | Any entry that ends '...' is recursively scanned to find any MH fo
lders underneath it. |
| | |
|
| More than one line starting with 'mh' can be included. In thi | | More than one line starting with 'mh' can be included. In this ca |
| s case, mairix joins the lines | | se, mairix joins the lines |
| together with colons as though a single list of folders had been g | | together with colons as though a single list of folders had be |
| iven on a single very long | | en given on a single very long |
| line. | | line. |
| | |
|
| Each colon-separated entry may be a wildcard, see the discussion
under maildir (above) and mbox | | Each colon-separated entry may be a wildcard, see the discussion u
nder maildir (above) and mbox |
| (below) for the syntax and semantics of specifying wildcards. | | (below) for the syntax and semantics of specifying wildcards. |
| | |
|
| recognizes the types of MH folders created by the following email
applications: | | mairix recognizes the types of MH folders created by the following
email applications: |
| | |
| * xmh | | * xmh |
| | |
| * sylpheed | | * sylpheed |
| | |
| * claws-mail | | * claws-mail |
| | |
| * evolution | | * evolution |
| | |
| * NNML | | * NNML |
| | |
| * Mew | | * Mew |
| | |
| mbox=list-of-folder-specifications | | mbox=list-of-folder-specifications |
| This is a colon-separated list of the mbox folders (relative to `b
ase') that you want indexed. | | This is a colon-separated list of the mbox folders (relative to `b
ase') that you want indexed. |
| | |
|
| Each colon-separated item in the list can be suffixed by '...'. I | | Each colon-separated item in the list can be suffixed by '...'. |
| f the item matches a regular | | If the item matches a regular |
| file, that file is treated as a mbox folder and the '...' s | | file, that file is treated as a mbox folder and the '...' suffix |
| uffix is ignored. If the item | | is ignored. If the item |
| matches a directory, a recursive scan of everything inside that di
rectory is made, and all regu- | | matches a directory, a recursive scan of everything inside that di
rectory is made, and all regu- |
|
| lar files are initially considered as mbox folders. (Any dire
ctories found in this scan are | | lar files are initially considered as mbox folders. (Any director
ies found in this scan are |
| themselves scanned, since the scan is recursive.) | | themselves scanned, since the scan is recursive.) |
| | |
|
| Each colon-separated item may contain wildcard operators, but only
in its final path component. | | Each colon-separated item may contain wildcard operators, but onl
y in its final path component. |
| The wildcard operators currently supported are | | The wildcard operators currently supported are |
| | |
| * | | * |
| Match zero or more characters (each character matched is arbitrary
) | | Match zero or more characters (each character matched is arbitrary
) |
| | |
| ? | | ? |
| Match exactly one arbitrary character | | Match exactly one arbitrary character |
| | |
| [abcs-z] | | [abcs-z] |
| Character class : match a single character from the set a, b, c, s
, t, u, v, w, x, y and z. | | Character class : match a single character from the set a, b, c, s
, t, u, v, w, x, y and z. |
| | |
| skipping to change at line 134 | | skipping to change at line 155 |
|---|
| | |
| mbox=foo... | | mbox=foo... |
| matches any regular file in the tree rooted at 'foo' | | matches any regular file in the tree rooted at 'foo' |
| | |
| mbox=foo/*... | | mbox=foo/*... |
| same as before | | same as before |
| | |
| mbox=foo/[a-z]*... | | mbox=foo/[a-z]*... |
| matches 'foo/a', 'foo/aardvark/xxx', 'foo/zzz/foobar', ´foo/w/x/y/
zzz', but not 'foo/A/foobar' | | matches 'foo/a', 'foo/aardvark/xxx', 'foo/zzz/foobar', ´foo/w/x/y/
zzz', but not 'foo/A/foobar' |
| | |
|
| Regular files that are mbox folder candidates are examined interna
lly. Only files containing | | Regular files that are mbox folder candidates are examined inte
rnally. Only files containing |
| standard mbox 'From ' separator lines will be scanned for messages
. | | standard mbox 'From ' separator lines will be scanned for messages
. |
| | |
|
| If a regular file has a name ending in '.gz', and gzip suppo
rt is compiled into the mairix | | If a regular file has a name ending in '.gz', and gzip support i
s compiled into the mairix |
| binary, the file will be treated as a gzipped mbox. | | binary, the file will be treated as a gzipped mbox. |
| | |
|
| If a regular file has a name ending in '.bz2', and bzip support i
s compiled into the mairix | | If a regular file has a name ending in '.bz2', and bzip suppo
rt is compiled into the mairix |
| binary, the file will be treated as a bzip2'd mbox. | | binary, the file will be treated as a bzip2'd mbox. |
| | |
|
| More than one line starting with 'mbox' can be included. In thi | | More than one line starting with 'mbox' can be included. In this |
| s case, mairix joins the lines | | case, mairix joins the lines |
| together with colons as though a single list of folders had been g | | together with colons as though a single list of folders had be |
| iven on a single very long | | en given on a single very long |
| line. | | line. |
| | |
|
| mairix performs no locking of mbox folders when it is accessing | | mairix performs no locking of mbox folders when it is accessing th |
| them. If a mail delivery pro- | | em. If a mail delivery pro- |
| gram is modifying the mbox at the same time, it is likely that one | | gram is modifying the mbox at the same time, it is likely that on |
| or messages in the mbox will | | e or messages in the mbox will |
| never get indexed by mairix (until the database is removed and re | | never get indexed by mairix (until the database is removed and rec |
| created from scratch, anyway.) | | reated from scratch, anyway.) |
| The assumption is that mairix will be used to index archive folder | | The assumption is that mairix will be used to index archive fold |
| s rather than incoming ones, | | ers rather than incoming ones, |
| so this is unlikely to be much of a problem in reality. | | so this is unlikely to be much of a problem in reality. |
| | |
|
| mairix can support a maximum of 65536 separate mboxes, and a ma
ximum of 65536 messages within | | mairix can support a maximum of 65536 separate mboxes, and a maxim
um of 65536 messages within |
| any one mbox. | | any one mbox. |
| | |
|
| | imap=list-of-folders |
| | This is a colon-separated list of the IMAP folders that you want i |
| | ndexed. |
| | |
| | These folders must all be located on the same account on the same |
| | IMAP server. The configuration |
| | options imap_server and imap_pipe specify how to connect to the IM |
| | AP server. |
| | |
| | More than one line starting with 'imap' can be included. In this |
| | case, mairix joins the lines |
| | together with colons as though a single list of folders had be |
| | en given on a single very long |
| | line. |
| | |
| omit=list-of-glob-patterns | | omit=list-of-glob-patterns |
| This is a colon-separated list of glob patterns for folders to be
omitted from the indexing. | | This is a colon-separated list of glob patterns for folders to be
omitted from the indexing. |
| This allows wide wildcards and recursive elements to be used in
the maildir,mh, andmbox direc- | | This allows wide wildcards and recursive elements to be used in
the maildir,mh, andmbox direc- |
| tives, with the omit option used to selectively remove unwanted fo
lders from the folder lists. | | tives, with the omit option used to selectively remove unwanted fo
lders from the folder lists. |
| | |
| Within the glob patterns, a single '*' matches any sequence of cha
racters other than '/'. How- | | Within the glob patterns, a single '*' matches any sequence of cha
racters other than '/'. How- |
| ever '**' matches any sequence of characters including '/'. T
his allows glob patterns to be | | ever '**' matches any sequence of characters including '/'. T
his allows glob patterns to be |
| constructed which have a wildcard for just one directory component
, or for any number of direc- | | constructed which have a wildcard for just one directory component
, or for any number of direc- |
| tory components. | | tory components. |
| | |
| | |
| skipping to change at line 207 | | skipping to change at line 238 |
|---|
| mairix will refuse to output search results to a folder that appea
rs to be amongst those that | | mairix will refuse to output search results to a folder that appea
rs to be amongst those that |
| are indexed. This is to prevent accidental deletion of emails. | | are indexed. This is to prevent accidental deletion of emails. |
| | |
| If the first character of the mfolder value is '/' or '.', it is
taken as a pathname in its own | | If the first character of the mfolder value is '/' or '.', it is
taken as a pathname in its own |
| right. This allows you to specify absolute paths and paths relati
ve to the current directory | | right. This allows you to specify absolute paths and paths relati
ve to the current directory |
| where the mfolder should be written. Otherwise, the value of mf
older is appended to the value | | where the mfolder should be written. Otherwise, the value of mf
older is appended to the value |
| of base, in the same way as for the source folders. | | of base, in the same way as for the source folders. |
| | |
| mformat=format | | mformat=format |
| This defines the type of folder used for the match folder where th
e search results go. There | | This defines the type of folder used for the match folder where th
e search results go. There |
|
| are four valid settings for format, namely 'maildir', 'mh', 'mbox | | are six valid settings for format, namely 'maildir', 'mh', 'mbox' |
| ', 'raw' or 'excerpt'. If the | | , 'imap', 'raw', or 'excerpt'. |
| 'raw' setting is used then mairix will just print out the path nam | | If the 'raw' setting is used then mairix will just print out the p |
| es of the files that match and | | ath names of the files that |
| no match folder will be created. If the 'excerpt' setting is us | | match and no match folder will be created. If the 'excerpt' set |
| ed, mairix will also print out | | ting is used, mairix will also |
| the To:, Cc:, From:, Subject: and Date: headers of the matching | | print out the To:, Cc:, From:, Subject: and Date: headers of the m |
| messages. 'maildir' is the | | atching messages. 'maildir' |
| default if this option is not defined. The setting is case-insens | | is the default if this option is not defined. The setting is case |
| itive. | | -insensitive. |
| | |
| database=path-to-database | | database=path-to-database |
| This defines the path where mairix's index database is kept. Y
ou can keep this file anywhere | | This defines the path where mairix's index database is kept. Y
ou can keep this file anywhere |
| you like. | | you like. |
| | |
| Currently, mairix will place a single database file at the locatio
n indicated by path-to-data- | | Currently, mairix will place a single database file at the locatio
n indicated by path-to-data- |
| base. However, a future version of mairix may instead place
a directory containing several | | base. However, a future version of mairix may instead place
a directory containing several |
| files at this location. | | files at this location. |
| | |
| path-to-database should be an absolute pathname (starting with '/'
). If a relative pathname is | | path-to-database should be an absolute pathname (starting with '/'
). If a relative pathname is |
| used, it will be interpreted relative to the current directory a
t the time mairix is run, (not | | used, it will be interpreted relative to the current directory a
t the time mairix is run, (not |
| relative to the location of the mairixrc file or anything like tha
t.) | | relative to the location of the mairixrc file or anything like tha
t.) |
| | |
|
| | follow_mbox_symlinks |
| | This takes no arguments. By default, mairix will skip symlinks to |
| | mboxes when indexing. If a |
| | line starting with follow_mbox_symlinks is present, mairix will f |
| | ollow them instead of skipping |
| | them. |
| | |
| Expansions | | Expansions |
| The part of each line in '.mairixrc' following the equals sign can cont
ain the following types of | | The part of each line in '.mairixrc' following the equals sign can cont
ain the following types of |
| expansion: | | expansion: |
| | |
| Home directory expansion | | Home directory expansion |
| If the sequence '~/' appears at the start of the text after the
equals sign, it is expanded to | | If the sequence '~/' appears at the start of the text after the
equals sign, it is expanded to |
| the user's home directory. Example: | | the user's home directory. Example: |
| | |
| database=~/Mail/mairix_database | | database=~/Mail/mairix_database |
| | |
| | | |
| End of changes. 21 change blocks. |
|---|
| 54 lines changed or deleted | | 109 lines changed or added |
|---|
"Fossies" - the Fresh Open Source Software Archive 