[DRE-commits] [sup-mail] 02/02: Add man pages for binaries missing them

Wed Sep 3 22:37:15 UTC 2014

This is an automated email from the git hooks/post-receive script.

avtobiff pushed a commit to branch master
in repository sup-mail.

commit 33d5be7bdb403c0b8c96caa11652e0a08db081bb
Author: Per Andersson <avtobiff at gmail.com>
Date:   Thu Sep 4 00:36:42 2014 +0200

    Add man pages for binaries missing them
---
 debian/changelog                        |   1 +
 debian/man/sup-psych-ify-config-files.1 |  81 +++++++++++++++++++++
 debian/man/sup-sync-back-maildir.1      | 123 ++++++++++++++++++++++++++++++++
 3 files changed, 205 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index dc7415d..9702abf 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -29,6 +29,7 @@ sup-mail (0.19.0-1) unstable; urgency=medium
   [ Per Andersson ]
   * d/rules: Remove bin/sup-sync-back removal, not included upstream
   * Bump Standards-Version to 3.9.5, no changes needed
+  * Add man pages for sup-psych-ify-config-files and sup-sync-back-maildir
 
  -- Caitlin Matos <caitlin.matos at zoho.com>  Tue, 26 Aug 2014 14:04:01 -0400
 
diff --git a/debian/man/sup-psych-ify-config-files.1 b/debian/man/sup-psych-ify-config-files.1
new file mode 100644
index 0000000..5c44c3c
--- /dev/null
+++ b/debian/man/sup-psych-ify-config-files.1
@@ -0,0 +1,81 @@
+.TH "SUP\-SYNC" "1" "September 3, 2014" "Sup User Manual" ""
+.SH NAME
+.PP
+sup\-psych\-ify\-config\-files \- migrate Sup configuration
+.SH SYNOPSIS
+.PP
+sup\-psych\-ify\-config\-files
+.SH DESCRIPTION
+.PP
+\f[B]YAML migration is deprecated by Ruby 2.1 and newer.\f[]
+.PP
+If sup\-psych\-ify\-config\-files is executed by Ruby <= 2.0 it migrates
+the \f[I]$HOME/.sup/sources.yaml\f[] configuration file by reading it
+with the SYCK YAML parser and emitting the results with the Psych YAML
+emitter.
+.PP
+Read more on the Sup wiki
+.PP
+https://github.com/sup\-heliotrope/sup/wiki/Migration\-0.13\-to\-0.14
+.SH FILES
+.TP
+.B $HOME/.sup/config.yaml
+Sup configuration file
+.RS
+.RE
+.TP
+.B $HOME/.sup/sources.yaml
+Configuration file for Sup mail sources
+.RS
+.RE
+.SH SEE ALSO
+.PP
+sup(1), sup\-add(1), sup\-config(1), sup\-dump(1)
+.SH REPORTING BUGS
+.PP
+You are welcome to submit bug reports to the Sup issue tracker, located
+at
+.PP
+<https://github.com/sup-heliotrope/sup/issues>
+.SH CONTACT INFORMATION
+.TP
+.B The Sup web page:
+<http://supmua.org/>
+.RS
+.RE
+.TP
+.B Code repository:
+<https://github.com/sup-heliotrope/sup/>
+.RS
+.RE
+.TP
+.B Sup Wiki:
+<https://github.com/sup-heliotrope/sup/wiki/>
+.RS
+.RE
+.TP
+.B Sup IRC channel:
+#sup \@ freenode.net
+.RS
+.RE
+.TP
+.B Mailing list:
+supmua\@googlegroups.com
+.RS
+.PP
+supmua+subscribe\@googlegroups.com
+.PP
+Archives: <https://groups.google.com/d/forum/supmua/>
+.RE
+.SH COPYRIGHT
+.PP
+Copyright © 2006\-2009 William Morgan <mworgan-sup at masanjin.net>
+.PP
+Copyright \@ 2013\-2014 Sup developers
+.PP
+Permission is granted to copy and distribute this manual under the terms
+of the GNU General Public License; either version 2 or (at your option)
+any later version.
+.SH AUTHORS
+Sup was originally written by William Morgan <wmorgan-sup at masanjin.net>
+and is now developed and maintained by the Sup developers.
diff --git a/debian/man/sup-sync-back-maildir.1 b/debian/man/sup-sync-back-maildir.1
new file mode 100644
index 0000000..505ea58
--- /dev/null
+++ b/debian/man/sup-sync-back-maildir.1
@@ -0,0 +1,123 @@
+.TH "SUP\-SYNC\-BACK\-MAILDIR" "1" "August 25, 2014" "Sup User Manual" ""
+.SH NAME
+.PP
+sup\-sync\-back\-maildir \- Export Xapian entries to Maildir sources on
+disk
+.SH SYNOPSIS
+.PP
+sup\-sync\-back\-maildir [\f[I]options\f[]] [\f[I]source uri...\f[]]
+.SH DESCRIPTION
+.PP
+This script parses the Xapian entries for a given Maildir source and
+renames (changes maildir flags) e\-mail files on disk according to the
+labels stored in the index.
+It will export all the changes you made in Sup to your Maildirs so that
+they can be propagated to your IMAP server with e.g.
+offlineimap.
+.PP
+The script also merges some Maildir flags into Sup such as R (replied)
+and P (passed, forwarded), for instance suppose you have an e\-mail file
+like this: foo_bar:2,FRS (flags are favorite, replied, seen) and its
+Xapian entry has labels \[aq]starred\[aq], the merge operation will add
+the \[aq]replied\[aq] label to the Xapian entry.
+.PP
+If you choose not to merge (\-m) you will lose information
+(\[aq]replied\[aq]), and in the previous example the file will be
+renamed to foo_bar:2,FS.
+.PP
+Running this script is \f[I]strongly\f[] recommended when setting the
+"sync_back_to_maildir" option from false to true in config.yaml or
+changing the "sync_back" flag to true for a source in sources.yaml.
+.PP
+If no source is given, the default behavior is to sync back all Maildir
+sources marked as usual and that have not disabled sync back using the
+configuration parameter sync_back = false in sources.yaml.
+.SH OPTIONS
+.TP
+.B \-n, \-\-no\-confirm
+Don\[aq]t ask for confirmation before synchronizing
+.RS
+.RE
+.TP
+.B \-m, \-\-no\-merge
+Don\[aq]t merge new supported Maildir flags (R and P)
+.RS
+.RE
+.TP
+.B \-l, \-\-list\-sources
+List your Maildir sources and exit
+.RS
+.RE
+.TP
+.B \-u, \-\-unusual\-sources\-too
+Sync unusual sources too if no specific source information is given
+.RS
+.RE
+.TP
+.B \-\-version
+Print version and exit
+.RS
+.RE
+.TP
+.B \-h, \-\-help
+Show brief help message
+.RS
+.RE
+.SH FILES
+.TP
+.B $HOME/.sup/sources.yaml
+Configuration file for Sup mail sources
+.RS
+.RE
+.SH SEE ALSO
+.PP
+sup(1), sup\-add(1), sup\-config(1), sup\-dump(1), sup\-sync(1),
+sup\-tweak\-labels(1)
+.SH REPORTING BUGS
+.PP
+You are welcome to submit bug reports to the Sup issue tracker, located
+at
+.PP
+<https://github.com/sup-heliotrope/sup/issues>
+.SH CONTACT INFORMATION
+.TP
+.B The Sup web page:
+<http://supmua.org/>
+.RS
+.RE
+.TP
+.B Code repository:
+<https://github.com/sup-heliotrope/sup/>
+.RS
+.RE
+.TP
+.B Sup Wiki:
+<https://github.com/sup-heliotrope/sup/wiki/>
+.RS
+.RE
+.TP
+.B Sup IRC channel:
+#sup \@ freenode.net
+.RS
+.RE
+.TP
+.B Mailing list:
+supmua\@googlegroups.com
+.RS
+.PP
+supmua+subscribe\@googlegroups.com
+.PP
+Archives: <https://groups.google.com/d/forum/supmua/>
+.RE
+.SH COPYRIGHT
+.PP
+Copyright © 2006\-2009 William Morgan <mworgan-sup at masanjin.net>
+.PP
+Copyright \@ 2013\-2014 Sup developers
+.PP
+Permission is granted to copy and distribute this manual under the terms
+of the GNU General Public License; either version 2 or (at your option)
+any later version.
+.SH AUTHORS
+Sup was originally written by William Morgan <wmorgan-sup at masanjin.net>
+and is now developed and maintained by the Sup developers.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/sup-mail.git

