README.en

   1 [README for MEL (English Version)]
   2 by MORIOKA Tomohiko <morioka@jaist.ac.jp>
   3 $Id: README.en,v 1.8 1997-05-15 05:43:48 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 site-lisp directory, for example
  65
  66         % make install LISPDIR=~/share/emacs/lisp
  67
  68   If `LISPDIR=...' is omitted, site-lisp directory of the specified
  69   emacs command is used (perhaps /usr/local/share/emacs/site-lisp or
  70   /usr/local/lib/xemacs/site-lisp).
  71
  72   You can specify other optional settings by editing the file
  73   MEL-CFG.  Please read comments in it.
  74
  75
  76 load-path (for Emacs or MULE)
  77 =============================
  78
  79   If you are using Emacs or Mule, please add directory of MEL to
  80   load-path.  If you install by default setting, you can write
  81   subdirs.el for example:
  82
  83   --------------------------------------------------------------------
  84   (normal-top-level-add-to-load-path '("apel" "mel"))
  85   --------------------------------------------------------------------
  86
  87   If you are using XEmacs, there are no need of setting about
  88   load-path.
  89
  90
  91 How to use
  92 ==========
  93
  94 Region
  95 ------
  96
  97 Command mime-encode-region (START END ENCODING)
  98
  99   Encode region START to END of current buffer using ENCODING.
 100
 101 Command mime-decode-region (start end encoding)
 102
 103   Decode region START to END of current buffer using ENCODING.
 104
 105 Command base64-encode-region (start end)
 106
 107   Encode current region by base64.
 108   START and END are buffer positions.
 109
 110   This function calls internal base64 encoder if size of region is
 111   smaller than `base64-internal-encoding-limit', otherwise it calls
 112   external base64 encoder specified by `base64-external-encoder'.  In
 113   this case, you must install the program (maybe mmencode included in
 114   metamail or XEmacs package).
 115
 116 Command base64-decode-region (start end)
 117
 118   Decode current region by base64.
 119   START and END are buffer positions.
 120
 121   This function calls internal base64 decoder if size of region is
 122   smaller than `base64-internal-decoding-limit', otherwise it calls
 123   external base64 decoder specified by `base64-external-decoder'.  In
 124   this case, you must install the program (maybe mmencode included in
 125   metamail or XEmacs package).
 126
 127 Command quoted-printable-encode-region (start end)
 128
 129   Encode current region by quoted-printable.
 130   START and END are buffer positions.
 131
 132   This function calls internal quoted-printable encoder if size of
 133   region is smaller than `quoted-printable-internal-encoding-limit',
 134   otherwise it calls external quoted-printable encoder specified by
 135   `quoted-printable-external-encoder'.  In this case, you must install
 136   the program (maybe mmencode included in metamail or XEmacs package).
 137
 138 Command quoted-printable-decode-region (start end)
 139
 140   Decode current region by quoted-printable.
 141   START and END are buffer positions.
 142
 143   This function calls internal quoted-printable decoder if size of
 144   region is smaller than `quoted-printable-internal-decoding-limit',
 145   otherwise it calls external quoted-printable decoder specified by
 146   `quoted-printable-external-decoder'.  In this case, you must install
 147   the program (maybe mmencode included in metamail or XEmacs package).
 148
 149 Command uuencode-encode-region (start end)
 150
 151   Encode region START to END of current buffer using uuencode.
 152
 153 Command uuencode-decode-region (start end)
 154
 155   Decode region START to END of current buffer using uuencode.
 156
 157 Command gzip64-encode-region (start end)
 158
 159   Encode region START to END of current buffer using x-gzip64.
 160
 161 Command gzip64-decode-region (start end)
 162
 163   Decode region START to END of current buffer using x-gzip64.
 164
 165 Variable mime-encoding-method-alist
 166
 167   Alist of encoding vs. corresponding method to encode region.
 168   Each element looks like (STRING . FUNCTION) or (STRING . nil).
 169   STRING is content-transfer-encoding.
 170   FUNCTION is region encoder and nil means not to encode.
 171
 172 Variable mime-decoding-method-alist
 173
 174   Alist of encoding vs. corresponding method to decode region.
 175   Each element looks like (STRING . FUNCTION).
 176   STRING is content-transfer-encoding.
 177   FUNCTION is region decoder.
 178
 179 File
 180 ----
 181
 182 Command mime-insert-encoded-file (FILENAME ENCODING)
 183
 184   Insert file FILENAME encoded by ENCODING format.
 185
 186 Command base64-insert-encoded-file (FILENAME)
 187
 188   Encode contents of file FILENAME to base64, and insert the result.
 189
 190   It calls external base64 encoder specified by
 191   `base64-external-encoder'.  So you must install the program (maybe
 192   mmencode included in metamail or XEmacs package).
 193
 194 Command quoted-printable-insert-encoded-file (FILENAME)
 195
 196   Insert quoted-printable encoded file.
 197
 198 Command uuencode-insert-encoded-file (FILENAME)
 199
 200   Insert uuencode encoded file.
 201
 202 Command gzip64-insert-encoded-file (FILENAME)
 203
 204   Insert gzip64 encoded file.
 205
 206 Variable mime-file-encoding-method-alist
 207
 208   Alist of encoding vs. corresponding method to insert encoded file.
 209   Each element looks like (STRING . FUNCTION).
 210   STRING is content-transfer-encoding.
 211   FUNCTION is function to insert encoded file.
 212
 213 String
 214 ------
 215
 216 Function base64-encode-string (STRING)
 217
 218   Encode STRING to base64, and return the result.
 219
 220 Function base64-decode-string (STRING)
 221
 222   Decode STRING which is encoded in base64, and return the result.
 223
 224 Function q-encoding-encode-string (STRING &optional MODE)
 225
 226   Encode STRING to Q-encoding of encoded-word, and return the result.
 227   MODE allows `text', `comment', `phrase' or nil.  Default value is
 228   `phrase'.
 229
 230 Function q-encoding-decode-string (STRING)
 231
 232   Decode STRING which is encoded in Q-encoding and return the result.
 233
 234 Function base64-encoded-length (STRING)
 235
 236   Return length of base64 encoded STRING.
 237
 238 Function q-encoded-length (STRING &optional MODE)
 239
 240   Return length of Q-encoding encoded STRING.
 241   MODE allows `text', `comment', `phrase' or nil.  Default value is
 242   `phrase'.
 243
 244
 245 Bug reports
 246 ===========
 247
 248   If you write bug-reports and/or suggestions for improvement, please
 249   send them to the tm Mailing List:
 250
 251         bug-tm-en@chamonix.jaist.ac.jp  (English)
 252         bug-tm-ja@chamonix.jaist.ac.jp  (Japanese)
 253
 254   Via the tm ML, you can report tm bugs, obtain the latest release of
 255   tm, and discuss future enhancements to tm. To join the tm ML, send
 256   e-mail to
 257
 258         tm-ja-admin@chamonix.jaist.ac.jp        (Japanese)
 259         tm-en-admin@chamonix.jaist.ac.jp        (English)
 260
 261   Since the user registration is done manually, please write the mail
 262   body in human-recognizable language (^_^).