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