-*-tm manual-*-

tm 7.32 Reference manual
************************

This file documents tm, a MIME package for GNU Emacs.

What is tm?
***********

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

  * playback or view the MIME messages using tm-view

  * compose MIME message using tm-edit

  * use the enhanced MIME features with mh-e, GNUS, RMAIL and VM

and more.

List of modules
===============

The tm package includes the modules listed below.

  - tm-view:   MIME viewer

  - tm-edit:   MIME composer

  - tm-def:    definition module for tm

  - tm-mh-e:  tm-MUA for mh-e

  - tm-gnus:  tm-MUA for GNUS

  - tm-rmail: tm-MUA for RMAIL

  - tm-vm:    tm-MUA for VM

  - tm-setup: tm-MUA setup module

  - mime-setup: MIME setup module

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, 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 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 inline image.

Setting
*******

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.

mime-setup.el
=============

     (load "mime-setup")

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.

variable of mime-setup.el
-------------------------

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

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

     (load "tm-setup")

vm
==

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

     (require 'tm-vm)

Notice: If you use BBDB, please insert (require 'tm-vm) after (bbdb-insinuate-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.

  - tm-mh-e:  tm-MUA for mh-e

  - tm-gnus:  tm-MUA for GNUS

  - tm-rmail: tm-MUA for RMAIL

  - tm-vm:    tm-MUA for VM

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, tm-vm and tm-gnus in Gnus 3.15 or later, preview buffer of mime/viewer-mode displays automatically in default setting.

     [file tm-view=en.texi not included]

     [file tm-edit-en.texi not included]

     [file tm-ew=en.texi not included]

     [file tm-util=en.texi not included]

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:

  * Japanese or English

     <bug-tm-ja@chamonix.jaist.ac.jp>

  * English

     <bug-tm-en@chamonix.jaist.ac.jp>

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

  * Japanese

     <tm-ja-admin@chamonix.jaist.ac.jp>

  * English

     <tm-en-admin@chamonix.jaist.ac.jp>

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