This commit was generated by cvs2svn to compensate for changes in r542,
[elisp/tm.git] / doc / tm-edit=en.texi
1 @c $Id: tm-edit=en.texi,v 2.0 1996/04/11 17:24:11 morioka Exp $
2
3 @node tm-edit, encoded-word, tm-view, Top
4 @comment  node-name,  next,  previous,  up
5 @chapter tm-edit
6 @cindex tm-edit
7
8 tm-edit is a general MIME viewer for GNU Emacs.
9
10 tm-edit is based on mime.el by UMEDA Masanobu
11 <umerin@@mse.kyutech.ac.jp>, who is famous as the author of GNUS.
12 tm-edit expands following points from mime.el:
13
14 @itemize
15 @item based on RFC 1521/1522
16 @item Content-Disposition field (RFC 1806) supports
17 @item multi-part in multi-part
18 @item PGP
19 @item strength automatic specification for parameter of file type
20 @end itemize
21
22
23 @menu
24 * mime/editor-mode::
25 * single-part operations::
26 * enclosure operation::
27 * other operations of mime/editor-mode::
28 @end menu
29
30
31 @node mime/editor-mode, single-part operations, tm-edit, tm-edit
32 @comment  node-name,  next,  previous,  up
33 @section mime/editor-mode
34 @cindex mime/editor-mode
35
36 @emph{mime/editor-mode} is a minor mode to compose MIME message.
37 In this mode, @emph{tag} represents various kinds of data, you can
38 edit multi-part message.
39
40 There are 2 kinds of @emph{tag}s:
41
42 @itemize
43 @item single-part tag
44 @item multi-part tag
45 @end itemize
46
47 single-part tag represents single part, this form is following:
48
49 @example
50         --[[TYPE/SUBTYPE;PARAMETERS][ENCODING]
51         OPTIONAL-FIELDS]
52 @end example
53
54 TYPE/SUBTYPE and PARAMETERS indicates type/subtype and parameters of
55 Content-Type field. TYPE/SUBTYPE is required, PARAMETERS is optional.
56
57 ENCODING indicates Content-Transfer-Encoding field. It is optional too.
58
59 OPTIONAL-FIELDS is to represent another fields except Content-Type
60 field and Content-Transfer-Encoding field.
61
62 multi-part tags represent multi part. They consist of a pair of 
63 @emph{multi-part beginning tag} and @emph{multi-part ending tag}.
64
65 @emph{multi-part beginning tag}'s form is following:
66
67 @example
68         --<<TYPE>>-@{
69 @end example
70
71 @emph{multi-part ending tag}'s form is following:
72
73 @example
74         --@}-<<TYPE>>
75 @end example
76
77 A region from multi-part beginning tag to multi-part ending tag is
78 called as @emph{enclosure}.
79
80
81 @node single-part operations, enclosure operation, mime/editor-mode, tm-edit
82 @comment  node-name,  next,  previous,  up
83 @section single-part operations
84 @cindex single-part
85
86 Operations to make single-part are following:
87
88 @table @kbd
89 @item @key{C-c C-x C-t}
90 Insert single-part tag indicates text part.
91
92 @item @key{C-c C-x C-i}
93 Insert file as a MIME attachment.
94
95 @item @key{C-c C-x C-e}
96 Insert external part.
97
98 @item @key{C-c C-x C-v}
99 Record audio input until @key{C-g} is pressed, and insert as a audio
100 part. (It requires /dev/audio in default.)
101
102 @item @key{C-c C-x C-y}
103 Insert current (mail or news) message. (It is MUA depended.)
104
105 @item @key{C-c C-x C-m}
106 Insert mail message. (It is MUA depended.)
107
108 @item @key{C-c C-x C-w, C-c C-x C-s}
109 Insert signature.
110
111 @item @key{C-c C-x C-k}
112 Insert PGP public key. (It requires Mailcrypt package.)
113
114 @item @key{C-c C-x t}
115 Insert any  single-part tag.
116 @end table
117
118
119 @node enclosure operation, other operations of mime/editor-mode, single-part operations, tm-edit
120 @comment  node-name,  next,  previous,  up
121 @section enclosure operations
122 @cindex multi-part
123 @cindex enclosure
124
125 Operations to make enclosure are following:
126
127 @table @kbd
128 @item @key{C-c C-x a}
129 Enclose specified region as multipart/alternative.
130
131 @item @key{C-c C-x p}
132 Enclose specified region as multipart/parallel.
133
134 @item @key{C-c C-x m}
135 Enclose specified region as multipart/mixed.
136
137 @item @key{C-c C-x d}
138 Enclose specified region as multipart/digest.
139
140 @item @key{C-c C-x s}
141 Digital-sign to specified region. (*1)
142
143 @item @key{C-c C-x e}
144 Encrypt to specified region. (*1)
145 @end table
146
147 @b{[Notice]}
148 @enumerate
149 @item
150 It requires Mailcrypt package and pgp package. In addition, please set
151 symbol @code{pgp-elkins} or @code{pgp-kazu} to
152 variable @code{mime-editor/signing-type} and
153 @code{mime-editor/encrypting-type}.
154
155 @code{pgp-elkins} indicates draft-elkins-pem-pgp-02.txt,
156 @code{pgp-kazu} indicates draft-kazu-pgp-mime-00.txt.
157 @end enumerate
158
159
160 @node other operations of mime/editor-mode,  , enclosure operation, tm-edit
161 @comment  node-name,  next,  previous,  up
162 @section Another operation in mime/editor-mode.
163
164 There are another operations in mime/editor-mode.
165
166 @table @kbd
167 @item @key{C-c C-c}
168 Send current editing message.
169
170 @item @key{C-c C-x C-p}
171 Preview current editing message.
172
173 @item @key{C-c C-x C-z}
174 Exit mime/editor-mode. (@key{M-x mime/edit-again} is available to
175 reedit.)
176
177 @item @key{C-c C-x ?}
178 Display help message.
179
180 @item @key{M-x mime-editor/set-split}
181 Set current editing message to enable automatic splitting or not.
182 Form of automatic split messages is message/partial.
183
184 @item @key{M-x mime-editor/set-sign}
185 Set current editing message to digital-sign or not. (*1)
186
187 @item @key{M-x mime-editor/set-encrypt}
188 Set current editing message to encrypt or not. (*1)
189 @end table
190
191 @b{[Notice]}
192 @enumerate
193 @item
194 It requires Mailcrypt package and pgp package. In addition, please set
195 symbol @code{pgp-elkins} or @code{pgp-kazu} to
196 variable @code{mime-editor/signing-type} and
197 @code{mime-editor/encrypting-type}.
198
199 @code{pgp-elkins} indicates draft-elkins-pem-pgp-02.txt,
200 @code{pgp-kazu} indicates draft-kazu-pgp-mime-00.txt.
201 @end enumerate