@titlepage
@title tm Manual (English Version)
@author by MORIOKA Tomohiko
-@code{$Id: tm_en.texi,v 6.2 1995/08/12 08:45:35 morioka Exp $}
+@code{$Id: tm_en.texi,v 7.17 1996/05/15 19:31:39 morioka Exp morioka $}
@end titlepage
-@node Top, List of modules, (dir), (dir)
+@node Top, Introduction, (dir), (dir)
+@top tm 7.32 Reference manual
+
@comment node-name, next, previous, up
-@chapter tm
-@cindex tm
+@ifinfo
+This file documents tm, a MIME package for GNU Emacs.
-The tm package is a set of modules to enjoy MIME on GNU Emacs. Using tm,
-you can
+@end ifinfo
-@itemize
-@item playback or view the MIME messages using mime/viewer-mode
-@item encode and decode the multi-lingual headers using tiny-mime
-@item use the enhanced MIME functions with mh-e, GNUS, RMAIL and VM
-@end itemize
+@menu
+* Introduction:: What is tm?
+* Emacs Versions:: Differences between each emacs variants.
+* Setting::
-and more.
+* tm-MUA:: Extension of mh-e, GNUS, RMAIL and VM
+* tm-mh-e: (tm-mh-e_en.info). mh-e
+* tm-gnus: (tm-gnus_en.info). GNUS and Gnus
+* tm-rmail: (tm-rmail_en.info). RMAIL
+* tm-vm: (tm-vm_en.info). VM
+* tm-view:: MIME message navigator.
+* tm-edit:: MIME message composer.
+* encoded-word:: multi lingual characters in message header
+* customize::
+
+* Bug report:: How to report bug and about mailing list of tm.
-@menu
-* List of modules::
-* Emacs Versions::
-* Install::
-* Setting::
-* tm-MUA::
-* tm-view: (tm-view_en.info).
-* Bug report:: How to report bug and about mailing list of tm.
* Concept Index::
* Command Index::
* Variable Index::
@end menu
-@node List of modules, Emacs Versions, Top, Top
+@node Introduction, Emacs Versions, Top, Top
@comment node-name, next, previous, up
-@chapter List of modules
+@chapter What is tm?
+@cindex tm
+
+The tm package is a set of modules to enjoy MIME on GNU Emacs. Using tm,
+you can
+
+@itemize @bullet
+@item playback or view the MIME messages using tm-view
+@item compose MIME message using tm-edit
+@item use the enhanced MIME features with mh-e, GNUS, RMAIL and VM
+@end itemize
+
+and more.
+
+
+@section List of modules
@cindex List of modules
The tm package includes the modules listed below.
-@itemize
-@item @strong{tiny-mime:} MIME header encoder/decoder
+@itemize @minus
@item @strong{tm-view:} MIME viewer
-@item @strong{tm-misc:} common part for tm-MUAs
+@item @strong{tm-edit:} MIME composer
+@item @strong{tm-def:} definition module for tm
@item @strong{tm-mh-e:} tm-MUA for mh-e
@item @strong{tm-gnus:} tm-MUA for GNUS
@item @strong{tm-rmail:} tm-MUA for RMAIL
@item @strong{mime-setup:} MIME setup module
@end itemize
-@menu
-* tiny-mime:(tm-eword_en.info).
-* tm-view:(tm-view_en.info).
-* tm-mh-e:(tm-mh-e_en.info).
-* tm-gnus:(tm-gnus_en.info).
-* tm-rmail:(tm-rmail_en.info).
-* tm-vm:(tm-vm_en.info).
-* chain-mail:(tm-cmail_en.info).
-@end menu
-
-@node Emacs Versions, Install, List of modules, Top
+@node Emacs Versions, Setting, Introduction, Top
@comment node-name, next, previous, up
@chapter Considerations for each emacs variants
@cindex Considerations for each emacs variants
@section Mule
-Mule can handle the multi-lingual text. With Mule, tiny-mime supports
+Mule can handle the multi-lingual text. With Mule, tm supports
ISO-2022-JP, ISO-2022-JP-2, US-ASCII, ISO-8859-1..9, ISO-2022-CN,
ISO-2022-KR, EUC-KR, etc. You can also add or change
encoding/decoding for character sets by mime/set-charset-and-encoding
US-ASCII and ISO-8859-1 can be used if you use the XEmacs.
-In future, we will support multi face and inline image.
+In future, we will support inline image.
-@node Install, Setting, Emacs Versions, Top
+@node Setting, tm-MUA, Emacs Versions, Top
@comment node-name, next, previous, up
-@chapter Install
-@cindex Install
-
-You can install tm by following the procedures below.
-
-@section tl install
+@chapter Setting
+@cindex Setting
-tm requires the Emacs Lisp library ``tl'', so please install this at
-first.
+In the tm package, two files, mime-setup.el and tm-setup.el, are
+provided to ease the setup. The mime-setup.el is used for the whole MIME
+related setup including MIME encoding using tm-edit.el, while tm-setup is
+used to set up tm-MUA only.
-How to install tl is written in tl/README.eng.
+@menu
+* mime-setup:: normal setting
+* tm-setup:: setting not to use tm-edit
+* tm-vm:: setting for VM
+* manual setting::
+@end menu
-@section Makefile
+@node mime-setup, tm-setup, Setting, Setting
+@comment node-name, next, previous, up
+@section mime-setup.el
+@cindex mime-setup.el
-Please modify Makefile to your environment.
+@lisp
+(load "mime-setup")
+@end lisp
-@subsection Specification executable file name of emacs
+will perform various settings of MIME. As mime-setup.el loads
+tm-setup.el, you do not need to load tm-setup.el when you use
+mime-setup.el.
-Please specify executable file name of emacs.
-@itemize
-@item NEMACS = for NEMACS (or NEpoch)
-@item MULE1 = for Mule 1.* (based on Emacs 18.*)
-@item ORIG19 = for Emacs 19.* (FSF original or XEmacs)
-@item MULE2 = for MULE 2.* (based on Emacs 19.*)
-@end itemize
+@subsection variable of mime-setup.el
-@subsection Specification load-path
+@subsection SuperCite
+@cindex SuperCite
-Please specify directory to install Emacs Lisp program.
+@defvar mime-setup-use-sc
-@itemize
-@item TLDIR18 = for Emacs 18.* (NEMACS, NEpoch or MULE 1)
-@item TLDIR19 = for Emacs 19.* (FSF original, XEmacs or MULE 2)
-@end itemize
+If it is not nil, mime-setup.el sets up SuperCite using sc-setup.el.
+Its default value is nil.
+If you set up SuperCite, you need the SuperCite package.
+@end defvar
-@section External method
-Please modify method script in tm/methods/ to your environment.
+@subsubsection signature
+@cindex signature
+You can set up the "automatic signature selection tool" using
+mime-setup. If you want to automatically select the signature file
+depending on how the message headers show, add lines like shown below
+to your .emacs (Refer to the reference manual of signature.el for more
+details).
-@section make
+@lisp
+(setq signature-file-alist
+ '((("Newsgroups" . "jokes") . "~/.signature-jokes")
+ (("Newsgroups" . ("zxr" "nzr")) . "~/.signature-sun")
+ (("To" . ("ishimaru" "z-suzuki")) . "~/.signature-sun")
+ (("To" . "tea") . "~/.signature-jokes")
+ (("To" . ("sim" "oku" "takuo")) . "~/.signature-formal")
+ ))
+@end lisp
-Run `make all'.
+@defvar mime-setup-use-signature
-@section install
+If it is not nil, mime-setup.el sets up for signature.el. Its default
+value is t.
+@end defvar
-Run `make install'.
+@defvar mime-setup-signature-key-alist
-@section install Emacs Lisp program
+It defines key to bind signature inserting command for each
+major-mode. Its default value is following:
-Run `make install-nemacs', if you use NEmacs or NEpoch.
+@lisp
+ ((mail-mode . "\C-c\C-w"))
+@end lisp
-Run `make install-mule1', if you use Mule 1.* (based on Emacs 18.*).
+If you want to change, please rewrite it. For example:
-Run `make install-orig19', if you use Original Emacs 19.* or XEmacs.
+@lisp
+(set-alist 'mime-setup-signature-key-alist 'news-reply-mode "\C-c\C-w")
+@end lisp
-Run `make install-mule2', if you use Mule 2.* (based on Emacs 19.*).
+@end defvar
-Or copy *.el to your emacs lisp directory.
+@defvar mime-setup-default-signature-key
-@node Setting, tm-MUA, Install, Top
-@comment node-name, next, previous, up
-@chapter Setting
-@cindex Setting
+If key to bind signature inserting command for a major-mode is not
+found from mime-setup-signature-key-alist, its value is used as key.
+Its default value is ``\C-c\C-s''.
+@end defvar
-In the tm package, two files, mime-setup.el and tm-setup.el, are provided
-to ease the setup. A mime-setup.el is used for the whole MIME related
-setup including MIME encoding, while tm-setup is used to set up tm-MUA
-only.
-@section mime-setup
+@subsection Notices for GNUS
+@cindex GNUS
-@lisp
-(load "mime-setup")
-@end lisp
+When mime-setup.el sets up for signature.el, it sets variable
+@code{gnus-signature-file} to nil. Therefore GNUS does not insert
+signature automatically when it is sending a message. Reason of this
+setting is following:
-will perform various settings of MIME. As mime-setup loads
-tm-setup, you do not need to load tm-setup when you use mime-setup.
+GNUS inserts signature after tm-edit.el composed as MIME
+message. Therefore signature inserted by GNUS is not processed as a
+valid MIME part. In particular, for multipart message, signature
+places in outside of MIME part. So MIME MUA might not display it.
-You can also set up the "automatic signature selection tool" using
-mime-setup. If you want to automatically select the signature file
-depending on how the message headers show, add lines like shown below
-to your .emacs (Refer to the reference manual of signature.el for
-more details).
+Other notice is key bind. In historical reason, key bind to insert
+signature is @key{C-c C-s} (like mh-e) instead of @key{C-c C-w}. If
+you change to GNUS's default, please set following:
@lisp
-(setq signature-file-alist
- '((("Newsgroups" . "jokes") . "~/.signature-jokes")
- (("Newsgroups" . ("zxr" "nzr")) . "~/.signature-sun")
- (("To" . ("ishimaru" "z-suzuki")) . "~/.signature-sun")
- (("To" . "tea") . "~/.signature-jokes")
- (("To" . ("sim" "oku" "takuo")) . "~/.signature-formal")
- ))
+(set-alist 'mime-setup-signature-key-alist 'news-reply-mode "\C-c\C-w")
@end lisp
-mime-setup requires mime.el. if you set up SuperCite via mime-setup,
-you need the SuperCite package also.
-
+@node tm-setup, tm-vm, mime-setup, Setting
+@comment node-name, next, previous, up
@section tm-setup
-tm-setup only sets up tm-MUAs. You do not need to explicitly load
-tm-setup if you are using mime-setup for your setup. tm-setup is useful
-when you do not want to use mime-setup but want to set up tm-MUAs.
+tm-setup.el only sets up tm-MUAs. You do not need to explicitly load
+tm-setup.el if you are using mime-setup.el for your setup.
+tm-setup.el is useful when you do not want to use mime-setup.el but
+want to set up tm-MUAs.
@lisp
(load "tm-setup")
@end lisp
+@node tm-vm, manual setting, tm-setup, Setting
+@comment node-name, next, previous, up
@section vm
-If you use vm, please insert following in .vm or .emacs.
+If you use vm, please insert following in ~/.vm:
@lisp
-(load "tm-vm")
+(require 'tm-vm)
@end lisp
+Notice: If you use BBDB, please insert @code{(require 'tm-vm)}
+@strong{after} @code{(bbdb-insinuate-vm)}.
+
-@section setting up without loading provided setup files
+@node manual setting, , tm-vm, Setting
+@comment node-name, next, previous, up
+@section Setting up without loading provided setup files
You may find the valuable hints in tm-setup.el if you want to set up
MIME environment without loading the tm-provided setup files.
-@node tm-MUA, Bug report, Setting, Top
+@node tm-MUA, tm-view, Setting, Top
@comment node-name, next, previous, up
@chapter tm-MUA
@cindex tm-MUA
The current version of tm provides the following tm-MUA.
-@itemize
+@itemize @minus
@item @strong{tm-mh-e:} tm-MUA for mh-e
@item @strong{tm-gnus:} tm-MUA for GNUS
@item @strong{tm-rmail:} tm-MUA for RMAIL
@table @kbd
@item @key{M-t}
- toggles decoding of MIME headers
+toggles decoding of MIME headers
@item @key{v}
- enters @code{mime/viewer-mode} to view a message
+enters @code{mime/viewer-mode} to view a message
@end table
Notice: In tm-vm, key to enter @code{mime/viewer-mode} is @key{Z}
-instead of @key{v}. In tm-mh-e and tm-gnus for (ding) GNUS, preview
-buffer of @code{mime/viewer-mode} is displays automatically in default
-setting.
+instead of @key{v}. In tm-mh-e, tm-vm and tm-gnus in Gnus 3.15 or
+later, preview buffer of @code{mime/viewer-mode} displays
+automatically in default setting.
@menu
* tm-mh-e: (tm-mh-e_en.info).
* tm-rmail: (tm-rmail_en.info).
* tm-vm: (tm-vm_en.info).
* tm-cmail: (tm-cmail_en.info).
-* mime/viewer-mode: (tm-view_en.info)how-to-use.
@end menu
-@node Bug report, Concept Index, tm-MUA, Top
+@include tm-view=en.texi
+
+@include tm-edit-en.texi
+
+@include tm-ew=en.texi
+
+@include tm-util=en.texi
+
+
+@node Bug report, Concept Index, customize, Top
@comment node-name, next, previous, up
@chapter How to report bug and about mailing list of tm
@cindex bug report
@cindex mailing list
-Please report tm bugs you find to fj.editor.emacs or send a mail to
-tm ML:
+Please report tm bugs you find to fj.editor.emacs or send a mail to:
@itemize @bullet
@item Japanese or English
- <tm@@chamonix.jaist.ac.jp>
+ <bug-tm-ja@@chamonix.jaist.ac.jp>
@item English
- <tm-eng@@chamonix.jaist.ac.jp>
+ <bug-tm-en@@chamonix.jaist.ac.jp>
@end itemize
Via tm ML, You can report bugs of tm, obtain the latest release of tm
send a mail to
@itemize @bullet
-@item Japanese or English
+@item Japanese
- <tm-admin@@chamonix.jaist.ac.jp>
+ <tm-ja-admin@@chamonix.jaist.ac.jp>
@item English
- <tm-eng-admin@@chamonix.jaist.ac.jp>
+ <tm-en-admin@@chamonix.jaist.ac.jp>
@end itemize
Since the user registration is manually done, please write
projects / elisp / tm.git / blobdiff