tm 7.10.
[elisp/tm.git] / doc / tm_en.texi
index 883dd8f..77da73b 100644 (file)
@@ -6,7 +6,7 @@
 @titlepage
 @title tm Manual (English Version)
 @author by MORIOKA Tomohiko
-@code{$Id: tm_en.texi,v 6.4 1995/09/06 03:51:39 morioka Exp $}
+@code{$Id: tm_en.texi,v 7.0 1995/10/04 15:16:13 morioka Exp $}
 @end titlepage
 
 
@@ -189,12 +189,23 @@ Or copy *.el to your emacs lisp directory.
 @chapter Setting
 @cindex 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, while tm-setup is used to set up tm-MUA
-only.
+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.
+
+@menu
+* mime-setup::
+* tm-setup::
+* tm-vm::
+* manual setting::
+@end menu
 
-@section mime-setup
+
+@node mime-setup, tm-setup, Setting, Setting
+@comment  node-name,  next,  previous,  up
+@section mime-setup.el
+@cindex mime-setup.el
 
 @lisp
 (load "mime-setup")
@@ -203,11 +214,36 @@ only.
 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.
 
-You can also set up the "automatic signature selection tool" using
-mime-setup.  If you want to automatically select the signature file
+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:
+
+@example
+       ftp://ftp.kyutech.ac.jp/pub/MultiMedia/mime
+       ftp://ftp.jaist.ac.jp/pub/GNU/elisp/mime
+@end example
+
+
+@subsection SuperCite
+@cindex SuperCite
+
+@defvar 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.
+@end defvar
+
+
+@subsection 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).
+to your .emacs (Refer to the reference manual of signature.el for more
+details).
 
 @lisp
 (setq signature-file-alist
@@ -219,10 +255,64 @@ more details).
         ))
 @end lisp
 
-mime-setup requires mime.el. if you set up SuperCite via mime-setup,
-you need the SuperCite package also.
 
+@defvar mime-setup-use-signature
+
+If it is not nil, mime-setup.el sets up for signature.el. Its default
+value is t.
+@end defvar
+
+
+@defvar mime-setup-signature-key-alist
+
+It defines key to bind signature inserting command for each
+major-mode. Its default value is following:
+
+@lisp
+       ((mail-mode . "\C-c\C-w"))
+@end lisp
 
+If you want to change, please rewrite it. For example:
+
+@lisp
+(set-alist 'mime-setup-signature-key-alist 'news-reply-mode "\C-c\C-w")
+@end lisp
+
+@end defvar
+
+
+@defvar 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''.
+@end defvar
+
+
+@subsection Notices for GNUS
+@cindex GNUS
+
+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:
+
+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 @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
+(set-alist 'mime-setup-signature-key-alist 'news-reply-mode "\C-c\C-w")
+@end lisp
+
+
+@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
@@ -234,16 +324,20 @@ when you do not want to use mime-setup but want to set up tm-MUAs.
 @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")
 @end lisp
 
 
-@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.