Merge branch 'documentation'
This commit is contained in:
commit
8ad7b77cf3
GPG Key ID:
A32CE9C59D8003B5
37
TODO.md
37
TODO.md
|
|
@ -1,23 +1,34 @@
|
|||
# The TODO list for mboxgrep
|
||||
|
||||
## Behavior
|
||||
|
||||
- [x] use cryptographic hashes for detecting duplicate messages
|
||||
- [ ] add checking for conflicting command-line options
|
||||
- [ ] support for deletion of messages after being matched and displayed
|
||||
- [x] ignore .overview when grepping Gnus folders
|
||||
- [x] inverted matching
|
||||
- [x] recursive search through directories
|
||||
- [ ] literal date matching
|
||||
- [x] write Texinfo documentation
|
||||
- [x] writing selected messages to a new folder
|
||||
- [x] deleting selected messages
|
||||
- [ ] support for config files
|
||||
- [x] support for reading messages from stdin
|
||||
- [x] support for compressed mbox folders
|
||||
- [ ] make use of lockfile library
|
||||
- [ ] make use of Solaris' maillock library
|
||||
- [x] provide possibility to use flock() instead of fcntl()
|
||||
- [x] allow run-time selection of file locking method
|
||||
- [ ] provide national language support with gettext()
|
||||
- [ ] literal date matching
|
||||
- [x] reading messages from standard input
|
||||
- [x] run-time selection of file locking method
|
||||
|
||||
## File formats, encodings and standards
|
||||
|
||||
- [ ] MIME support
|
||||
- [x] enable removing duplicate messages w/ MD5 checksums
|
||||
- [ ] add checking for conflicting command-line options
|
||||
- [ ] support for GnuPG
|
||||
- [x] support for compressed mbox folders
|
||||
- [x] support for bzip2 compression
|
||||
- [ ] support for XZ-format compression
|
||||
- [ ] support for mail folder conversion
|
||||
- [ ] support for deletion of messages after being matched and displayed
|
||||
- [ ] use a more modern hash function than MD5
|
||||
|
||||
## Miscellaneous
|
||||
|
||||
- [x] write Texinfo documentation
|
||||
- [ ] configuration files
|
||||
- [ ] make use of lockfile library
|
||||
- [ ] make use of Solaris' maillock library
|
||||
- [x] provide possibility to use flock() instead of fcntl()
|
||||
- [ ] provide national language support with gettext()
|
||||
|
|
|
|||
|
|
@ -84,14 +84,14 @@ caution.
|
|||
Ignore duplicate messages.
|
||||
.IP "-m, --mailbox-format=TYPE"
|
||||
Select input and output mailbox TYPE. TYPE can be either `mbox' (default),
|
||||
`zmbox' (meaning `gzip compressed mbox'), `bz2mbox' (meaning `bzip2
|
||||
compressed mbox'), `mh', `nnml', `nnmh' or `maildir'.
|
||||
`zmbox' (gzip compressed mbox), `bz2mbox' (bzip2 compressed mbox), `mh', `nnml',
|
||||
`nnmh' or `maildir'.
|
||||
.SH EXAMPLES
|
||||
.TP
|
||||
\(bu
|
||||
Search $MAIL for messages from Dirty Harry:
|
||||
.PP
|
||||
mboxgrep '^From:.*callahan@homicide\\.SFPD\\.gov' $MAIL
|
||||
mboxgrep '^From:.*callahan@sanfranciscopolice\\.org' $MAIL
|
||||
.TP
|
||||
\(bu
|
||||
Display all messages contained in folder ~/Mail/incoming, except those
|
||||
|
|
@ -100,9 +100,6 @@ that appear to originate from AOL:
|
|||
mboxgrep -v 'Received:.*aol\\.com' ~/Mail/incoming
|
||||
.SH BUGS
|
||||
Report them to address below.
|
||||
.SH NOTICE
|
||||
Mboxgrep was alomost completely rewritten since version 0.5.3. Additionally,
|
||||
there was no stable 0.6.x branch between 0.5.3 and 0.7.0.
|
||||
.SH SEE ALSO
|
||||
grep(1),
|
||||
regex(7),
|
||||
|
|
|
|||
|
|
@ -197,7 +197,7 @@ File: mboxgrep.info, Node: Examples, Next: Bugs, Prev: Invoking, Up: Top
|
|||
|
||||
Scan '$MAIL' for messages from Dirty Harry:
|
||||
|
||||
mboxgrep -H '^From:.*callahan@homicide\.SFPD\.gov' $MAIL
|
||||
mboxgrep -H '^From:.*callahan@sanfranciscopolice\.org' $MAIL
|
||||
|
||||
Re-mail to George messages that mention his name:
|
||||
|
||||
|
|
@ -224,11 +224,11 @@ File: mboxgrep.info, Node: Bugs, Next: To Vicky, Prev: Examples, Up: Top
|
|||
******************
|
||||
|
||||
Shortly, if 'mboxgrep' crashes and/or works differently than described
|
||||
in this manual, you've found a bug.
|
||||
in this manual, you have found a bug.
|
||||
|
||||
Please report bugs to <dspiljar@datatipp.se>. Instructions how to
|
||||
reproduce the bug or output from a debugger would be highly appreciated.
|
||||
Don't, however, send any coredumps.
|
||||
Please do not, however, send any core dumps.
|
||||
|
||||
|
||||
File: mboxgrep.info, Node: To Vicky, Prev: Bugs, Up: Top
|
||||
|
|
@ -256,8 +256,8 @@ Node: Output control3301
|
|||
Node: Search scope selection4292
|
||||
Node: Mailbox type selection4533
|
||||
Node: Examples4854
|
||||
Node: Bugs5674
|
||||
Node: To Vicky6081
|
||||
Node: Bugs5678
|
||||
Node: To Vicky6096
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
\input texinfo @c -*-texinfo-*-
|
||||
@c $Id: mboxgrep.texi,v 1.20 2006-01-18 00:09:58 dspiljar Exp $
|
||||
\input texinfo
|
||||
@setfilename mboxgrep.info
|
||||
@settitle Grep through mailboxes
|
||||
@finalout
|
||||
|
|
@ -224,7 +223,7 @@ mbox) @code{mh}, @code{nnml}, @code{nnmh}, and @code{maildir}.
|
|||
Scan @env{$MAIL} for messages from Dirty Harry:
|
||||
|
||||
@example
|
||||
mboxgrep -H '^From:.*callahan@@homicide\.SFPD\.gov' $MAIL
|
||||
mboxgrep -H '^From:.*callahan@@sanfranciscopolice\.org' $MAIL
|
||||
@end example
|
||||
|
||||
Re-mail to George messages that mention his name:
|
||||
|
|
@ -258,11 +257,11 @@ mboxgrep -nd -c . spam
|
|||
@cindex bug, insect, vermin, bugreport
|
||||
|
||||
Shortly, if @code{mboxgrep} crashes and/or works differently than described
|
||||
in this manual, you've found a bug.
|
||||
in this manual, you have found a bug.
|
||||
|
||||
Please report bugs to @email{dspiljar@@datatipp.se}.
|
||||
Instructions how to reproduce the bug or output from a debugger would be
|
||||
highly appreciated. Don't, however, send any coredumps.
|
||||
highly appreciated. Please do not, however, send any core dumps.
|
||||
|
||||
@node To Vicky, , Bugs, Top
|
||||
@chapter Author's Dedication
|
||||
|
|
|
|||
Loading…
Reference in New Issue