README.en

   1 [README for MEL (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.en,v 1.10 1998-03-08 22:44:00 shuhei-k 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-dl.el --- base64 (b-encoding) encoder/decoder
  13                       (for Emacs 20 with dynamic loading support)
  14         mel-b.el  --- base64 (b-encoding) encoder/decoder
  15                       (for other emacsen)
  16         mel-q.el  --- quoted-printable and q-encoding encoder/decoder
  17         mel-u.el  --- unofficial module for uuencode
  18         mel-g.el  --- unofficial module for gzip64
  19
  20
  21 Installation
  22 ============
  23
  24 (0) before installing it, please install APEL package.  APEL package
  25     is available at:
  26
  27         ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/
  28
  29 (1-a) run in expanded place
  30
  31   If you don't want to install other directories, please do only
  32   following:
  33
  34         % make
  35
  36   You can specify the emacs command name, for example
  37
  38         % make install EMACS=xemacs
  39
  40   If `EMACS=...' is omitted, EMACS=emacs is used.
  41
  42 (1-b) make install
  43
  44   If you want to install other directories, please do following:
  45
  46         % make install
  47
  48   You can specify the emacs command name, for example
  49
  50         % make install EMACS=xemacs
  51
  52   If `EMACS=...' is omitted, EMACS=emacs is used.
  53
  54   You can specify the prefix of the directory tree for Emacs Lisp
  55   programs and shell scripts, for example:
  56
  57         % make install PREFIX=~/
  58
  59   If `PREFIX=...' is omitted, the prefix of the directory tree of the
  60   specified emacs command is used (perhaps /usr/local).
  61
  62   For example, if PREFIX=/usr/local and EMACS 19.34 is specified, it
  63   will create the following directory tree:
  64
  65         /usr/local/share/emacs/site-lisp/mel/   --- MEL
  66
  67   You can specify site-lisp directory, for example
  68
  69         % make install LISPDIR=~/share/emacs/lisp
  70
  71   If `LISPDIR=...' is omitted, site-lisp directory of the specified
  72   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
  73   /usr/local/lib/xemacs/site-lisp).
  74
  75   You can specify other optional settings by editing the file
  76   MEL-CFG.  Please read comments in it.
  77
  78
  79 load-path (for Emacs or MULE)
  80 =============================
  81
  82   If you are using Emacs or Mule, please add directory of MEL to
  83   load-path.  If you install by default setting, you can write
  84   subdirs.el for example:
  85
  86   --------------------------------------------------------------------
  87   (normal-top-level-add-to-load-path '("apel" "mel"))
  88   --------------------------------------------------------------------
  89
  90   If you are using XEmacs, there are no need of setting about
  91   load-path.
  92
  93
  94 How to use
  95 ==========
  96
  97 Region
  98 ------
  99
 100 Command mime-encode-region (START END ENCODING)
 101
 102   Encode region START to END of current buffer using ENCODING.
 103
 104 Command mime-decode-region (start end encoding)
 105
 106   Decode region START to END of current buffer using ENCODING.
 107
 108 Command base64-encode-region (start end)
 109
 110   Encode current region by base64.
 111   START and END are buffer positions.
 112
 113   This function calls internal base64 encoder if size of region is
 114   smaller than `base64-internal-encoding-limit', otherwise it calls
 115   external base64 encoder specified by `base64-external-encoder'.  In
 116   this case, you must install the program (maybe mmencode included in
 117   metamail or XEmacs package).
 118
 119 Command base64-decode-region (start end)
 120
 121   Decode current region by base64.
 122   START and END are buffer positions.
 123
 124   This function calls internal base64 decoder if size of region is
 125   smaller than `base64-internal-decoding-limit', otherwise it calls
 126   external base64 decoder specified by `base64-external-decoder'.  In
 127   this case, you must install the program (maybe mmencode included in
 128   metamail or XEmacs package).
 129
 130 Command quoted-printable-encode-region (start end)
 131
 132   Encode current region by quoted-printable.
 133   START and END are buffer positions.
 134
 135   This function calls internal quoted-printable encoder if size of
 136   region is smaller than `quoted-printable-internal-encoding-limit',
 137   otherwise it calls external quoted-printable encoder specified by
 138   `quoted-printable-external-encoder'.  In this case, you must install
 139   the program (maybe mmencode included in metamail or XEmacs package).
 140
 141 Command quoted-printable-decode-region (start end)
 142
 143   Decode current region by quoted-printable.
 144   START and END are buffer positions.
 145
 146   This function calls internal quoted-printable decoder if size of
 147   region is smaller than `quoted-printable-internal-decoding-limit',
 148   otherwise it calls external quoted-printable decoder specified by
 149   `quoted-printable-external-decoder'.  In this case, you must install
 150   the program (maybe mmencode included in metamail or XEmacs package).
 151
 152 Command uuencode-encode-region (start end)
 153
 154   Encode region START to END of current buffer using uuencode.
 155
 156 Command uuencode-decode-region (start end)
 157
 158   Decode region START to END of current buffer using uuencode.
 159
 160 Command gzip64-encode-region (start end)
 161
 162   Encode region START to END of current buffer using x-gzip64.
 163
 164 Command gzip64-decode-region (start end)
 165
 166   Decode region START to END of current buffer using x-gzip64.
 167
 168 Variable mime-encoding-method-alist
 169
 170   Alist of encoding vs. corresponding method to encode region.
 171   Each element looks like (STRING . FUNCTION) or (STRING . nil).
 172   STRING is content-transfer-encoding.
 173   FUNCTION is region encoder and nil means not to encode.
 174
 175 Variable mime-decoding-method-alist
 176
 177   Alist of encoding vs. corresponding method to decode region.
 178   Each element looks like (STRING . FUNCTION).
 179   STRING is content-transfer-encoding.
 180   FUNCTION is region decoder.
 181
 182 File
 183 ----
 184
 185 Command mime-insert-encoded-file (FILENAME ENCODING)
 186
 187   Insert file FILENAME encoded by ENCODING format.
 188
 189 Command base64-insert-encoded-file (FILENAME)
 190
 191   Encode contents of file FILENAME to base64, and insert the result.
 192
 193   It calls external base64 encoder specified by
 194   `base64-external-encoder'.  So you must install the program (maybe
 195   mmencode included in metamail or XEmacs package).
 196
 197 Command quoted-printable-insert-encoded-file (FILENAME)
 198
 199   Insert quoted-printable encoded file.
 200
 201 Command uuencode-insert-encoded-file (FILENAME)
 202
 203   Insert uuencode encoded file.
 204
 205 Command gzip64-insert-encoded-file (FILENAME)
 206
 207   Insert gzip64 encoded file.
 208
 209 Variable mime-file-encoding-method-alist
 210
 211   Alist of encoding vs. corresponding method to insert encoded file.
 212   Each element looks like (STRING . FUNCTION).
 213   STRING is content-transfer-encoding.
 214   FUNCTION is function to insert encoded file.
 215
 216 String
 217 ------
 218
 219 Function base64-encode-string (STRING)
 220
 221   Encode STRING to base64, and return the result.
 222
 223 Function base64-decode-string (STRING)
 224
 225   Decode STRING which is encoded in base64, and return the result.
 226
 227 Function q-encoding-encode-string (STRING &optional MODE)
 228
 229   Encode STRING to Q-encoding of encoded-word, and return the result.
 230   MODE allows `text', `comment', `phrase' or nil.  Default value is
 231   `phrase'.
 232
 233 Function q-encoding-decode-string (STRING)
 234
 235   Decode STRING which is encoded in Q-encoding and return the result.
 236
 237 Function base64-encoded-length (STRING)
 238
 239   Return length of base64 encoded STRING.
 240
 241 Function q-encoded-length (STRING &optional MODE)
 242
 243   Return length of Q-encoding encoded STRING.
 244   MODE allows `text', `comment', `phrase' or nil.  Default value is
 245   `phrase'.
 246
 247
 248 Bug reports
 249 ===========
 250
 251   If you write bug-reports and/or suggestions for improvement, please
 252   send them to the tm Mailing List:
 253
 254         bug-tm-en@chamonix.jaist.ac.jp  (English)
 255         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 256
 257   Via the tm ML, you can report MEL bugs, obtain the latest release of
 258   MEL, and discuss future enhancements to MEL. To join the tm ML, send
 259   an empty e-mail to
 260
 261         tm-en-help@chamonix.jaist.ac.jp (English)
 262         tm-ja-help@chamonix.jaist.ac.jp (Japanese)