speller/aspell-custom/README.in.sh

   1 cat <<EOF
   2 GNU Aspell 0.60 Custom English Dictionary Package
   3 $GIT_VER
   4 Original Word List By:
   5   Kevin Atkinson <kevina at gnu org>
   6 Copyright Terms: Copyrighted (see the file Copyright for the exact terms)
   7 Wordlist URL: http://wordlist.aspell.net/
   8
   9 Created with http://app.aspell.net/create with the following paramaters:
  10 `cat "$PARMS_FILE"`
  11
  12 This is a Custom English dictionary for Aspell.  It requires Aspell
  13 version 0.60 or better.
  14
  15 If Aspell is installed and aspell and prezip-bin are all
  16 in the path first do a:
  17
  18   ./configure
  19
  20 Which should output something like:
  21
  22   Finding Dictionary file location ... /usr/local/lib/aspell
  23   Finding Data file location ... /usr/local/share/aspell
  24   Testing if an English dictionary is already installed ... yes
  25
  26 if it did not something likely went wrong.
  27
  28 As this is a custom dictionary it is meant to coexist with the
  29 existing English dictionary.  If the configure script detects
  30
  31 and as such the language data files will
  32 not be installed unless the configure script detectes
  33
  34 After that build the package with:
  35   make
  36 and then optionally install it with
  37   make install
  38
  39 If any of the above mentioned programs are not in your path than the
  40 variables, ASPELL and/or PREZIP need to be set to the
  41 commands (with path) to run the utilities.  These variables may be set
  42 in the environment before configure is run or specified at the command
  43 line using the following syntax
  44   ./configure --vars VAR1=VAL1 ...
  45 Other useful variables configure recognizes are ASPELL_PARMS.
  46
  47 To clean up after the build:
  48   make clean
  49
  50 To uninstall the files:
  51   make uninstall
  52
  53 After the custom dictionary is installed you can use with the "-d" or
  54 "--master" option of Aspell.  For example:
  55   aspell -d en-custom ...
  56
  57 If you wish to make this the default dictionary for a particular
  58 language you can use use the "add-dict-alias" config option.  For
  59 example to to make it the default for en_US:
  60   echo 'add-dict-alias en_US en-custom' >> `aspell config per-conf-path`
  61
  62 If you wish to use this dictionary with a particular program than does
  63 not allow you to directly select the dictionary than you can also add
  64 the alias to the ASPELL_CONF env. varable, for example:
  65   ASPELL_CONF='add-dict-alias en_US en-custom' emacs
  66
  67 If you already have an English dictionary installed and do not wish to
  68 install this custom dictionary you can simply use the dictionary file
  69 (en-custom.rws) directly, for example:
  70   aspell -d /<path-to-file>/en-custom.rws
  71 or
  72   ASPELL_CONF='add-dict-alias en_US /<path-to-file>/en-custom.rws' emacs
  73
  74 The individual word lists have an extension of ".cwl" and are
  75 compressed to save space.  To uncompress a word list use
  76 "preunzip BASE.cwl" which will uncompress it and rename the file
  77 to "BASE.wl".  To dump a compressed word list to standard output use
  78 "precat BASE.cwl".  To uncompress all word lists in the current
  79 directory use "preunzip *.cwl".  For more help on "preunzip" use
  80 "preunzip --help".
  81
  82 If you have any problem with installing or using the word lists please
  83 let the Aspell maintainer, Kevin Atkinson, know at kevina@gnu.org.
  84
  85 Any additional documentation that came with the original word list can
  86 be found in the doc/ directory.
  87 EOF
  88