README.en

   1 [README for MEL (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.en,v 1.3 1997-04-30 12:59:46 morioka Exp $
   4
   5 What's MEL
   6 ===========
   7
   8   MEL stands for "MIME Encoding Library".  It consists of following
   9   modules:
  10
  11         mel.el   --- main module
  12         mel-b.el --- base64 (b-encoding) encoder/decoder
  13         mel-q.el --- quoted-printable and q-encoding encoder/decoder
  14         mel-u.el --- unofficial module for uuencode
  15         mel-g.el --- unofficial module for gzip64
  16
  17
  18 Installation
  19 ============
  20
  21 (0) before installing it, please install APEL package.  APEL package
  22     is available at:
  23
  24         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
  25
  26 (1-a) run in expanded place
  27
  28   If you don't want to install other directories, please do only
  29   following:
  30
  31         % make
  32
  33   You can specify the emacs command name, for example
  34
  35         % make install EMACS=xemacs
  36
  37   If `EMACS=...' is omitted, EMACS=emacs is used.
  38
  39 (1-b) make install
  40
  41   If you want to install other directories, please do following:
  42
  43         % make install
  44
  45   You can specify the emacs command name, for example
  46
  47         % make install EMACS=xemacs
  48
  49   If `EMACS=...' is omitted, EMACS=emacs is used.
  50
  51   You can specify the prefix of the directory tree for Emacs Lisp
  52   programs and shell scripts, for example:
  53
  54         % make install PREFIX=~/
  55
  56   If `PREFIX=...' is omitted, the prefix of the directory tree of the
  57   specified emacs command is used (perhaps /usr/local).
  58
  59   For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
  60   will create the following directory tree:
  61
  62         /usr/local/share/emacs/site-lisp/mel/   --- MEL
  63
  64   You can specify other optional settings by editing the file
  65   MEL-CFG.  Please read comments in it.
  66
  67
  68 load-path (for Emacs or MULE)
  69 =============================
  70
  71   If you are using Emacs or Mule, please add directory of MEL to
  72   load-path.  If you install by default setting, you can write
  73   subdirs.el for example:
  74
  75   --------------------------------------------------------------------
  76   (normal-top-level-add-to-load-path '("apel" "mel"))
  77   --------------------------------------------------------------------
  78
  79   If you are using XEmacs, there are no need of setting about
  80   load-path.
  81
  82
  83 How to use
  84 ==========
  85
  86 Region
  87 ------
  88
  89 Command mime-encode-region (START END ENCODING)
  90
  91   Encode region START to END of current buffer using ENCODING.
  92
  93 Command mime-decode-region (start end encoding)
  94
  95   Decode region START to END of current buffer using ENCODING.
  96
  97 Command base64-encode-region (start end)
  98
  99   Encode region START to END of current buffer using base64.
 100
 101 Command base64-decode-region (start end)
 102
 103   Decode region START to END of current buffer using base64.
 104
 105 Command quoted-printable-encode-region (start end)
 106
 107   Encode region START to END of current buffer using quoted-printable.
 108
 109 Command quoted-printable-decode-region (start end)
 110
 111   Decode region START to END of current buffer using quoted-printable.
 112
 113 Command uuencode-encode-region (start end)
 114
 115   Encode region START to END of current buffer using uuencode.
 116
 117 Command uuencode-decode-region (start end)
 118
 119   Decode region START to END of current buffer using uuencode.
 120
 121 Command gzip64-encode-region (start end)
 122
 123   Encode region START to END of current buffer using x-gzip64.
 124
 125 Command gzip64-decode-region (start end)
 126
 127   Decode region START to END of current buffer using x-gzip64.
 128
 129 Variable mime-encoding-method-alist
 130
 131   Alist of encoding vs. corresponding method to encode region.
 132   Each element looks like (STRING . FUNCTION) or (STRING . nil).
 133   STRING is content-transfer-encoding.
 134   FUNCTION is region encoder and nil means not to encode.
 135
 136 Variable mime-decoding-method-alist
 137
 138   Alist of encoding vs. corresponding method to decode region.
 139   Each element looks like (STRING . FUNCTION).
 140   STRING is content-transfer-encoding.
 141   FUNCTION is region decoder.
 142
 143 File
 144 ----
 145
 146 Command mime-insert-encoded-file (FILENAME ENCODING)
 147
 148   Insert file FILENAME encoded by ENCODING format.
 149
 150 Command base64-insert-encoded-file (FILENAME)
 151
 152   Insert base64 encoded file.
 153
 154 Command quoted-printable-insert-encoded-file (FILENAME)
 155
 156   Insert quoted-printable encoded file.
 157
 158 Command uuencode-insert-encoded-file (FILENAME)
 159
 160   Insert uuencode encoded file.
 161
 162 Command gzip64-insert-encoded-file (FILENAME)
 163
 164   Insert gzip64 encoded file.
 165
 166 Variable mime-file-encoding-method-alist
 167
 168   Alist of encoding vs. corresponding method to insert encoded file.
 169   Each element looks like (STRING . FUNCTION).
 170   STRING is content-transfer-encoding.
 171   FUNCTION is function to insert encoded file.
 172
 173 String
 174 ------
 175
 176 Function base64-encode-string (STRING)
 177
 178   Encode STRING to base64, and return the result.
 179
 180 Function base64-decode-string (STRING)
 181
 182   Decode STRING which is encoded in base64, and return the result.
 183
 184 Function q-encoding-encode-string (STRING &optional MODE)
 185
 186   Encode STRING as Q-encoding of encoded-word.
 187   MODE allows `text', `comment', `phrase' or nil.  Default value is
 188   `phrase'.
 189
 190 Function q-encoding-decode-string (STRING)
 191
 192   Decode STRING as Q-encoding of encoded-word.
 193
 194 Function base64-encoded-length (STRING)
 195
 196   Return length of base64 encoded STRING.
 197
 198 Function q-encoded-length (STRING &optional MODE)
 199
 200   Return length of Q-encoding encoded STRING.
 201   MODE allows `text', `comment', `phrase' or nil.  Default value is
 202   `phrase'.
 203
 204
 205 Bug reports
 206 ===========
 207
 208   If you write bug-reports and/or suggestions for improvement, please
 209   send them to the tm Mailing List:
 210
 211         bug-tm-en@chamonix.jaist.ac.jp  (English)
 212         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 213
 214   Via the tm ML, you can report tm bugs, obtain the latest release of
 215   tm, and discuss future enhancements to tm. To join the tm ML, send
 216   e-mail to
 217
 218         tm-ja-admin@chamonix.jaist.ac.jp        (Japanese)
 219         tm-en-admin@chamonix.jaist.ac.jp        (English)
 220
 221   Since the user registration is done manually, please write the mail
 222   body in human-recognizable language (^_^).