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