File: muttprofile.1

package info (click to toggle)
muttprofile 1.0.1-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 184 kB
  • sloc: perl: 520; makefile: 13
file content (236 lines) | stat: -rw-r--r-- 7,706 bytes parent folder | download | duplicates (5)
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MUTTPROFILE 1"
.TH MUTTPROFILE 1 "2003-01-15" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
muttprofile \- Choose a Mutt Profile
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBmuttprofile\fR [\-a|\-\-active string] [\-d|\-\-dir directory] [\-h|\-\-help] [\-p|\-\-profile regexp] [\-v|\-\-view] [\-V|\-\-Version] [profile]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBmuttprofile\fR is a simple utility to choose a profile to be used with Mutt email\-client.
It has two operating modes: command-line and interactive. Muttprofile goes to interactive
mode if no command-line arguments are present or option \-v|\-\-view is present without profile name.
.PP
Muttprofile looks for profile files in the Mutt directory, opens them and looks for
\&\s-1NAME\s0 and \s-1DESC\s0 definitions. It then creates a symbolic link to the profile chosen by the user. 
The rest of the work is done with a Mutt macro.
.SH "USAGE"
.IX Header "USAGE"
Interactive mode:
.PP
Type the name of the profile and the program creates a symlink to load the profile.
Press <tab> to complete, <ctrl\-d> to see list of choices.
.PP
Command-line options:
.PP
\&\fB\-a | \-\-active\fR Set the name for active profile symlink, default is profile.active
.PP
\&\fB\-d | \-\-dir\fR Set the Mutt directory, default is ~/.mutt
.PP
\&\fB\-h | \-\-help\fR prints a short help and exits
.PP
\&\fB\-p | \-\-profile\fR (Perl) Regexp to match profile files in Mutt directory
.PP
\&\fB\-v | \-\-view\fR Instead of creating a symlink, view profile contents
.PP
\&\fB\-V | \-\-version\fR prints the version information and exits (use \-\-version for long and \-V for short version)
.PP
\&\fBprofile\fR if profile exits, create the symlink to load it from Mutt, otherwise exit with error
.SH "INSTALL"
.IX Header "INSTALL"
\&\fBMuttprofile\fR requires no installation, but you might have to
check the first line of the file (\f(CW\*(C`#!/usr/bin/perl \-w\*(C'\fR)
and change the path to perl if needed (\f(CW'which perl'\fR might be useful here :\-)
.SH "SETTING UP PROFILES"
.IX Header "SETTING UP PROFILES"
\&\fBMuttprofile\fR checks the profile files for the following information:
.PP
# \s-1NAME:\s0 name for your profile
.PP
# \s-1DESC:\s0 description of your profile
.PP
This information is used for choosing and displaying available profiles.
\&\s-1DESC\s0 is optional, but if \s-1NAME\s0 is missing, filename is used instead.
.SH "USING MUTTPROFILE FROM MUTT"
.IX Header "USING MUTTPROFILE FROM MUTT"
Perhaps the easiest way to invoke \fBmuttprofile\fR from \fBmutt\fR is to bind a
key with mutt macro command. For example, adding this to your \fImuttrc\fR\-file
.PP
macro	index	<F10>	\*(L"!muttprofile\en:source ~/.mutt/profile.active\enm\*(R" \*(L"New message with profile\*(R"
.PP
binds the function key <F10> to start muttprofile, load the profile and start a new message
.SH "EXIT CODES"
.IX Header "EXIT CODES"
The default exit codes for muttprofile are:
.PP
.Vb 3
\&    0 OK
\&    1 PROFILE ALREADY ACTIVE
\&    2 ERROR
.Ve
.PP
These codes can be used in shell scripts etc.
.SH "FURTHER INFORMATION"
.IX Header "FURTHER INFORMATION"
Discussion of profiles with Mutt: http://www.iki.fi/martti.rahkila/mutt/
.PP
Mutt home page: http://www.mutt.org
.SH "MODULES"
.IX Header "MODULES"
\&\fBmuttprofile\fR uses the perl modules \f(CW\*(C`Term::Complete\*(C'\fR
and \f(CW\*(C`Getopt::Long\*(C'\fR that both come with the Perl distribution.
.SH "LICENCE"
.IX Header "LICENCE"
\&\fBmuttprofile\fR is distibuted under \s-1GNU\s0 General Public Licence (\s-1GPL\s0), same
as Mutt. For details, see http://www.gnu.org/copyleft/gpl.html
.SH "BUGS"
.IX Header "BUGS"
None known so far. Inevitably to appear sooner or later.
.SH "VERSION"
.IX Header "VERSION"
.RE
.IP "1.0.0 (current)"
.IX Item "1.0.0 (current)"
First public release.
.PP
2000\-05\-10 Martti Rahkila
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 3
\&  Martti Rahkila
\&  martti.rahkila@iki.fi
\&  http://www.iki.fi/martti.rahkila/mutt
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fImutt\fR\|(1), \fIperl\fR\|(1)