summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2017-07-18Fix orthographyDaniel Kahn Gillmor
2017-07-14config: deprecate/drop crypto.gpg_path under gmime 2.6/3.0Daniel Kahn Gillmor
gmime 3.0 no longer offers a means to set the path for gpg. Users can set $PATH anyway if they want to pick a differently-installed gpg (e.g. /usr/local/bin/gpg), so this isn't much of a reduction in functionality. The one main difference is for people who have tried to use "gpg2" to make use of gpg 2.1, but that isn't usefully co-installable anyway.
2017-07-12cli: add space separator for keyword, string, and int argumentsDavid Bremner
Defer the complication of optional boolean arguments for later (never?).
2017-04-01cli/dump: bump dump format version to 3David Bremner
No changes to the format of the body, but the header format was fixed, and version 2 headers probably shouldn't be relied on.
2017-03-07man: document external subcommand handling in notmuch(1)Jani Nikula
The documentation for this was overlooked when adding the subcommand handling. This seems like the proper place for it.
2017-03-03lib: regexp matching in 'subject' and 'from'David Bremner
the idea is that you can run % notmuch search subject:/<your-favourite-regexp>/ % notmuch search from:/<your-favourite-regexp>/ or % notmuch search subject:"your usual phrase search" % notmuch search from:"usual phrase search" This feature is only available with recent Xapian, specifically support for field processors is needed. It should work with bindings, since it extends the query parser. This is easy to extend for other value slots, but currently the only value slots are date, message_id, from, subject, and last_mod. Date is already searchable; message_id is left for a followup commit. This was originally written by Austin Clements, and ported to Xapian field processors (from Austin's custom query parser) by yours truly.
2017-01-08Merge branch 'release'David Bremner
These are the (tentative) changes for 0.23.5
2017-01-08docs: add 2017 to copyright yearsDavid Bremner
2016-12-15Merge branch 'release'David Bremner
Add back in no-display parameter by hand.
2016-12-15cli/insert: document the use of EX_TEMPFAILDavid Bremner
2016-11-28doc: whitespace cleanupTomi Ollila
In most part, our .rst documents are indented with 8 spaces instead of tabs. Bring the rest of the lines to the same format. Also, on one (supposedly empty) line, trailing spaces were removed.
2016-11-26Merge branch 'release'David Bremner
Add Jani's fix for notmuch-new
2016-11-26notmuch-emacs-mua: add --hello parameterJani Nikula
If the --hello parameter is given, display the notmuch hello buffer instead of the message composition buffer if no message composition parameters are given. Signed-off-by: Jani Nikula <jani@nikula.org>
2016-11-26man: advertize notmuch-emacs-mua as notmuch emacs-mua subcommandJani Nikula
With subcommand handling for external commands we can now hide the implementation detail of emacs-mua being a separate notmuch-emacs-mua script.
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-11-17build: only install known man pagesJani Nikula
Install man pages based on $(MAN_GZIP_FILES), which directly corresponds to the man page source rst files. This way we can filter the man pages to be installed as needed.
2016-11-17build: generate man page list from source files, not conf.pyJani Nikula
Use $(wildcard ...) to generate the list of man pages based on the rst source files present in the man page directories, instead of reading conf.py. This has three main benefits: 1) This makes the man page build slightly less complicated and easier to understand. At least there are fewer moving parts. 2) This makes the build fail if we add a man page rst file, but fail to add it to conf.py. 3) We can use Sphinx constructs in conf.py that are not available when importing the file into a normal python program such as mkdocdeps.py.
2016-11-17build: do not touch roff files after sphinx-buildJani Nikula
If Sphinx fails to create any of the roff files, having touch create them hides the errors until someone realizes, possibly much later, that the resulting files are empty. (Note that gzip doesn't fail on empty input files.) Sphinx will change the timestamps of any files it has written anyway.
2016-11-17doc: fix references in notmuch-emacs.rstJani Nikula
Fix make sphinx-texinfo warnings: WARNING: undefined label: notmuch-jump (if the link has no caption the label must precede a section header) WARNING: undefined label: notmuch-saved-searches (if the link has no caption the label must precede a section header)
2016-11-17doc/conf.py: include command name in texinfo document titleJani Nikula
Seems to make more sense than to have the same title for everything.
2016-11-17doc/conf.py: reindent, whitespace clean man page, texinfo listsJani Nikula
No functional changes.
2016-11-17doc/conf.py: abstract notmuch authorsJani Nikula
Don't repeat the same stuff so much. We probably don't want to track individual authors for man/texinfo pages anyway. No user visible changes.
2016-11-17doc/conf.py: generate texinfo_documents list from man_pages listJani Nikula
No need to repeat mostly the same information twice in conf.py. We probably want to have a corresponding texinfo document for all the man pages. Python list comprehension to the rescue. (The reverse is not true; we have a texinfo document for notmuch-emacs we don't want as a man page.) There should be no user visible changes.
2016-11-17doc/conf.py: add notmuch-emacs-mua to texinfo documentsJani Nikula
This was overlooked when adding the man page.
2016-11-02notmuch-emacs-mua: add support for mailto: URL handlingJani Nikula
Add support for composing an email in the Notmuch Emacs UI using a mailto: URL. The mailto: URL mode is mutually exclusive with specifying other message modifying parameters and positional arguments.
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.