Commit graph

20 commits

Author SHA1 Message Date
Jani Nikula
d379e3a0e2 man: update SEE ALSO references in man pages
Drop references to notmuch-part(1). Reference all man pages. Fix man
page section of notmuch-dump(1).
2012-03-13 21:34:44 -03:00
Mark Walters
dfee0f97b9 man: remove search.exclude_tags from notmuch-config.1 for 0.12 2012-03-03 08:33:26 -04:00
David Bremner
916aefc2de bump version to 0.12~rc1
As usual, only `version' is edited by hand. The rest of the changes I
blame on the machine.
2012-03-01 07:47:21 -04:00
Pieter Praet
13235d3535 doc: minor corrections in notmuch-config.1
* man/man1/notmuch-config.1

  - SYNOPSIS:
    Remove spaces in 'section.item' arg, and indicate that
    `notmuch config set' accepts multiple value args.

  - DESCRIPTION:
    Correct config option to exclude tags from search results.
    ('search.exclude_tags' instead of 'search.exclude')

Also see commit bb8ab4c8.
2012-02-29 07:27:44 -04:00
Jani Nikula
bf28c60b9f man: add references to maildir flag synchronization
notmuch new, restore, and tag commands support maildir flag
synchronization with notmuch tags. Reference the notmuch-config(1) man
page about it in the relevant man pages.
2012-02-27 22:40:29 -04:00
Jani Nikula
bb8ab4c830 man: document the notmuch configuration settings in notmuch-config(1)
At the risk of duplication between the man page and the configuration
file generated by default, document the notmuch configuration options
in the notmuch config man page.

Existing users of notmuch should not be expected to re-generate their
config file in order to get access to the documentation for new
configuration options.

Include some minor fixes and cleanups while at it.
2012-02-27 22:38:18 -04:00
Jani Nikula
8ea82928b9 fix .gitignore for gzipped man pages 2012-01-17 14:52:31 -04:00
Jani Nikula
0f8148e920 cli: add support for replying just to the sender in "notmuch reply"
Add new option --reply-to=(all|sender) to "notmuch reply" to select whether
to reply to all (sender and all recipients), or just sender. Reply to all
remains the default.

Credits to Mark Walters <markwalters1009@gmail.com> for his similar earlier
work where I picked up the basic idea of handling reply-to-sender in
add_recipients_from_message(). All bugs are mine, though.

Signed-off-by: Jani Nikula <jani@nikula.org>
2012-01-14 11:10:28 -04:00
Jani Nikula
949fd801f8 man: add missing SEE ALSO header to notmuch reply man page
Signed-off-by: Jani Nikula <jani@nikula.org>
2012-01-10 06:33:01 -04:00
Jameson Graef Rollins
f3d800124f force install notmuch-setup.1 symlink
This will prevent the install from failing if the link already exists.
2011-12-31 15:16:32 -04:00
Jameson Graef Rollins
f079f5f931 break up dump and restore man pages.
These functions are enough different in their behavior that it's not
really worth it to combine them.  They overlap in the format of the
dump file, but we can have a separate page that describes the dump
format, and either reference it or include it.  This also keeps things
nice and clean with one page per command.
2011-12-31 15:16:32 -04:00
Jameson Graef Rollins
77b8d70600 remove reference to notmuch-part.1 from Makefile.local 2011-12-31 15:16:32 -04:00
David Bremner
af12e5a3ac build-system: update for split man pages
- We have to remove the installation of notmuch.1.gz from the top
level Makefile.local.

- Man pages with multiple names are handled by making relative
  symlinks in the install-man target.

- update version tests and convenience rules for split man pages

  The man page version test still only checks notmuch.1, but the
  location is updated.

  update-man-versions is longer than the one-line previously in
  update-versions mainly because I decided to take the high road and
  stick to POSIX sed (thus, no sed -i). The sed regex itself is more
  complicated to cope with variations in the headers.
2011-12-31 15:16:32 -04:00
David Bremner
7c5695b439 man/*: fixup page references
- Replace references to section X below with page refences.

- Add SEE ALSO to each page.  This is a bit error prone, because each
  SEE ALSO section is different, i.e. a page does not refer to itself.
2011-12-31 15:16:32 -04:00
David Bremner
5d13210a09 notmuch-config.1: fix typo 2011-12-31 15:16:32 -04:00
David Bremner
8026b4a9ff notmuch.1: smooth wording.
After most of the content was ripped out of the page, a few words were
needed to glue things back togetehr.
2011-12-31 15:16:32 -04:00
David Bremner
482033f8f8 man/*: formatting cleanup
Fix some problems with indentation (controlled by markup) and
whitespace.

- notmuch.1: reformat

  Use .SS macro to make "notmuch setup" a subsection. Introduce another
  subsection for the remaining commands.

- notmuch-config.1: reformat

   Put all the syntax in the synopsis. Supposedly this is the the UNIX way.

- notmuch-reply.1: fix formatting issues.

  Give nicer formatting for synopsis.

  Insert missing SEE ALSO header.

- notmuch-dump.1: reformat using subsections

  These seems more natural, although, as mentioned, it does require
  referring back to the synopsis. Or maybe copying parts of the
  synopsis
2011-12-31 15:16:32 -04:00
David Bremner
2d68f4ca9b man: add symlinks for notmuch-restore.1 and notmuch-setup.1
These are just for the convenience of testers using $src/man as an
element of MANPATH. They are intentionally omitted from MAN1, so that
they do not interfere with the install.
2011-12-31 15:16:31 -04:00
David Bremner
b6067aeaaa remove notmuch-part from documentation.
This should have been done when "notmuch part" was deprecated and
replaced by notmuch show --part, but it slipped through the cracks.
2011-12-31 15:16:31 -04:00
David Bremner
c48797b498 initial splitting of notmuch.1
We mostly just cut and paste the command descriptions into individual
files, with a short header added to each one.

The splitting into subdirectories is to support the use of ./man as an
element in MANPATH, e.g. for testing.
2011-12-31 15:16:31 -04:00