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