File: sup.1

package info (click to toggle)
sup-mail 1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,412 kB
  • sloc: ruby: 13,047; sh: 167; makefile: 12
file content (122 lines) | stat: -rw-r--r-- 3,145 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
.\" Automatically generated by Pandoc 3.1.11.1
.\"
.TH "SUP" "1" "April 8, 2014" "Sup User Manual" ""
.SH NAME
sup \- a curses\-based email client
.SH SYNOPSIS
sup [\f[I]options\f[R]]
.SH DESCRIPTION
Sup is a console\-based email client for people with a lot of email.
.PP
It presents an interface of a list of threads, which are each
hierarchical collections email messages.
Threads can have multiple tags applied to them.
It supports a very fast full\-text search, automatic contact\-list
management, custom code insertion via a Ruby hook system, and more.
If you\[cq]re the type of person who treats email as an extension of
your long\-term memory, Sup is for you.
.SH OPTIONS
.TP
\-l, \-\-list\-hooks
List all hooks and descriptions, and quit.
Use \[en]hooks\-matching to filter
.TP
\-m, \-\-hooks\-matching=<s>
If given, list all hooks and descriptions matching the given pattern.
Needs the \[en]list\-hooks option (default: )
.TP
\-n, \-\-no\-threads
Turn off threading.
Helps with debugging.
(Necessarily disables background polling for new messages.)
.TP
\-o, \-\-no\-initial\-poll
Don\[cq]t poll for new messages when starting.
.TP
\-s \f[I]QUERY\f[R], \-\-search \f[I]QUERY\f[R]
Search for this query upon startup
.TP
\-c \f[I]STRING\f[R], \-\-compose \f[I]STRING\f[R]
Compose message to this recipient upon startup
.TP
\-j \f[I]STRING\f[R], \-\-subject \f[I]STRING\f[R]
When composing, use this subject
.TP
\-v, \-\-version
Print version and exit
.TP
\-h, \-\-help
Show brief help message
.SH ENVIRONMENT
.TP
SUP_LOG_LEVEL
Set log level verbosity.
Valid values ordered by decresing verbosity: debug info warn error.
Default log level is info.
.TP
SUP_BASE\[rs]
Specify home directory for configuration files and xapian index,
defaults to: $HOME/.sup.
.SH FILES
.TP
$HOME/.sup/config.yaml
Configuration file for Sup
.TP
$HOME/.sup/sources.yaml
Configuration file for Sup mail sources
.TP
$HOME/.sup/colors.yaml
Color theme for Sup
.SH SEE ALSO
mail(1), sup\-add(1), sup\-config(1), sup\-dump(1),
sup\-import\-dump(1), sup\-recover\-sources(1), sup\-sync(1),
sup\-sync\-back\-maildir(1), sup\-tweak\-labels(1)
.SH REPORTING BUGS
You are welcome to submit bug reports to the Sup issue tracker, located
at
.PP
\c
.UR https://github.com/sup-heliotrope/sup/issues
.UE \c
.SH CONTACT INFORMATION
.TP
The Sup web page:
\c
.UR https://sup-heliotrope.github.io/
.UE \c
.TP
Code repository:
\c
.UR https://github.com/sup-heliotrope/sup/
.UE \c
.TP
Sup Wiki:
\c
.UR https://github.com/sup-heliotrope/sup/wiki/
.UE \c
.TP
Mailing list:
supmua\[at]googlegroups.com
.RS
.PP
supmua+subscribe\[at]googlegroups.com
.PP
Archives: \c
.UR https://groups.google.com/d/forum/supmua/
.UE \c
.RE
.SH COPYRIGHT
Copyright © 2006\-2009 William Morgan \c
.MT mworgan-sup@masanjin.net
.ME \c
.PP
Copyright \[at] 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 \c
.MT wmorgan-sup@masanjin.net
.ME \c
\ and is now developed and maintained by the Sup developers.