aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
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.
2014-10-28gitignore: ignore sh.config and doc/config.doxJani Nikula
2014-10-18cli/insert: require succesful message indexing for success statusJani Nikula
Add --keep option to keep any remaining stuff in index or file. We could distinguish between failures to index and failures to apply tags or maildir sync, but for simplicity just have one.
2014-10-04doc: build notmuch-emacs info/html docs, link from indexDavid Bremner
Although this manual is far from complete, it may be helpful for someone. In particular building it as part of the standard build process makes it easier to find problems when editing the notmuch-emacs-manual.
2014-10-04doc: Emacs manual improvements and expansionsAustin Clements
Fix several typos, improve general wording and flow, and add some information on notmuch-jump.
2014-09-02doc: 'rm -f' potential doxygen temporary output fileTomi Ollila
Some (older) Doxygen versions do not create such a temporary file.
2014-07-13docs: remove spurious man page generated from doxygenDavid Bremner
There is a doxygen bug about these odd files, https://bugzilla.gnome.org/show_bug.cgi?id=727796 But it isn't clear if / when a fix will be provided, so just delete it to avoid e.g. confusing man-to-wiki.pl
2014-07-09doc: postprocess notmuch.3David Bremner
Remove excess italics from doxygen output. It seems to make no sense (and is certainly ugly) to italicize the first argument to the .RI macro.
2014-07-09doc: quiet doxygen warningsDavid Bremner
remove some obsolete tags for XML output (which we don't currently generate in any case)
2014-07-09doc: build and install doxygen api docsDavid Bremner
In order to support out of tree builds and avoid hardcoding version number, generate `doc/config.dox` from configure.
2014-05-28Merge branch 'release'David Bremner
A point release is slowly being built on branch release. Merge those changes into master.
2014-05-28doc/conf.py: Remove _static from html_static_pathW. Trevor King
Avoid: $ make HAVE_SPHINX=1 sphinx-html python ./doc/mkdocdeps.py ./doc doc/_build doc/docdeps.mk sphinx-build -b html -d doc/_build/doctrees -q ./doc doc/_build/html Making output directory... WARNING: html_static_path entry '/home/wking/src/notmuch/notmuch/doc/_static' does not exist because we have no static source in doc/_static.
2014-05-04Merge tag '0.18_rc1'David Bremner
notmuch 0.18~rc1 release
2014-05-04doc/doxygen.cfg: bump version to 0.18David Bremner
2014-05-03doc: add *.pyc to doc/.gitignoreJani Nikula
2014-04-22doc: remove conf.pyc on cleandebian/0.18_rc0-10.18_rc0David Bremner
This build artifict messes up the packaging process for (at least) Debian if not removed on clean.
2014-04-21doc: Simplify and clarify notmuch show --format=sexp descriptionAustin Clements
Previously, this was a verbatim copy of the --format=json text. Change it to instead reference the JSON text and actually describe how the S-expression format works.
2014-04-21doc: Clarify charset encoding of JSON outputAustin Clements
2014-04-21doc: Fix minor formatting issues in notmuch-show.rstAustin Clements
There were some extra line breaks and missing periods.
2014-04-21doc: Clarify notmuch show --format=raw descriptionAustin Clements
In addition to being generally more precise, this is explicit that there is no charset conversion.
2014-04-21doc/prerst2man.py: Fix 'os.system' -> 'system' typoW. Trevor King
Avoid: $ make HAVE_SPHINX=0 HAVE_RST2MAN=1 build-man python ./doc/prerst2man.py ./doc doc/_build/man Traceback (most recent call last): File "./doc/prerst2man.py", line 65, in <module> os.system('set -x; rst2man {0} {1}/{2}.{3}' NameError: name 'os' is not defined make: *** [doc/_build/man/man1/notmuch.1] Error 1 by using system directly. We don't need the 'os.' namespacing, because the function was imported with: from os import makedirs, system
2014-04-21doc/prerst2man.py: Use Python-3-compatible octal notationW. Trevor King
Python 3 only supports the 0oXXX notation for octal literals [1,2], which have also been supported in 2.x since 2.6 [2]. [1]: https://docs.python.org/3.0/whatsnew/3.0.html#integers [2]: http://legacy.python.org/dev/peps/pep-3127/
2014-04-21doc/mkdocdeps.py: Use "with" statement for the output fileW. Trevor King
Before this patch, the open was unnecessarily early and relied on the process cleanup to close. Neither one of these was a real problem, but PEP 343's context managers (which landed in Python 2.5) make proper cleanup very easy. [1]: http://legacy.python.org/dev/peps/pep-0343/
2014-04-21doc/mkdocdeps.py: Convert execfile to importW. Trevor King
excefile is gone in Python 3 [1]. Instead of exec-ing the configuration, it's easier to insert the source directory in Python's path [2], and just import the configuration. With this change, mkdocdeps.py is compatible with both Python 2 and 3. [1]: https://docs.python.org/3.0/whatsnew/3.0.html#builtins [2]: https://docs.python.org/3/library/sys.html#sys.path
2014-04-19doc: make notmuch-new summary line more genericDavid Bremner
Since 'notmuch new' now takes multiple options, it's confusing to show only one of them in the summary.
2014-04-19doc: Fix parallel build of roff filesAustin Clements
The roff build rule builds all of the roff files in a single command. Previously, this was expressed as a multi-target rule, but since this is equivalent to specifying a copy of the rule for each target, make -jN could start up to N parallel instances of this command. Fix this by bottlenecking this rule through a single stamp file. This also removes the unused man.stamp from CLEAN.
2014-04-12restore: transparently support gzipped inputDavid Bremner
We rely completely on zlib to do the right thing in detecting gzipped input. Since our dump format is chosen to be 7 bit ascii, this should be fine.
2014-04-12dump: support gzipped and atomic outputDavid Bremner
The main goal is to support gzipped output for future internal calls (e.g. from notmuch-new) to notmuch_database_dump. The additional dependency is not very heavy since xapian already pulls in zlib. We want the dump to be "atomic", in the sense that after running the dump file is either present and complete, or not present. This avoids certain classes of mishaps involving overwriting a good backup with a bad or partial one.
2014-04-08doc: added 'Init File' section to notmuch-emacs info sourceTomi Ollila
While adding that fixed (also other) typos noticed by aspell(1) run, and capitalized Emacs and (most) Notmuch terms to match how emacs Info documentation seems to look in general.
2014-04-08doc: move doxgen config from devel/ to doc/David Bremner
a first step towards actually instally the API docs