From 643719dfce3bc1c9fa3a0d861076069d08d7bbbc Mon Sep 17 00:00:00 2001 From: Justus Winter <4winter@informatik.uni-hamburg.de> Date: Thu, 17 May 2012 17:47:49 +0200 Subject: [PATCH] python: remove the "notmuch binary" section from the docs Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de> --- bindings/python/docs/source/index.rst | 1 - bindings/python/docs/source/notmuch.rst | 68 ------------------------- 2 files changed, 69 deletions(-) delete mode 100644 bindings/python/docs/source/notmuch.rst diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst index 9ad5fa97..1cece5f7 100644 --- a/bindings/python/docs/source/index.rst +++ b/bindings/python/docs/source/index.rst @@ -28,7 +28,6 @@ functionality, returning :class:`Threads`, :class:`Messages` and threads thread filesystem - notmuch Indices and tables ================== diff --git a/bindings/python/docs/source/notmuch.rst b/bindings/python/docs/source/notmuch.rst deleted file mode 100644 index bf68f337..00000000 --- a/bindings/python/docs/source/notmuch.rst +++ /dev/null @@ -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 `_. - - -It is invoked with the following pattern: `notmuch [args...]`. - -Where 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 for messages matching the given search terms. - - This has been implemented but for the `--format` and - `--sort` options. - - **show** [...] - 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** [...] - Count messages matching the search terms. - - This has been fully implemented. - - **reply** [options...] [...] - Construct a reply template for a set of messages. - - This has not been implemented yet. - - **tag** +|- [...] [--] [...] - Add/remove tags for all messages matching the search terms. - - This has been fully implemented. - - **dump** [] - Create a plain-text dump of the tags for each message. - - This has been fully implemented. - **restore** - Restore the tags from the given dump file (see 'dump'). - - This has been fully implemented. - - **search-tags** [ [...] ] - List all tags found in the database or matching messages. - - This has been fully implemented. - - **help** [] - 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. -- 2.26.2