]> git.notmuchmail.org Git - notmuch/commitdiff
break up dump and restore man pages.
authorJameson Graef Rollins <jrollins@finestructure.net>
Tue, 27 Dec 2011 06:36:32 +0000 (22:36 -0800)
committerDavid Bremner <bremner@debian.org>
Sat, 31 Dec 2011 19:16:32 +0000 (15:16 -0400)
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.

man/Makefile.local
man/man1/notmuch-dump.1
man/man1/notmuch-restore.1 [changed from symlink to file mode: 0644]

index 0c213d8675a3fde2646bdc0fb15129969414e645..a3ae8976318c1d6403a690ecfac6bf7af0f26279 100644 (file)
@@ -11,6 +11,7 @@ MAN1 := \
        $(dir)/man1/notmuch-config.1 \
        $(dir)/man1/notmuch-count.1 \
        $(dir)/man1/notmuch-dump.1 \
        $(dir)/man1/notmuch-config.1 \
        $(dir)/man1/notmuch-count.1 \
        $(dir)/man1/notmuch-dump.1 \
+       $(dir)/man1/notmuch-restore.1 \
        $(dir)/man1/notmuch-new.1 \
        $(dir)/man1/notmuch-reply.1 \
        $(dir)/man1/notmuch-search.1 \
        $(dir)/man1/notmuch-new.1 \
        $(dir)/man1/notmuch-reply.1 \
        $(dir)/man1/notmuch-search.1 \
@@ -41,7 +42,6 @@ install-man: $(COMPRESSED_MAN)
        install -m0644 $(MAN5_GZ) $(DESTDIR)/$(mandir)/man5
        install -m0644 $(MAN7_GZ) $(DESTDIR)/$(mandir)/man7
        cd $(DESTDIR)/$(mandir)/man1 && ln -s notmuch.1.gz notmuch-setup.1.gz
        install -m0644 $(MAN5_GZ) $(DESTDIR)/$(mandir)/man5
        install -m0644 $(MAN7_GZ) $(DESTDIR)/$(mandir)/man7
        cd $(DESTDIR)/$(mandir)/man1 && ln -s notmuch.1.gz notmuch-setup.1.gz
-       cd $(DESTDIR)/$(mandir)/man1 && ln -s notmuch-dump.1.gz notmuch-restore.1.gz
 
 verify-version-manpage: verify-version-components
        @echo -n "Checking that manual page version is $(VERSION)..."
 
 verify-version-manpage: verify-version-components
        @echo -n "Checking that manual page version is $(VERSION)..."
index 5f5395f69a26f777827ea291e1bba58d835a04c4..9ccf35d55e38e5e6d18cd6c75e31b818d83cc7ca 100644 (file)
@@ -8,14 +8,8 @@ notmuch-dump \- Creates a plain-text dump of the tags of each message.
 .RI "[ <" filename "> ] [--]"
 .RI "[ <" search-term ">...]"
 
 .RI "[ <" filename "> ] [--]"
 .RI "[ <" search-term ">...]"
 
-.B "notmuch restore"
-.RB [ "--accumulate" ]
-.RI "[ <" filename "> ]"
-
 .SH DESCRIPTION
 
 .SH DESCRIPTION
 
-.SS DUMP
-
 Dump tags for messages matching the given search terms.
 
 Output is to the given filename, if any, or to stdout.  Note that
 Dump tags for messages matching the given search terms.
 
 Output is to the given filename, if any, or to stdout.  Note that
@@ -30,25 +24,6 @@ With no search terms, a dump of all messages in the database will be
 generated.  A "--" argument instructs notmuch that the
 remaining arguments are search terms.
 
 generated.  A "--" argument instructs notmuch that the
 remaining arguments are search terms.
 
-.SS RESTORE
-
-Restores the tags from the given file (see
-.BR "notmuch dump" ")."
-
-The input is read from the given filename, if any, or from stdin.
-
-Note: The dump file format is specifically chosen to be
-compatible with the format of files produced by sup-dump.
-So if you've previously been using sup for mail, then the
-.B "notmuch restore"
-command provides you a way to import all of your tags (or labels as
-sup calls them).
-
-The --accumulate switch causes the union of the existing and new tags to be
-applied, instead of replacing each message's tags as they are read in from the
-dump file.
-.RE
-
 See \fBnotmuch-search-terms\fR(7)
 for details of the supported syntax for <search-terms>.
 
 See \fBnotmuch-search-terms\fR(7)
 for details of the supported syntax for <search-terms>.
 
deleted file mode 120000 (symlink)
index b7a4d1b0be7b4a4efa6b5229fec30d2ed618bfd9..0000000000000000000000000000000000000000
+++ /dev/null
@@ -1 +0,0 @@
-notmuch-dump.1
\ No newline at end of file
new file mode 100644 (file)
index 0000000000000000000000000000000000000000..2191df016353508731704c5793b747b2bc1616fb
--- /dev/null
@@ -0,0 +1,39 @@
+.TH NOTMUCH-RESTORE 1 2011-12-04 "Notmuch 0.10.2"
+.SH NAME
+notmuch-restore \- Restores the tags from the given file (see notmuch dump).
+
+.SH SYNOPSIS
+
+.B "notmuch restore"
+.RB [ "--accumulate" ]
+.RI "[ <" filename "> ]"
+
+.SH DESCRIPTION
+
+Restores the tags from the given file (see
+.BR "notmuch dump" ")."
+
+The input is read from the given filename, if any, or from stdin.
+
+Note: The dump file format is specifically chosen to be
+compatible with the format of files produced by sup-dump.
+So if you've previously been using sup for mail, then the
+.B "notmuch restore"
+command provides you a way to import all of your tags (or labels as
+sup calls them).
+
+The --accumulate switch causes the union of the existing and new tags to be
+applied, instead of replacing each message's tags as they are read in from the
+dump file.
+
+See \fBnotmuch-search-terms\fR(7)
+for details of the supported syntax for <search-terms>.
+
+.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-dump\fR(1),
+\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
+\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)