summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2017-01-08docs: add 2017 to copyright yearsDavid Bremner
2016-12-15cli/insert: document the use of EX_TEMPFAILDavid Bremner
2016-11-25cli/new: document new exit codeDavid Bremner
It seems important to give the numeric return code for people writing scripts. Hopefully deviations from this convention are rare.
2016-09-21add property: query prefix to search for specific propertiesDaniel Kahn Gillmor
We want to be able to query the properties directly, like: notmuch count property:foo=bar which should return a count of messages where the property with key "foo" has value equal to "bar".
2016-09-21cli: optionally restore message properties from dump fileDavid Bremner
This somewhat mimics the config line parsing, except there can be arbitrarily many key value pairs, so one more level of looping is required.
2016-09-21CLI: add properties to dump outputDavid Bremner
Part of providing extensibility via properties is to make sure that user data is not lost. Thus we need to be able to dump and restore properties.
2016-09-12clean up spellingDaniel Kahn Gillmor
2016-08-23doc: update cross references for notmuch.1David Bremner
In particular add notmuch-compact(1) (Debian bug #825884)
2016-06-11doc/notmuch-emacs.rst: update notmuch-hello buffer help textTomi Ollila
To look the same as commit b8a136187a3b changed it in emacs MUA code.
2016-06-07doc: clean up boolean vs. probabilistic prefixesDaniel Kahn Gillmor
sphinx-build emits a minor warning: [...]doc/man7/notmuch-search-terms.rst:223: WARNING: Block quote ends without a blank line; unexpected unindent. And the tabular representation of boolean or probabilistic prefixes currently renders like this when i view it in man: ┌───────────────────────────┬────────────────────────────┐ │Boolean │ Probabilistic │ └───────────────────────────┴────────────────────────────┘ │ tag: id: │ from: to: │ │ │ │ │ thread: folder: │ subject: attach‐ │ │ path: │ ment: mimetype: │ └───────────────────────────┴────────────────────────────┘ This isn't just ugly: it's confusing, because it seems to imply that some of the prefixes in the left-hand column are somehow related to specific other prefixes in the right-hand column. The Definition List representation introduced by this patch should be simpler for readers to understand, and doesn't have the warning.
2016-06-07doc: document notmuch-dump header lineDavid Bremner
This was introduced with the libconfig changes, but not documented then.
2016-06-05Use https instead of http where possibleDaniel Kahn Gillmor
Many of the external links found in the notmuch source can be resolved using https instead of http. This changeset addresses as many as i could find, without touching the e-mail corpus or expected outputs found in tests.
2016-06-05doc: include notmuch-emacs-mua in documentation ToCDaniel Kahn Gillmor
Without this patch, i'm seeing sphinx-build emit: [...]doc/man1/notmuch-emacs-mua.rst:: WARNING: document isn't included in any toctree
2016-05-25lib: add support for named queriesDavid Bremner
This relies on the optional presense of xapian field processors, and the library config API.
2016-05-25CLI: add notmuch-config support for named queriesDavid Bremner
Most of the infrastructure here is general, only the validation/dispatch is hardcoded to a particular prefix. A notable change in behaviour is that notmuch-config now opens the database e.g. on every call to list, which fails with an error message if the database doesn't exit yet.
2016-05-25CLI: optionally restore config data.David Bremner
The default to restore config data seems safest, especially since currently we have no config data to mess up.
2016-05-25CLI: add optional config data to dump output.David Bremner
Note that it changes the default dump output format, but doesn't break existing notmuch-restore. It might break user scripts though.
2016-05-13lib/cli: add library API / CLI for compile time optionsDavid Bremner
This is intentionally low tech; if we have more than two options it may make sense to build up what infrastructure is provided.
2016-05-08lib: optionally support single argument date: queriesDavid Bremner
This relies on the FieldProcessor API, which is only present in xapian >= 1.3.
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.