debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-25 20:38:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

python: remove the "notmuch binary" section from the docs

Browse source 
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
This commit is contained in:
Justus Winter 2012-05-17 17:47:49 +02:00
parent 8dc8495010
commit 643719dfce
2 changed files with 0 additions and 69 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
bindings/python/docs/source/index.rst
View file

@ -28,7 +28,6 @@ functionality, returning :class:`Threads`, :class:`Messages` and
threads threads
thread thread
filesystem filesystem
notmuch
Indices and tables Indices and tables
================== ==================

68
bindings/python/docs/source/notmuch.rst
View file

@ -1,68 +0,0 @@
The notmuch 'binary'
====================
The cnotmuch module provides *notmuch*, a python reimplementation of the standard notmuch binary for two purposes: first, to allow running the standard notmuch testsuite over the cnotmuch bindings (for correctness and performance testing) and second, to give some examples as to how to use cnotmuch. 'Notmuch' provides a command line interface to your mail database.
A standard install via `easy_install cnotmuch` will not install the notmuch binary, however it is available in the `cnotmuch source code repository <http://bitbucket.org/spaetz/cnotmuch/src/>`_.
It is invoked with the following pattern: `notmuch <command> [args...]`.
Where <command> and [args...] are as follows:
**setup** Interactively setup notmuch for first use.
This has not yet been implemented, and will probably not be
implemented unless someone puts in the effort.
**new** [--verbose]
Find and import new messages to the notmuch database.
This has not been implemented yet. We cheat by calling
the regular "notmuch" binary (which must be in your path
somewhere).
**search** [options...] <search-terms> [...] Search for messages matching the given search terms.
This has been implemented but for the `--format` and
`--sort` options.
**show** <search-terms> [...]
Show all messages matching the search terms.
This has been partially implemented, we show a stub for each
found message, but do not output the full message body yet.
**count** <search-terms> [...]
Count messages matching the search terms.
This has been fully implemented.
**reply** [options...] <search-terms> [...]
Construct a reply template for a set of messages.
This has not been implemented yet.
**tag** +<tag>|-<tag> [...] [--] <search-terms> [...]
Add/remove tags for all messages matching the search terms.
This has been fully implemented.
**dump** [<filename>]
Create a plain-text dump of the tags for each message.
This has been fully implemented.
**restore** <filename>
Restore the tags from the given dump file (see 'dump').
This has been fully implemented.
**search-tags** [<search-terms> [...] ]
List all tags found in the database or matching messages.
This has been fully implemented.
**help** [<command>]
This message, or more detailed help for the named command.
The 'help' page has been implemented, help for single
commands are missing though. Patches are welcome.