summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2016-04-24doc: change copyright dateDavid Bremner
Yes, it is 2016
2016-03-14doc/reply: Clarify how reply-to header is handledMichal Sojka
Current documentation and comments in the code do not correspond to the actual code and tests in the test suite ("Un-munging Reply-To" in T230-reply-to-sender.sh). Fix it.
2015-10-21man: clarify the parameters for lastmod: range queryJani Nikula
<since> and <until> for the lastmod: prefix right below the date: prefix description give the impression one could use last modified dates to lastmod: which is not at all the case. Use <initial-revision>..<final-revision> instead.
2015-10-17doc: update copyright year to contain range 2009-2015Tomi Ollila
Now it is accurate and provides more information to the reader of the documents.
2015-10-01notmuch-emacs-mua: make --auto-daemon imply --create-frameTomi Ollila
Before this change with --auto-daemon but without --create-frame emacs server was started but no clients stay connected to it (in both graphical and terminal displays). Note that this changes how --client --auto-daemon works on graphical display; New emacs frame is now created for the message (and message-exit-actions hook appended).
2015-09-29notmuch-emacs-mua: do not create a frame by default with --clientJani Nikula
Make the default behaviour for --client the same as emacsclient default: do not create a new frame. Add a new option --create-frame, passing the same option to emacsclient to create a frame.
2015-09-29notmuch-emacs-mua: add --auto-daemon option to start Emacs daemon as neededJani Nikula
Automatically starting Emacs in daemon mode if the Emacs server is not running is a matter of preference better not hard coded in notmuch-emacs-mua. Add an option to control the behaviour.
2015-09-29man: clean up notmuch-emacs-mua man pageJani Nikula
Move --client description to a more suitable location, stylistic changes.
2015-09-26cli: do not sort addresses on --output=count or --deduplicate=addressJani Nikula
The order of the results with --output=count and --deduplicate=address are unspecified as they're based on a hash table traversal. This being the case, optimize the query by explicitly requesting unsorted results. Clarify the documentation accordingly.
2015-09-26man: document notmuch address --deduplicate=address optionJani Nikula
Document the deduplication based on case insensitive address.
2015-09-25lib: add support for date:<expr>..! to mean date:<expr>..<expr>Jani Nikula
It doesn't seem likely we can support simple date:<expr> expanding to date:<expr>..<expr> any time soon. (This can be done with a future version of Xapian, or with a custom query query parser.) In the mean time, provide shorthand date:<expr>..! to mean the same. This is useful, as the expansion takes place before interpetation, and we can use, for example, date:yesterday..! to match from beginning of yesterday to end of yesterday. Idea from Mark Walters <markwalters1009@gmail.com>.
2015-09-24man: document notmuch address --deduplicate=(no|mailbox) optionJani Nikula
Document the deduplication of results.
2015-08-14lib: Add "lastmod:" queries for filtering by last modificationAustin Clements
The implementation is essentially the same as the date range search prior to Jani's fancy date parser.
2015-08-14cli: add global option "--uuid"David Bremner
The function notmuch_exit_if_unmatched_db_uuid is split from notmuch_process_shared_options because it needs an open notmuch database. There are two exceptional cases in uuid handling. 1) notmuch config and notmuch setup don't currently open the database, so it doesn't make sense to check the UUID. 2) notmuch compact opens the database inside the library, so we either need to open the database just to check uuid, or change the API.
2015-08-14cli/count: add --lastmodDavid Bremner
In the short term we need a way to get lastmod information e.g. for the test suite. In the long term we probably want to add lastmod information to at least the structured output for several other clients (e.g. show, search).
2015-08-04lib: define NOTMUCH_DEPRECATED macro, document its use.David Bremner
This has been tested with gcc and clang.
2015-07-30cli: enable notmuch --help commandDavid Bremner
This functionality seems to have been undocumented, if it ever existed. Document it now.
2015-07-30doc: whitespace cleanup for notmuch.rstDavid Bremner
replace leading spaces with tabs
2015-07-10replace hardcoded "python" with configured python commandDavid Bremner
Thanks to FreeBSD port maintainer Mikhail for report and the original the original patch. This is the right thing (TM) and also apparently fixes the build on FreeBSD.
2015-06-05doc: add minimal note about shared options.David Bremner
The example is a bit silly, but notmuch subcommand --help is actually not equivalent to "notmuch --help subcommand".
2015-03-11CLI: make gpg binary used by libgmime configurable.David Bremner
Previously we set up a way for the top level notmuch command to choose which gpg binary was invoked by libgmime. In this commit we add the (mostly boilerplate) code to allow the notmuch-config command to read and write this path, and use it in the appropriate struct. Update tests for new default variable
2015-03-08man: fix notmuch-emacs-mua environment sectionJani Nikula
It's emacsclient command, not comment. Document default values. While at it, format the environment section similarly to other man pages.
2015-03-08notmuch-emacs-mua: remove -C to keep short options compatible with muttJani Nikula
Notmuch uses long options exclusively all around. The short options in notmuch-emacs-mua are intentionally just a compatible subset of mutt(1). Keep it this way, if only to make documenting the fact easy! The Notmuch style --client long option remains, of course.
2015-03-06cli: add a tool for starting new message in the emacs uiJani Nikula
Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-24doc: update list of prefixesDavid Bremner
'attachement' missed a colon, and 'mimetype' was not added to this table at all.
2015-02-24doc: typo fix for prefix discussion.David Bremner
2015-02-24doc: add more information on operators.David Bremner
More material borrowed from the wiki page on "searching"
2015-02-24doc: add material on stemming and wildcardsDavid Bremner
This is lightly massaged from the searching page on the wiki.
2015-02-23doc: document notmuch-restore --input=filename optionJani Nikula
Document all options for completeness.
2015-02-23doc: document notmuch-dump --output=filename optionJani Nikula
Document all options for completeness.
2015-02-23doc: bring notmuch-dump manual page in line with the restJani Nikula
Fix indentation of options. Move search terms description before options. Fix synopsis.
2015-02-22doc: remove reference to sender,recipients from notmuch-search.1David Bremner
Apparently these were missed when notmuch-address was split to it's own subcommand.
2015-01-25doc: add details about Xapian search syntaxDavid Bremner
Questions related to the way that probabilistic prefixes and phrases are handled come up quite often and it is nicer to have the documentation self contained. Hopefully putting it in subsections prevents it from being overwhelming.
2015-01-25doc: gzipped notmuch.3 before trying to install notmuch.3.gzDavid Bremner
If HAVE_SPHINX=0 but HAVE_DOXYGEN=1, then the previous version was trying to install notmuch.3.gz but only got as far as creating notmuch.3
2015-01-24Update documentationTodd
Adds new entry to the NEWS file, and updates the search terms section of the man page. The search terms section needs to be updated again once the new section in the documentation covering probablistic terms has been committed.
2015-01-22doc: remove support for rst2manDavid Bremner
It was becoming increasingly complicated to support rst2man, and there were apparently not many people that relied on it.
2015-01-03build: eliminate use of python execfile commandDavid Bremner
As discussed in id:8cc9dd580ad672527e12f43706f9803b2c8e99d8.1405220724.git.wking@tremily.us, execfile is unavailable in python3. The approach of this commit avoids modifying the python module path, which is arguably preferable since it avoids potentially accidentally importing a module from the wrong place.
2015-01-01Add default configuration values to the man pageSergei Shilovsky
2014-11-16NEWS & doc: typing fixesTomi Ollila
Some inconsistent formatting in NEWS for 0.19, 0.18 & 0.17 fixed. Extra `*` when making bold text in doc/man1/notmuch-search.rst removed.
2014-11-13doc: Minor fixes related to notmuch-addressMichal Sojka
- Add notmuch-address to HTML index - Remove extra '*'
2014-11-09cli: notmuch address option defaults updateTomi Ollila
When no --output option were given, change default to display senders only. When only --count option is given, display senders (in contrary to not displaying anything). Document that --count with --sort=**order** is not supported option combination. Clean up some whitespace in the documentation. One test updated to have --output=count without sender nor recipient output option.
2014-11-09doc: whitespace cleanupTomi Ollila
Changed one tab in doc/man1/notmuch-show.rst to 8 spaces. Removed one leading tab in doc/man5/notmuch-hooks.rst to make the SYNOPSIS style consistent with other pages.
2014-11-05doc: add notmuch-address.rst to sphinx configDavid Bremner
This is needed so that the rst docs are converted to man and info pages.
2014-11-05cli: address: Add --output=countMichal Sojka
This output prints how many times was each address encountered during search.
2014-11-05cli: address: Do not output duplicate addressesMichal Sojka
This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05cli: search: Convert --output to keyword argumentMichal Sojka
Now, when address related outputs are in a separate command, it makes no sense to combine multiple --output options in search command line. Using switch statement to handle different outputs is more readable than a series of if statements.
2014-11-05cli: Introduce "notmuch address" commandMichal Sojka
This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-02cli: add support for notmuch search --duplicate=N with --output=messagesJani Nikula
Print the message IDs of all messages matching the search terms that have at least N files associated with them.
2014-11-01cli: search: Add --output={sender,recipients}Michal Sojka
The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-28cli/insert: add post-insert hookJani Nikula
The post-new hook might no longer be needed or run very often if notmuch insert is being used. Therefore a post-insert hook is needed (arguably pre-insert not so much, so don't add one). Also add the --no-hooks option to skip hooks.