From 7c5695b439d89d69d5f6d6a88cdcf964d7a98fbe Mon Sep 17 00:00:00 2001 From: David Bremner Date: Mon, 19 Dec 2011 21:41:48 -0400 Subject: [PATCH] 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. --- man/man1/notmuch-config.1 | 9 +++++++++ man/man1/notmuch-count.1 | 11 +++++++++++ man/man1/notmuch-dump.1 | 13 ++++++++++--- man/man1/notmuch-new.1 | 12 +++++++++--- man/man1/notmuch-reply.1 | 10 +++++++--- man/man1/notmuch-search.1 | 15 ++++++++++----- man/man1/notmuch-show.1 | 15 ++++++++++----- man/man1/notmuch-tag.1 | 14 ++++++++++---- man/man1/notmuch.1 | 13 ++++++++++--- man/man5/notmuch-hooks.5 | 8 ++++++++ man/man7/notmuch-search-terms.7 | 8 ++++++++ 11 files changed, 102 insertions(+), 26 deletions(-) diff --git a/man/man1/notmuch-config.1 b/man/man1/notmuch-config.1 index 536c4a4f..cb3234ff 100644 --- a/man/man1/notmuch-config.1 +++ b/man/man1/notmuch-config.1 @@ -43,3 +43,12 @@ command-line argument. If no values are provided, the specified configuration item will be removed from the configuration file. .RE + +.SH SEE ALSO + +\fBnotmuch\fR(1), \fBnotmuch-count\fR(1), +\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), +\fBnotmuch-part\fR(1), \fBnotmuch-reply\fR(1), +\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1), +\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1), +\fBnotmuch-tag\fR(1) diff --git a/man/man1/notmuch-count.1 b/man/man1/notmuch-count.1 index c0478393..25fe3292 100644 --- a/man/man1/notmuch-count.1 +++ b/man/man1/notmuch-count.1 @@ -15,6 +15,9 @@ The number of matching messages (or threads) is output to stdout. With no search terms, a count of all messages (or threads) in the database will be displayed. +See \fBnotmuch-search-terms\fR(7) +for details of the supported syntax for . + Supported options for .B count include @@ -37,3 +40,11 @@ Output the number of matching threads. .RE .RE .RE + +.SH SEE ALSO + +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-dump\fR(1), +\fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-part\fR(1), +\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), +\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7), +\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1) diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1 index 71925b05..5f5395f6 100644 --- a/man/man1/notmuch-dump.1 +++ b/man/man1/notmuch-dump.1 @@ -49,7 +49,14 @@ applied, instead of replacing each message's tags as they are read in from the dump file. .RE -See the -.B "SEARCH SYNTAX" -section below for details of the supported syntax for . +See \fBnotmuch-search-terms\fR(7) +for details of the supported syntax for . + .RE +.SH SEE ALSO + +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +\fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-part\fR(1), +\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), +\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7), +\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1) diff --git a/man/man1/notmuch-new.1 b/man/man1/notmuch-new.1 index 9c11375e..77d47764 100644 --- a/man/man1/notmuch-new.1 +++ b/man/man1/notmuch-new.1 @@ -43,9 +43,8 @@ has not previously been run. The .B new -command supports hooks. See the -.B "HOOKS" -section below for more details on hooks. +command supports hooks. See \fBnotmuch-hooks(5)\fR +for more details on hooks. Supported options for .B new @@ -57,3 +56,10 @@ include Prevents hooks from being run. .RE .RE +.SH SEE ALSO + +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-part\fR(1), +\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), +\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7), +\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1) diff --git a/man/man1/notmuch-reply.1 b/man/man1/notmuch-reply.1 index 978d318e..099d808d 100644 --- a/man/man1/notmuch-reply.1 +++ b/man/man1/notmuch-reply.1 @@ -46,9 +46,8 @@ Only produces In\-Reply\-To, References, To, Cc, and Bcc headers. .RE .RE -See the -.B "SEARCH SYNTAX" -section below for details of the supported syntax for . +See \fBnotmuch-search-terms\fR(7) +for details of the supported syntax for . Note: It is most common to use .B "notmuch reply" @@ -59,3 +58,8 @@ thread, replying to the entire thread allows for the reply to comment on issue found in multiple patches. .RE .RE +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), +\fBnotmuch-part\fR(1), \fBnotmuch-restore\fR(1), +\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7), +\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1) diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1 index efb63a1c..0bc3f40d 100644 --- a/man/man1/notmuch-search.1 +++ b/man/man1/notmuch-search.1 @@ -17,6 +17,9 @@ message in the thread, the number of matched messages and total messages in the thread, the names of all participants in the thread, and the subject of the newest (or oldest) message. +See \fBnotmuch-search-terms\fR(7) +for details of the supported syntax for . + Supported options for .B search include @@ -109,8 +112,10 @@ result from the end. Limit the number of displayed results to N. .RE -.RS 4 -See the -.B "SEARCH SYNTAX" -section below for details of the supported syntax for . -.RE +.SH SEE ALSO + +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-part\fR(1), +\fBnotmuch-reply\fR(1), \fBnotmuch-reply\fR(1), +\fBnotmuch-restore\fR(1), \fBnotmuch-search-terms\fR(7), +\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1) diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 index 701186ee..b2301d82 100644 --- a/man/man1/notmuch-show.1 +++ b/man/man1/notmuch-show.1 @@ -10,6 +10,9 @@ notmuch-show \- Show messages matching the given search terms. Shows all messages matching the search terms. +See \fBnotmuch-search-terms\fR(7) +for details of the supported syntax for . + The messages will be grouped and sorted based on the threading (all replies to a particular message will appear immediately after that message in date order). The output is not indented by default, but @@ -133,8 +136,10 @@ column of output from the .B notmuch search command. -See the -.B "SEARCH SYNTAX" -section below for details of the supported syntax for . -.RE -.RS 4 +.SH SEE ALSO + +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), +\fBnotmuch-part\fR(1), \fBnotmuch-reply\fR(1), +\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1), +\fBnotmuch-search-terms\fR(7), \fBnotmuch-tag\fR(1) diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1 index a0082f9b..993911b9 100644 --- a/man/man1/notmuch-tag.1 +++ b/man/man1/notmuch-tag.1 @@ -10,6 +10,9 @@ notmuch-tag \- Add/remove tags for all messages matching the search terms. Add/remove tags for all messages matching the search terms. +See \fBnotmuch-search-terms\fR(7) +for details of the supported syntax for . + Tags prefixed by '+' are added while those prefixed by '\-' are removed. For each message, tag removal is performed before tag addition. @@ -20,7 +23,10 @@ an initial search term beginning with '+' or '\-' is provided by allowing the user to specify a "\-\-" argument to separate the tags from the search terms. -See the -.B "SEARCH SYNTAX" -section below for details of the supported syntax for . -.RE +.SH SEE ALSO + +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), +\fBnotmuch-part\fR(1), \fBnotmuch-reply\fR(1), +\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1), +\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1) diff --git a/man/man1/notmuch.1 b/man/man1/notmuch.1 index fb8c0018..424ca369 100644 --- a/man/man1/notmuch.1 +++ b/man/man1/notmuch.1 @@ -93,9 +93,8 @@ if the setup command has not previously been completed. .SS OTHER COMMANDS Several of the notmuch commands accept search terms with a common -syntax. See the -.B "SEARCH SYNTAX" -section below for more details on the supported syntax. +syntax. See \fNnotmuch-search-terms\fR(7) +for more details on the supported syntax. The .BR search ", " show " and " count @@ -130,6 +129,14 @@ Specifies the location of the notmuch configuration file. Notmuch will use ${HOME}/.notmuch\-config if this variable is not set. .SH SEE ALSO +\fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), +\fBnotmuch-part\fR(1), \fBnotmuch-reply\fR(1), +\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1), +\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1), +\fBnotmuch-tag\fR(1) + + The notmuch website: .B http://notmuchmail.org .SH CONTACT diff --git a/man/man5/notmuch-hooks.5 b/man/man5/notmuch-hooks.5 index 8b66425e..2c4e5527 100644 --- a/man/man5/notmuch-hooks.5 +++ b/man/man5/notmuch-hooks.5 @@ -38,3 +38,11 @@ the scan or import. Typically this hook is used to perform additional query\-based tagging on the imported messages. .RE + +.SH SEE ALSO + +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +\fBnotmuch-dump\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-part\fR(1), +\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), +\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7), +\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1) diff --git a/man/man7/notmuch-search-terms.7 b/man/man7/notmuch-search-terms.7 index 2ccb0855..a53565b8 100644 --- a/man/man7/notmuch-search-terms.7 +++ b/man/man7/notmuch-search-terms.7 @@ -131,3 +131,11 @@ specify a date range to return messages from 2009\-10\-01 until the current time: $(date +%s \-d 2009\-10\-01)..$(date +%s) + +.SH SEE ALSO + +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-part\fR(1), +\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), +\fBnotmuch-search\fR(1), \fBnotmuch-search\fR(1), +\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1) -- 2.43.0