doc/tm_en.texi

   1 \input texinfo.tex
   2 @c{-*-tm manual-*-}
   3 @setfilename tm_en.info
   4 @settitle tm manual
   5
   6 @titlepage
   7 @title tm Manual (English Version)
   8 @author by MORIOKA Tomohiko
   9 @code{$Id: tm_en.texi,v 7.17 1996/05/15 19:31:39 morioka Exp morioka $}
  10 @end titlepage
  11
  12
  13 @node Top, Introduction, (dir), (dir)
  14 @top tm 7.32 Reference manual
  15
  16 @comment  node-name,  next,  previous,  up
  17 @ifinfo
  18 This file documents tm, a MIME package for GNU Emacs.
  19
  20 @end ifinfo
  21
  22 @menu
  23 * Introduction::   What is tm?
  24 * Emacs Versions:: Differences between each emacs variants.
  25 * Setting::
  26
  27 * tm-MUA::         Extension of mh-e, GNUS, RMAIL and VM
  28 * tm-mh-e: (tm-mh-e_en.info).   mh-e
  29 * tm-gnus: (tm-gnus_en.info).   GNUS and Gnus
  30 * tm-rmail: (tm-rmail_en.info). RMAIL
  31 * tm-vm: (tm-vm_en.info).       VM
  32
  33 * tm-view::        MIME message navigator.
  34 * tm-edit::        MIME message composer.
  35 * encoded-word::   multi lingual characters in message header
  36 * customize::
  37
  38 * Bug report::     How to report bug and about mailing list of tm.
  39
  40 * Concept Index::
  41 * Command Index::
  42 * Variable Index::
  43 @end menu
  44
  45
  46 @node Introduction, Emacs Versions, Top, Top
  47 @comment  node-name,  next,  previous,  up
  48 @chapter What is tm?
  49 @cindex tm
  50
  51 The tm package is a set of modules to enjoy MIME on GNU Emacs.  Using tm,
  52 you can
  53
  54 @itemize @bullet
  55 @item playback or view the MIME messages using tm-view
  56 @item compose MIME message using tm-edit
  57 @item use the enhanced MIME features with mh-e, GNUS, RMAIL and VM
  58 @end itemize
  59
  60 and more.
  61
  62
  63 @section List of modules
  64 @cindex List of modules
  65
  66 The tm package includes the modules listed below.
  67
  68 @itemize @minus
  69 @item @strong{tm-view:}   MIME viewer
  70 @item @strong{tm-edit:}   MIME composer
  71 @item @strong{tm-def:}    definition module for tm
  72         @item @strong{tm-mh-e:}  tm-MUA for mh-e
  73         @item @strong{tm-gnus:}  tm-MUA for GNUS
  74         @item @strong{tm-rmail:} tm-MUA for RMAIL
  75         @item @strong{tm-vm:}    tm-MUA for VM
  76 @item @strong{tm-setup:} tm-MUA setup module
  77 @item @strong{mime-setup:} MIME setup module
  78 @end itemize
  79
  80
  81 @node Emacs Versions, Setting, Introduction, Top
  82 @comment  node-name,  next,  previous,  up
  83 @chapter Considerations for each emacs variants
  84 @cindex Considerations for each emacs variants
  85
  86 @section original GNU Emacs 18
  87
  88 I can not guarantee, but you may use US-ASCII only.
  89
  90 @section NEmacs, NEpoch
  91
  92 ISO-2022-JP and US-ASCII can be used if you use NEmacs.
  93
  94 @section original GNU Emacs 19
  95
  96 US-ASCII and ISO-8859-1 can be used if you use the original Emacs
  97 19.*.
  98
  99 When emacs is running with own window in X window environment, tm-rich
 100 displays multi face for text/richtext and text/enriched richtext
 101 messages.
 102
 103 @section Mule
 104
 105 Mule can handle the multi-lingual text.  With Mule, tm supports
 106 ISO-2022-JP, ISO-2022-JP-2, US-ASCII, ISO-8859-1..9, ISO-2022-CN,
 107 ISO-2022-KR, EUC-KR, etc.  You can also add or change
 108 encoding/decoding for character sets by mime/set-charset-and-encoding
 109 function.
 110
 111 When Mule 2.* is running with own window in X window environment,
 112 tm-rich displays multi face for text/richtext and text/enriched
 113 richtext messages.
 114
 115 @section XEmacs
 116
 117 US-ASCII and ISO-8859-1 can be used if you use the XEmacs.
 118
 119 In future, we will support inline image.
 120
 121
 122 @node Setting, tm-MUA, Emacs Versions, Top
 123 @comment  node-name,  next,  previous,  up
 124 @chapter Setting
 125 @cindex Setting
 126
 127 In the tm package, two files, mime-setup.el and tm-setup.el, are
 128 provided to ease the setup. The mime-setup.el is used for the whole MIME
 129 related setup including MIME encoding using tm-edit.el, while tm-setup is
 130 used to set up tm-MUA only.
 131
 132 @menu
 133 * mime-setup::     normal setting
 134 * tm-setup::       setting not to use tm-edit
 135 * tm-vm::          setting for VM
 136 * manual setting::
 137 @end menu
 138
 139
 140 @node mime-setup, tm-setup, Setting, Setting
 141 @comment  node-name,  next,  previous,  up
 142 @section mime-setup.el
 143 @cindex mime-setup.el
 144
 145 @lisp
 146 (load "mime-setup")
 147 @end lisp
 148
 149 will perform various settings of MIME.  As mime-setup.el loads
 150 tm-setup.el, you do not need to load tm-setup.el when you use
 151 mime-setup.el.
 152
 153
 154 @subsection variable of mime-setup.el
 155
 156 @subsection SuperCite
 157 @cindex SuperCite
 158
 159 @defvar mime-setup-use-sc
 160
 161 If it is not nil, mime-setup.el sets up SuperCite using sc-setup.el.
 162 Its default value is nil.
 163
 164 If you set up SuperCite, you need the SuperCite package.
 165 @end defvar
 166
 167
 168 @subsubsection signature
 169 @cindex signature
 170
 171 You can set up the "automatic signature selection tool" using
 172 mime-setup. If you want to automatically select the signature file
 173 depending on how the message headers show, add lines like shown below
 174 to your .emacs (Refer to the reference manual of signature.el for more
 175 details).
 176
 177 @lisp
 178 (setq signature-file-alist
 179       '((("Newsgroups" . "jokes")       . "~/.signature-jokes")
 180         (("Newsgroups" . ("zxr" "nzr")) . "~/.signature-sun")
 181         (("To" . ("ishimaru" "z-suzuki")) . "~/.signature-sun")
 182         (("To" . "tea")                 . "~/.signature-jokes")
 183         (("To" . ("sim" "oku" "takuo")) . "~/.signature-formal")
 184         ))
 185 @end lisp
 186
 187
 188 @defvar mime-setup-use-signature
 189
 190 If it is not nil, mime-setup.el sets up for signature.el. Its default
 191 value is t.
 192 @end defvar
 193
 194
 195 @defvar mime-setup-signature-key-alist
 196
 197 It defines key to bind signature inserting command for each
 198 major-mode. Its default value is following:
 199
 200 @lisp
 201         ((mail-mode . "\C-c\C-w"))
 202 @end lisp
 203
 204 If you want to change, please rewrite it. For example:
 205
 206 @lisp
 207 (set-alist 'mime-setup-signature-key-alist 'news-reply-mode "\C-c\C-w")
 208 @end lisp
 209
 210 @end defvar
 211
 212
 213 @defvar mime-setup-default-signature-key
 214
 215 If key to bind signature inserting command for a major-mode is not
 216 found from mime-setup-signature-key-alist, its value is used as key.
 217 Its default value is ``\C-c\C-s''.
 218 @end defvar
 219
 220
 221 @subsection Notices for GNUS
 222 @cindex GNUS
 223
 224 When mime-setup.el sets up for signature.el, it sets variable
 225 @code{gnus-signature-file} to nil. Therefore GNUS does not insert
 226 signature automatically when it is sending a message. Reason of this
 227 setting is following:
 228
 229 GNUS inserts signature after tm-edit.el composed as MIME
 230 message. Therefore signature inserted by GNUS is not processed as a
 231 valid MIME part. In particular, for multipart message, signature
 232 places in outside of MIME part. So MIME MUA might not display it.
 233
 234 Other notice is key bind. In historical reason, key bind to insert
 235 signature is @key{C-c C-s} (like mh-e) instead of @key{C-c C-w}. If
 236 you change to GNUS's default, please set following:
 237
 238 @lisp
 239 (set-alist 'mime-setup-signature-key-alist 'news-reply-mode "\C-c\C-w")
 240 @end lisp
 241
 242
 243 @node tm-setup, tm-vm, mime-setup, Setting
 244 @comment  node-name,  next,  previous,  up
 245 @section tm-setup
 246
 247 tm-setup.el only sets up tm-MUAs.  You do not need to explicitly load
 248 tm-setup.el if you are using mime-setup.el for your setup.
 249 tm-setup.el is useful when you do not want to use mime-setup.el but
 250 want to set up tm-MUAs.
 251
 252 @lisp
 253 (load "tm-setup")
 254 @end lisp
 255
 256
 257 @node tm-vm, manual setting, tm-setup, Setting
 258 @comment  node-name,  next,  previous,  up
 259 @section vm
 260
 261 If you use vm, please insert following in ~/.vm:
 262
 263 @lisp
 264 (require 'tm-vm)
 265 @end lisp
 266
 267 Notice: If you use BBDB, please insert @code{(require 'tm-vm)}
 268 @strong{after} @code{(bbdb-insinuate-vm)}.
 269
 270
 271 @node manual setting,  , tm-vm, Setting
 272 @comment  node-name,  next,  previous,  up
 273 @section Setting up without loading provided setup files
 274
 275 You may find the valuable hints in tm-setup.el if you want to set up
 276 MIME environment without loading the tm-provided setup files.
 277
 278
 279 @node tm-MUA, tm-view, Setting, Top
 280 @comment  node-name,  next,  previous,  up
 281 @chapter tm-MUA
 282 @cindex tm-MUA
 283
 284 ``tm-MUA'' is a generic name of the modules which enhance the MIME
 285 functions of MUA like mh-e, GNUS, and RMAIL etc.
 286
 287 The current version of tm provides the following tm-MUA.
 288
 289 @itemize @minus
 290 @item @strong{tm-mh-e:}  tm-MUA for mh-e
 291 @item @strong{tm-gnus:}  tm-MUA for GNUS
 292 @item @strong{tm-rmail:} tm-MUA for RMAIL
 293 @item @strong{tm-vm:}    tm-MUA for VM
 294 @end itemize
 295
 296 You can find the detailed explanations of these modules in the
 297 following sections.
 298
 299
 300 @section Summary mode
 301
 302 If you are using tm-MUA, the following functions are added to the
 303 Summary mode of the MUA.
 304
 305 @table @kbd
 306 @item @key{M-t}
 307 toggles decoding of MIME headers
 308 @item @key{v}
 309 enters @code{mime/viewer-mode} to view a message
 310 @end table
 311
 312 Notice: In tm-vm, key to enter @code{mime/viewer-mode} is @key{Z}
 313 instead of @key{v}. In tm-mh-e, tm-vm and tm-gnus in Gnus 3.15 or
 314 later, preview buffer of @code{mime/viewer-mode} displays
 315 automatically in default setting.
 316
 317 @menu
 318 * tm-mh-e: (tm-mh-e_en.info).
 319 * tm-gnus: (tm-gnus_en.info).
 320 * tm-rmail: (tm-rmail_en.info).
 321 * tm-vm: (tm-vm_en.info).
 322 * tm-cmail: (tm-cmail_en.info).
 323 @end menu
 324
 325
 326 @include tm-view=en.texi
 327
 328 @include tm-edit-en.texi
 329
 330 @include tm-ew=en.texi
 331
 332 @include tm-util=en.texi
 333
 334
 335 @node Bug report, Concept Index, customize, Top
 336 @comment  node-name,  next,  previous,  up
 337 @chapter How to report bug and about mailing list of tm
 338 @cindex bug report
 339 @cindex mailing list
 340
 341 Please report tm bugs you find to fj.editor.emacs or send a mail to:
 342
 343 @itemize @bullet
 344 @item Japanese or English
 345
 346         <bug-tm-ja@@chamonix.jaist.ac.jp>
 347
 348 @item English
 349
 350         <bug-tm-en@@chamonix.jaist.ac.jp>
 351 @end itemize
 352
 353 Via tm ML, You can report bugs of tm, obtain the latest release of tm
 354 package, and discuss the future enhancements to tm.  To join tm ML,
 355 send a mail to
 356
 357 @itemize @bullet
 358 @item Japanese
 359
 360         <tm-ja-admin@@chamonix.jaist.ac.jp>
 361
 362 @item English
 363
 364         <tm-en-admin@@chamonix.jaist.ac.jp>
 365 @end itemize
 366
 367 Since the user registration is manually done, please write
 368 the mail body in human-recognizable language. (^_^)
 369
 370
 371 @node Concept Index, Command Index, Bug report, Top
 372 @unnumbered Concept Index
 373
 374 @printindex cp
 375
 376
 377 @node Command Index, Variable Index, Concept Index, Top
 378 @unnumbered Command and Function Index
 379
 380 @printindex fn
 381
 382
 383 @node Variable Index, , Command Index, Top
 384 @unnumbered Variable Index
 385
 386 @printindex vr
 387
 388 @bye