tm Manual (English Version)

What is tm?

The tm package is a set of modules to enjoy MIME on GNU Emacs. Using tm, you can

and more.

List of modules

The tm package includes the modules listed below.

Considerations for each emacs variants

original GNU Emacs 18

I can not guarantee, but you may use US-ASCII only.

NEmacs, NEpoch

ISO-2022-JP and US-ASCII can be used if you use NEmacs.

original GNU Emacs 19

US-ASCII and ISO-8859-1 can be used if you use the original Emacs 19.*.

When emacs is running with own window in X window environment, tm-rich displays multi face for text/richtext and text/enriched richtext messages.

Mule

Mule can handle the multi-lingual text. With Mule, tiny-mime 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 function.

When Mule 2.* is running with own window in X window environment, tm-rich displays multi face for text/richtext and text/enriched richtext messages.

XEmacs

US-ASCII and ISO-8859-1 can be used if you use the XEmacs.

In future, we will support multi face and inline image.

Install

You can install tm by following the procedures below.

tl install

tm requires the Emacs Lisp library "tl", so please install this at first.

How to install tl is written in tl/README.eng.

Makefile

Please modify Makefile to your environment.

Specification executable file name of emacs

Please specify executable file name of emacs.

Specification load-path

Please specify directory to install Emacs Lisp program.

External method

Please modify method script in tm/methods/ to your environment.

make

Run `make all'.

install

Run `make install'.

install Emacs Lisp program

Run `make install-nemacs', if you use NEmacs or NEpoch.

Run `make install-mule1', if you use Mule 1.* (based on Emacs 18.*).

Run `make install-orig19', if you use Original Emacs 19.* or XEmacs.

Run `make install-mule2', if you use Mule 2.* (based on Emacs 19.*).

Or copy *.el to your emacs lisp directory.

Setting

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 using mime.el, while tm-setup is used to set up tm-MUA only.

mime-setup.el

(load "mime-setup")

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.

mime-setup.el requires mime.el. mime.el is included in emacs-mime-tools.shar. It is available lots of anonymous-ftp sites, for example:

	ftp://ftp.kyutech.ac.jp/pub/MultiMedia/mime
	ftp://ftp.jaist.ac.jp/pub/GNU/elisp/mime

SuperCite

Variable: mime-setup-use-sc

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.

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).

(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")
        ))

Variable: mime-setup-use-signature

If it is not nil, mime-setup.el sets up for signature.el. Its default value is t.

Variable: mime-setup-signature-key-alist

It defines key to bind signature inserting command for each major-mode. Its default value is following:

	((mail-mode . "\C-c\C-w"))

If you want to change, please rewrite it. For example:

(set-alist 'mime-setup-signature-key-alist 'news-reply-mode "\C-c\C-w")

Variable: mime-setup-default-signature-key

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".

Notices for GNUS

When mime-setup.el sets up for signature.el, it sets variable gnus-signature-file to nil. Therefore GNUS does not insert signature automatically when it is sending a message. Reason of this setting is following:

GNUS inserts signature after mime.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.

Other notice is key bind. In historical reason, key bind to insert signature is C-c C-s (like mh-e) instead of C-c C-w. If you change to GNUS's default, please set following:

(set-alist 'mime-setup-signature-key-alist 'news-reply-mode "\C-c\C-w")

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.

(load "tm-setup")

vm

If you use vm, please insert following in .vm:

(load "tm-vm")

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.

tm-MUA

"tm-MUA" is a generic name of the modules which enhance the MIME functions of MUA like mh-e, GNUS, and RMAIL etc.

The current version of tm provides the following tm-MUA.

You can find the detailed explanations of these modules in the following sections.

Summary mode

If you are using tm-MUA, the following functions are added to the Summary mode of the MUA.

M-t
toggles decoding of MIME headers
v
enters mime/viewer-mode to view a message

Notice: In tm-vm, key to enter mime/viewer-mode is Z instead of v. In tm-mh-e and tm-gnus for (ding) GNUS, preview buffer of mime/viewer-mode is displays automatically in default setting.

How to report bug and about mailing list of tm

Please report tm bugs you find to fj.editor.emacs or send a mail to tm ML:

Via tm ML, You can report bugs of tm, obtain the latest release of tm package, and discuss the future enhancements to tm. To join tm ML, send a mail to

Since the user registration is manually done, please write the mail body in human-recognizable language. (^_^)

Concept Index

b

  • bug report
  • c

  • Considerations for each emacs variants
  • g

  • GNUS
  • i

  • Install
  • l

  • List of modules
  • m

  • mailing list
  • mime-setup.el
  • s

  • Setting
  • signature
  • SuperCite
  • t

  • tm
  • tm-MUA
  • Command and Function Index

    Variable Index

    m

  • mime-setup-default-signature-key
  • mime-setup-signature-key-alist
  • mime-setup-use-sc
  • mime-setup-use-signature