aboutsummaryrefslogtreecommitdiff
path: root/vim/doc/mail_mutt.txt
blob: 1129651d5345d9e82e109b34149d7f7843dcf97b (plain)
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
*mail_mutt.txt*	For Vim version 7.0	Last change: 2017 November 12

DESCRIPTION					*mail_mutt*

This plugin allows you to quickly start writing an email message in Mutt with
a range of lines from the current buffer as the initial mail content.

REQUIREMENTS					*mail_mutt-requirements*

This plugin is only available if 'compatible' is not set.

You will want to have the mutt(1) command from the Mutt distribution installed
to use this plugin. Mutt is available from <http://www.mutt.org/>.

COMMANDS					*mail_mutt-commands* *:MailMutt*

This plugin provides a single command `:MailMutt` command which accepts a line
range prefix defaulting to the entire buffer, writing these lines to a
temporary file that is then provided to the -i option of the Mutt mail user
agent, as the initial content of a new message.
>
	:MailMutt
	:.MailMutt
	:3,6MailMutt
	:95,$MailMutt
<
MAPPINGS					*mail_mutt-mappings*

Three <Plug> mapping targets are also provided for convenience. No attempt is
made to map key sequences to these mappings within the plugin; you must do
this explicitly in your |vimrc|.

                                                *<Plug>MailMuttLine*
Th <Plug>MailMuttLine mapping runs `:MailMutt` on the current line in normal
mode. A binding example might be:
>
	:nmap <Leader>ml <Plug>MailMuttLine
<
						*<Plug>MailMuttBuffer*
The <Plug>MailMuttBuffer mapping runs `:MailMutt` on the whole buffer in
normal mode. A binding example might be:
>
	:nmap <Leader>mb <Plug>MailMuttBuffer
<
						*<Plug>MailMuttSelected*
The <Plug>MailMuttSelected mapping runs `:MailMutt` on the selected lines in
visual or selection mode. A binding example might be:
>
	:vmap <Leader>ms <Plug>MailMuttSelected
<
AUTHOR                                          *mail_mutt-author*

Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.

LICENSE						*mail_mutt-license*

Licensed for distribution under the same terms as Vim itself (see |license|).

DISTRIBUTION					*mail_mutt-distribution*

This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun
off into a separate distribution as it solidifies and this documentation
improves. See <https://sanctum.geek.nz/cgit/dotfiles.git/about/> for more
information.

 vim:tw=78:ts=8:ft=help:norl: