README.en

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