mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-29 14:14:12 +01:00
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.
This commit is contained in:
parent
77b8d70600
commit
f079f5f931
3 changed files with 40 additions and 27 deletions
|
@ -11,6 +11,7 @@ MAN1 := \
|
||||||
$(dir)/man1/notmuch-config.1 \
|
$(dir)/man1/notmuch-config.1 \
|
||||||
$(dir)/man1/notmuch-count.1 \
|
$(dir)/man1/notmuch-count.1 \
|
||||||
$(dir)/man1/notmuch-dump.1 \
|
$(dir)/man1/notmuch-dump.1 \
|
||||||
|
$(dir)/man1/notmuch-restore.1 \
|
||||||
$(dir)/man1/notmuch-new.1 \
|
$(dir)/man1/notmuch-new.1 \
|
||||||
$(dir)/man1/notmuch-reply.1 \
|
$(dir)/man1/notmuch-reply.1 \
|
||||||
$(dir)/man1/notmuch-search.1 \
|
$(dir)/man1/notmuch-search.1 \
|
||||||
|
@ -41,7 +42,6 @@ install-man: $(COMPRESSED_MAN)
|
||||||
install -m0644 $(MAN5_GZ) $(DESTDIR)/$(mandir)/man5
|
install -m0644 $(MAN5_GZ) $(DESTDIR)/$(mandir)/man5
|
||||||
install -m0644 $(MAN7_GZ) $(DESTDIR)/$(mandir)/man7
|
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.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
|
verify-version-manpage: verify-version-components
|
||||||
@echo -n "Checking that manual page version is $(VERSION)..."
|
@echo -n "Checking that manual page version is $(VERSION)..."
|
||||||
|
|
|
@ -8,14 +8,8 @@ notmuch-dump \- Creates a plain-text dump of the tags of each message.
|
||||||
.RI "[ <" filename "> ] [--]"
|
.RI "[ <" filename "> ] [--]"
|
||||||
.RI "[ <" search-term ">...]"
|
.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.
|
Dump tags for messages matching the given search terms.
|
||||||
|
|
||||||
Output is to the given filename, if any, or to stdout. Note that
|
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
|
generated. A "--" argument instructs notmuch that the
|
||||||
remaining arguments are search terms.
|
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)
|
See \fBnotmuch-search-terms\fR(7)
|
||||||
for details of the supported syntax for <search-terms>.
|
for details of the supported syntax for <search-terms>.
|
||||||
|
|
||||||
|
|
|
@ -1 +0,0 @@
|
||||||
notmuch-dump.1
|
|
39
man/man1/notmuch-restore.1
Normal file
39
man/man1/notmuch-restore.1
Normal file
|
@ -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)
|
Loading…
Reference in a new issue