README.en

   1 [README for MEL (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.en,v 1.5 1997-04-30 13:25:15 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 current region by base64.
 100   START and END are buffer positions.
 101
 102   This function calls internal base64 encoder if size of region is
 103   smaller than `base64-internal-encoding-limit', otherwise it calls
 104   external base64 encoder specified by `base64-external-encoder'.  In
 105   this case, you must install the program (maybe mmencode included in
 106   metamail or XEmacs package).
 107
 108 Command base64-decode-region (start end)
 109
 110   Decode current region by base64.
 111   START and END are buffer positions.
 112
 113   This function calls internal base64 decoder if size of region is
 114   smaller than `base64-internal-decoding-limit', otherwise it calls
 115   external base64 decoder specified by `base64-external-decoder'.  In
 116   this case, you must install the program (maybe mmencode included in
 117   metamail or XEmacs package).
 118
 119 Command quoted-printable-encode-region (start end)
 120
 121   Encode region START to END of current buffer using quoted-printable.
 122
 123 Command quoted-printable-decode-region (start end)
 124
 125   Decode region START to END of current buffer using quoted-printable.
 126
 127 Command uuencode-encode-region (start end)
 128
 129   Encode region START to END of current buffer using uuencode.
 130
 131 Command uuencode-decode-region (start end)
 132
 133   Decode region START to END of current buffer using uuencode.
 134
 135 Command gzip64-encode-region (start end)
 136
 137   Encode region START to END of current buffer using x-gzip64.
 138
 139 Command gzip64-decode-region (start end)
 140
 141   Decode region START to END of current buffer using x-gzip64.
 142
 143 Variable mime-encoding-method-alist
 144
 145   Alist of encoding vs. corresponding method to encode region.
 146   Each element looks like (STRING . FUNCTION) or (STRING . nil).
 147   STRING is content-transfer-encoding.
 148   FUNCTION is region encoder and nil means not to encode.
 149
 150 Variable mime-decoding-method-alist
 151
 152   Alist of encoding vs. corresponding method to decode region.
 153   Each element looks like (STRING . FUNCTION).
 154   STRING is content-transfer-encoding.
 155   FUNCTION is region decoder.
 156
 157 File
 158 ----
 159
 160 Command mime-insert-encoded-file (FILENAME ENCODING)
 161
 162   Insert file FILENAME encoded by ENCODING format.
 163
 164 Command base64-insert-encoded-file (FILENAME)
 165
 166   Encode contents of file FILENAME to base64, and insert the result.
 167
 168   It calls external base64 encoder specified by
 169   `base64-external-encoder'.  So you must install the program (maybe
 170   mmencode included in metamail or XEmacs package).
 171
 172 Command quoted-printable-insert-encoded-file (FILENAME)
 173
 174   Insert quoted-printable encoded file.
 175
 176 Command uuencode-insert-encoded-file (FILENAME)
 177
 178   Insert uuencode encoded file.
 179
 180 Command gzip64-insert-encoded-file (FILENAME)
 181
 182   Insert gzip64 encoded file.
 183
 184 Variable mime-file-encoding-method-alist
 185
 186   Alist of encoding vs. corresponding method to insert encoded file.
 187   Each element looks like (STRING . FUNCTION).
 188   STRING is content-transfer-encoding.
 189   FUNCTION is function to insert encoded file.
 190
 191 String
 192 ------
 193
 194 Function base64-encode-string (STRING)
 195
 196   Encode STRING to base64, and return the result.
 197
 198 Function base64-decode-string (STRING)
 199
 200   Decode STRING which is encoded in base64, and return the result.
 201
 202 Function q-encoding-encode-string (STRING &optional MODE)
 203
 204   Encode STRING as Q-encoding of encoded-word.
 205   MODE allows `text', `comment', `phrase' or nil.  Default value is
 206   `phrase'.
 207
 208 Function q-encoding-decode-string (STRING)
 209
 210   Decode STRING as Q-encoding of encoded-word.
 211
 212 Function base64-encoded-length (STRING)
 213
 214   Return length of base64 encoded STRING.
 215
 216 Function q-encoded-length (STRING &optional MODE)
 217
 218   Return length of Q-encoding encoded STRING.
 219   MODE allows `text', `comment', `phrase' or nil.  Default value is
 220   `phrase'.
 221
 222
 223 Bug reports
 224 ===========
 225
 226   If you write bug-reports and/or suggestions for improvement, please
 227   send them to the tm Mailing List:
 228
 229         bug-tm-en@chamonix.jaist.ac.jp  (English)
 230         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 231
 232   Via the tm ML, you can report tm bugs, obtain the latest release of
 233   tm, and discuss future enhancements to tm. To join the tm ML, send
 234   e-mail to
 235
 236         tm-ja-admin@chamonix.jaist.ac.jp        (Japanese)
 237         tm-en-admin@chamonix.jaist.ac.jp        (English)
 238
 239   Since the user registration is done manually, please write the mail
 240   body in human-recognizable language (^_^).