tm 7.80.
[elisp/tm.git] / tiny-mime-eng.ol
1 [[R
2 \title{tiny-mime manual (English Version)}
3 \author{Morioka Tomohiko}
4 \date{1994/8/4}
5 \maketitle
6 ]]R
7
8 * Overview
9
10   tiny-mime is a multilingual MIME style message header
11 encoder/decoder based on RFC 1522 for Mule, NEmacs, and NEpoch. I
12 modified Mr.Enami's ISO-2022-JP Base64 MIME header decoder and make
13 it. Mr.Enami's program can decode only ISO-2022-JP Base64 header. But,
14 current tiny-mime has following functions:
15
16  - unfolding at decoding
17  - encoding/decoding multilingual character sets, such as,
18    ISO-2022-JP, ISO-2022-JP-2, ISO-2022-CN, ISO-2022-KR, ISO-8859-*,
19    US-ASCII, EUC-KR
20  - B and Q-encoding
21
22
23 * character set and encoding
24
25 ** Mule
26
27   Mule can use multilingual text, so in Mule, tiny-mime supports
28 ISO-2022-JP, ISO-2022-JP-2, US-ASCII, ISO-8859-1..9, ISO-2022-CN,
29 ISO-2022-KR, EUC-KR, et al.
30
31   Additionally, you can add or change encoding/decoding for character
32 sets by function mime/set-charset-and-encoding.
33
34 ** NEmacs and NEpoch
35
36   NEmacs can use Japanese and English only, so in NEmacs, tiny-mime
37 supports encoding/decoding only ISO-2022-JP and US-ASCII.
38
39   And decoding ISO-8859-* encoded-words if they includes only ASCII.
40
41
42 * How to use tiny-mime.el (simple way)
43
44 ** decoding
45
46   Please load tiny-mime.el, and do following command on the buffer
47 which you want to decode.
48
49         M-x mime/decode-message-header
50
51   And you can decode region by
52
53         M-x mime/decode-region
54
55 ** encoding
56
57   Please load tiny-mime.el, and do following command on the buffer
58 which you want to encode.
59
60         M-x mime/encode-message-header
61
62
63
64 * variables
65
66 ** mime/no-encoding-header-fields
67
68   You can specify list of fields which you don't want to
69 encode. Default value is ("X-Nsubject").
70
71 example: don't encode Subject and X-Nsubject fields
72
73 [[E
74 ----------------------------------------------------------------------
75 (setq mime/no-encoding-header-fields '("X-Nsubject" "Subject"))
76 ----------------------------------------------------------------------
77 ]]E
78
79
80 * How to add or change character sets
81
82   In Mule, you can add or change character sets by function
83 mime/set-charset-and-encoding.
84
85   Function: mime/set-charset-and-encoding lc cs charset encoding
86
87         lc: leading-char
88         cs: coding-system. Please specify nil if you don't want to use
89             coding-system for 1 octet character.
90         charset: MIME character set
91         encoding: encoding method for encoder
92
93
94 example 1: encode EUC-KR B encoding for KS C5601-1987 characters
95
96         (mime/set-charset-and-encoding lc-kr *euc-kr* "EUC-KR" "B")
97
98
99 example 2: encode/decode koi8-r Q encoding
100
101         (mime/set-charset-and-encoding lc-prv11 nil "KOI8-R" "Q")
102
103 [WARNING] In this version, handling for private character is very ad
104 hoc.  (^_^; I want to improve.