Commit graph

8 commits

Author SHA1 Message Date
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
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