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