X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=README.en;h=da9875de269a790f75e84eb5ea084733ddcfe5db;hb=4727809b0b568e24ae94c1d6bdb4354b37959739;hp=fcf3fee127a30c6550d03d4f72aa359a57a5d6fb;hpb=f7e4ab409c9dfd91820aef59071ff8055711d3af;p=elisp%2Fflim.git diff --git a/README.en b/README.en index fcf3fee..da9875d 100644 --- a/README.en +++ b/README.en @@ -1,4 +1,5 @@ [README for FLIM (English Version)] +by MORIOKA Tomohiko What's FLIM =========== @@ -9,36 +10,44 @@ What's FLIM std11.el --- STD 11 (RFC 822) parser and utility - mime-def.el --- Definitions about MIME format + mime.el --- to provide various services about MIME-entities - MEL: MIME encoder/decoder - mel.el --- main module - mel-dl.el --- base64 (b-encoding) encoder/decoder - (for Emacs 20 with dynamic loading support) - mel-b.el --- base64 (b-encoding) encoder/decoder - (for other emacsen) - mel-q.el --- quoted-printable and q-encoding encoder/decoder - mel-u.el --- unofficial module for uuencode - mel-g.el --- unofficial module for gzip64 + mime-def.el --- Definitions about MIME format - eword: encoded-word encoder/decoder - eword-decode.el --- encoded-word decoder - eword-encode.el --- encoded-word encoder + mime-parse.el --- MIME parser - mime-lib.el --- MIME entity library + mel.el --- MIME encoder/decoder + mel-b-dl.el --- base64 (B-encoding) encoder/decoder + (for Emacs 20 with dynamic loading support) + mel-b-ccl.el --- base64 (B-encoding) encoder/decoder + (using CCL) + mel-b-en.el --- base64 (B-encoding) encoder/decoder + (for other emacsen) + mel-q-ccl.el --- quoted-printable and Q-encoding + encoder/decoder (using CCL) + mel-q.el --- quoted-printable and Q-encoding + encoder/decoder + mel-u.el --- unofficial backend for uuencode + mel-g.el --- unofficial backend for gzip64 - mime-parse.el --- MIME parser + eword-decode.el --- encoded-word decoder + eword-encode.el --- encoded-word encoder mailcap.el --- mailcap parser and utility + This library should work on: + + Emacs 20.4 and up + XEmacs 21.1 and up + Installation ============ -(0) before installing it, please install APEL package. APEL package - is available at: +(0) before installing it, please install APEL (9.22 or later) package. + APEL package is available at: - ftp://ftp.jaist.ac.jp/pub/GNU/elisp/apel/ + ftp://ftp.m17n.org/pub/mule/apel/ (1-a) run in expanded place @@ -49,7 +58,7 @@ Installation You can specify the emacs command name, for example - % make install EMACS=xemacs + % make EMACS=xemacs If `EMACS=...' is omitted, EMACS=emacs is used. @@ -66,7 +75,7 @@ Installation If `EMACS=...' is omitted, EMACS=emacs is used. You can specify the prefix of the directory tree for Emacs Lisp - programs and shell scripts, for example: + programs, for example: % make install PREFIX=~/ @@ -86,191 +95,55 @@ Installation emacs command is used (perhaps /usr/local/share/emacs/site-lisp or /usr/local/lib/xemacs/site-lisp). - You can specify other optional settings by editing the file - FLIM-CFG. Please read comments in it. - - -load-path (for Emacs or MULE) -============================= - - If you are using Emacs or Mule, please add directory of FLIM to - load-path. If you install by default setting, you can write - subdirs.el for example: - - -------------------------------------------------------------------- - (normal-top-level-add-to-load-path '("apel" "flim")) - -------------------------------------------------------------------- - - If you are using XEmacs, there are no need of setting about - load-path. - - -How to use -========== - -Region ------- - -Command mime-encode-region (START END ENCODING) - - Encode region START to END of current buffer using ENCODING. - -Command mime-decode-region (start end encoding) - - Decode region START to END of current buffer using ENCODING. - -Command base64-encode-region (start end) - - Encode current region by base64. - START and END are buffer positions. - - This function calls internal base64 encoder if size of region is - smaller than `base64-internal-encoding-limit', otherwise it calls - external base64 encoder specified by `base64-external-encoder'. In - this case, you must install the program (maybe mmencode included in - metamail or XEmacs package). - -Command base64-decode-region (start end) - - Decode current region by base64. - START and END are buffer positions. - - This function calls internal base64 decoder if size of region is - smaller than `base64-internal-decoding-limit', otherwise it calls - external base64 decoder specified by `base64-external-decoder'. In - this case, you must install the program (maybe mmencode included in - metamail or XEmacs package). - -Command quoted-printable-encode-region (start end) - - Encode current region by quoted-printable. - START and END are buffer positions. - - This function calls internal quoted-printable encoder if size of - region is smaller than `quoted-printable-internal-encoding-limit', - otherwise it calls external quoted-printable encoder specified by - `quoted-printable-external-encoder'. In this case, you must install - the program (maybe mmencode included in metamail or XEmacs package). - -Command quoted-printable-decode-region (start end) - - Decode current region by quoted-printable. - START and END are buffer positions. - - This function calls internal quoted-printable decoder if size of - region is smaller than `quoted-printable-internal-decoding-limit', - otherwise it calls external quoted-printable decoder specified by - `quoted-printable-external-decoder'. In this case, you must install - the program (maybe mmencode included in metamail or XEmacs package). + If the emu modules (included in APEL package) have been installed in + the non-standard directory, you should specify where they will be + found, for example: -Command uuencode-encode-region (start end) + % make install VERSION_SPECIFIC_LISPDIR=~/elisp - Encode region START to END of current buffer using uuencode. + Following make target is available to find what files are parts of + emu / APEL package, and where are directories to install them: -Command uuencode-decode-region (start end) + % make what-where LISPDIR=~/elisp VERSION_SPECIFIC_LISPDIR=~/elisp - Decode region START to END of current buffer using uuencode. - -Command gzip64-encode-region (start end) - - Encode region START to END of current buffer using x-gzip64. - -Command gzip64-decode-region (start end) - - Decode region START to END of current buffer using x-gzip64. - -Variable mime-encoding-method-alist - - Alist of encoding vs. corresponding method to encode region. - Each element looks like (STRING . FUNCTION) or (STRING . nil). - STRING is content-transfer-encoding. - FUNCTION is region encoder and nil means not to encode. - -Variable mime-decoding-method-alist - - Alist of encoding vs. corresponding method to decode region. - Each element looks like (STRING . FUNCTION). - STRING is content-transfer-encoding. - FUNCTION is region decoder. - -File ----- - -Command mime-insert-encoded-file (FILENAME ENCODING) - - Insert file FILENAME encoded by ENCODING format. - -Command base64-insert-encoded-file (FILENAME) - - Encode contents of file FILENAME to base64, and insert the result. - - It calls external base64 encoder specified by - `base64-external-encoder'. So you must install the program (maybe - mmencode included in metamail or XEmacs package). - -Command quoted-printable-insert-encoded-file (FILENAME) - - Insert quoted-printable encoded file. - -Command uuencode-insert-encoded-file (FILENAME) - - Insert uuencode encoded file. - -Command gzip64-insert-encoded-file (FILENAME) - - Insert gzip64 encoded file. - -Variable mime-file-encoding-method-alist - - Alist of encoding vs. corresponding method to insert encoded file. - Each element looks like (STRING . FUNCTION). - STRING is content-transfer-encoding. - FUNCTION is function to insert encoded file. - -String ------- - -Function base64-encode-string (STRING) - - Encode STRING to base64, and return the result. + You can specify other optional settings by editing the file + FLIM-CFG. Please read comments in it. -Function base64-decode-string (STRING) +(1-c) install as a XEmacs package - Decode STRING which is encoded in base64, and return the result. + If you want to install to XEmacs package directory, please do + following: -Function q-encoding-encode-string (STRING &optional MODE) + % make install-package - Encode STRING to Q-encoding of encoded-word, and return the result. - MODE allows `text', `comment', `phrase' or nil. Default value is - `phrase'. + You can specify the XEmacs command name, for example -Function q-encoding-decode-string (STRING) + % make install-package XEMACS=xemacs-21 - Decode STRING which is encoded in Q-encoding and return the result. + If `XEMACS=...' is omitted, XEMACS=xemacs is used. -Function base64-encoded-length (STRING) + You can specify the package directory, for example: - Return length of base64 encoded STRING. + % make install PACKAGEDIR=~/.xemacs -Function q-encoded-length (STRING &optional MODE) + If `PACKAGEDIR=...' is omitted, the first existing package + directory is used. - Return length of Q-encoding encoded STRING. - MODE allows `text', `comment', `phrase' or nil. Default value is - `phrase'. + Notice that XEmacs package system requires XEmacs 21.0 or later. Bug reports =========== If you write bug-reports and/or suggestions for improvement, please - send them to the tm Mailing List: + send them to the EMACS-MIME Mailing List: - bug-tm-en@chamonix.jaist.ac.jp (English) - bug-tm-ja@chamonix.jaist.ac.jp (Japanese) + emacs-mime-en@m17n.org (English) + emacs-mime-ja@m17n.org (Japanese) - Via the tm ML, you can report FLIM bugs, obtain the latest release - of FLIM, and discuss future enhancements to FLIM. To join the tm ML, - send an empty e-mail to + Via the EMACS-MIME ML, you can report FLIM bugs, obtain the latest + release of FLIM, and discuss future enhancements to FLIM. To join + the EMACS-MIME ML, send an empty e-mail to - tm-en-help@chamonix.jaist.ac.jp (English) - tm-ja-help@chamonix.jaist.ac.jp (Japanese) + emacs-mime-en-ctl@m17n.org (English) + emacs-mime-ja-ctl@m17n.org (Japanese)