Mercurial > addons > slrn-macros > slrn-mime-support-macro

comparison README @ 0:cdc3d19f5ba5 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author Guido Berhoerster <guido+slrn@berhoerster.name>
date Sat, 21 May 2016 11:12:14 +0200
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:cdc3d19f5ba5
1 slrn MIME Support Macro
2 =======================
3
4 The slrn MIME support macro adds comprehensive support for displaying and
5 processing MIME messages to slrn. When opening a MIME message with parts other
6 than plain text or non-MIME messages with a content type other than plain text
7 the macro automatically converts these parts to plain text provided that the
8 conversion has been allowed in the configuration there is an appropriate entry
9 in the mailcap file. Parts with multipart/alternative content type are handled
10 intelligently by preferring the text part if available and falling back to
11 converting another part for which automatic conversion has been enabled. The
12 macro can process arbitrarily nested parts with message/rfc822,
13 multipart/alternative, multipart/mixed, multipart/digest, multipart/related,
14 and multipart/signed content type. It also features full support for mailcap
15 files as defined by RFC 1524, including substitutions. Furthermore, it
16 provides methods for selecting any MIME part for saving or viewing with an
17 external viewer and for toggling between the processed and raw message.
18
19 Usage
20 -----
21
22 The slrn MIME support macro can be used by including it in the .slrnrc user
23 initialization file via the `interpret` command, e.g. provided that the file
24 mime-support.sl is located in one of the directories specified by the
25 macro_directory configuration variable:
26
27 interpret "mime-support.sl"
28
29 The macro can be configured through the following slang variables:
30
31 MIMESupport->config.auto_view
32 : Array that specifies which content types may be automatically converted to
33 plain text when opening a MIME message.
34
35 It provides the following methods:
36
37 MIMESupport->mime_save_part()
38 : Displays a dialog allowing the user to save a MIME part.
39
40 MIMESupport->mime_view_part()
41 : Displays a dialog allowing the user to view a MIME part using the command
42 specified in the mailcap entry corresponding to its content type.
43
44 MIMESupport->mime_toggle_view()
45 : Toggles between the processed and raw form.
46
47 The following environment variables are observed:
48
49 TMPDIR
50 : Path for temorary files when invoking the command specified in a mailcap
51 entry.
52
53 PAGER
54 : The pager used for handling the output of a command specified in a mailcap
55 entry which contains a copiousoutput flag.
56
57 Contact
58 -------
59
60 Please send any feedback, translations or bug reports via email to
61 <guido+slrn@berhoerster.name>.
62
63 Bug Reports
64 -----------
65
66 When sending bug reports, please always mention the exact version of the
67 macro with which the issue occurs as well as the version of slrn, slang and
68 the operating system you are using and make sure that you provide sufficient
69 information to reproduce the issue and include any input, output, any error
70 messages and slang stack traces.
71
72 License
73 -------
74
75 Except otherwise noted, all files are Copyright (C) 2013 Guido Berhoerster and
76 distributed under the following license terms:
77
78 Copyright (C) 2013 Guido Berhoerster <guido+slrn@berhoerster.name>
79
80 This file incorporates work from the file mime.sl distributed with slrn under
81 the terms of the GNU General Public Licens version 2 or later.
82
83 Copyright (C) 2012 John E. Davis <jed@jedsoft.org>
84
85 This program is free software; you can redistribute it and/or
86 modify it under the terms of the GNU General Public License
87 as published by the Free Software Foundation; either version 2
88 of the License, or (at your option) any later version.
89
90 This program is distributed in the hope that it will be useful,
91 but WITHOUT ANY WARRANTY; without even the implied warranty of
92 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
93 GNU General Public License for more details.
94
95 You should have received a copy of the GNU General Public License
96 along with this program; if not, write to the Free Software
97 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.