| 1 | .TH ezmlm-idx 1 |
| 2 | .SH NAME |
| 3 | ezmlm-idx \- create index for mailing list archive |
| 4 | .SH SYNOPSIS |
| 5 | .B ezmlm-idx |
| 6 | [ |
| 7 | .B \-dDF |
| 8 | ][ |
| 9 | .B \-f\I msg |
| 10 | ] |
| 11 | .I dir |
| 12 | .SH DESCRIPTION |
| 13 | .B ezmlm-idx |
| 14 | reads all archived messages for the list in |
| 15 | .I dir |
| 16 | from |
| 17 | .IR dir\fB/archive/ |
| 18 | and creates a message index. The index file format is identical to |
| 19 | that produced by |
| 20 | .B ezmlm-send(1) |
| 21 | (when |
| 22 | .IR dir\fB/indexed |
| 23 | is present). |
| 24 | |
| 25 | .B ezmlm-idx |
| 26 | will ignore messages that do not have the owner execute bit set. |
| 27 | |
| 28 | .B ezmlm-idx |
| 29 | will create the the index file under a different name and then |
| 30 | move it into place. |
| 31 | |
| 32 | If |
| 33 | .IR dir\fB/indexed |
| 34 | does not exist, |
| 35 | .B ezmlm-idx |
| 36 | will create it to enable the use of the newly created subject and author index. |
| 37 | |
| 38 | .B ezmlm-idx |
| 39 | will remove reply-indicators and the prefix from the subject before |
| 40 | entry into the index, as described for |
| 41 | .BR ezmlm-send(1) . |
| 42 | .B ezmlm-idx |
| 43 | will decode rfc2047 encoded subject and author headers. When unfolding |
| 44 | split lines, |
| 45 | .B ezmlm-idx |
| 46 | will remove redundant escape sequences for the character |
| 47 | set specified in |
| 48 | .IR dir\fB/charset . |
| 49 | |
| 50 | .B ezmlm-idx |
| 51 | calculates a subject hash based on the normalized subject header. Normalization |
| 52 | removes linear whitespace, case information, and message reply indicators. |
| 53 | The subject hash is used by |
| 54 | .B ezmlm-get(1) |
| 55 | for message threading. |
| 56 | .SH OPTIONS |
| 57 | .TP |
| 58 | .B \-d |
| 59 | Use the ``Date:'' header for date information, rather than the top ``Received:'' |
| 60 | header. This is unreliable, but useful when messages have been transferred from |
| 61 | another type of archive by mailing them to ezmlm. |
| 62 | .B ezmlm-idx |
| 63 | converts dates with two-digit years ``xx'' to 19xx if xx is >= 70. Otherwise, |
| 64 | 20xx is assumed. |
| 65 | .TP |
| 66 | .B \-D |
| 67 | (Default.) |
| 68 | Use the ``Received:'' header, not the ``Date:'' header. This is more reliable |
| 69 | since this is the header added by the receiving qmail. Also, this results |
| 70 | in always correctly formatted dates in the same time zone (usually UTC). |
| 71 | .TP |
| 72 | .B \-f\fI msg |
| 73 | Start indexing with the archive section containing message |
| 74 | .IR msg . |
| 75 | This is useful if you have removed part of the archive and do not want to |
| 76 | create (empty) directories and index files for these. It also decreases |
| 77 | .B ezmlm-idx |
| 78 | memory use. |
| 79 | .TP |
| 80 | .B \-F |
| 81 | (Default.) |
| 82 | Start indexing from message 1. |
| 83 | .TP |
| 84 | .B \-v |
| 85 | Display |
| 86 | .B ezmlm-idx |
| 87 | version info. |
| 88 | .TP |
| 89 | .B \-V |
| 90 | Display |
| 91 | .B ezmlm-idx |
| 92 | version info. |
| 93 | .SH "SEE ALSO" |
| 94 | ezmlm-archive(1), |
| 95 | ezmlm-get(1), |
| 96 | ezmlm-send(1), |
| 97 | ezmlm(5) |