
README FOR BWSORT (Version 1.0)
-------------------------------

BWSORT is a program for sorting Bengali text files written
according to the BWFU font encoding. It reads multiple text
files and sorts the concatenated list line by line.

BWSORT can be run from the shell prompt as

   bwsort [-s <sortscheme>] file1 [file2 [file3 ...]]

where the sorting scheme is either DEFAULT or OLD. There are
small differences between these two schemes. While the default
scheme looks more appropriate to me, many Bengali dictionaries
tend to use the old scheme. If the environment variable
BWSORTSTYLE is set (to DEFAULT or OLD), that value is used as
the default sorting style. Otherwise, the default scheme is
DEFAULT. In both cases, however, this default behavior can be
overridden by the -s option.

   bwsort -h

prints a help message and quits, whereas

   bwsort -v

prints the version info and quits.

When one runs BWSORT without any file names in the command line,
the program starts running in interactive mode. The prompt that
is displayed is

bwsort>

In the interactive mode, the following commands are interpreted:

     add file1 [file2 [file3 ...]]
     comp word1 word2
     exit / quit
     help [topic]
     load file1 [file2 [file3 ...]]
     save file
     show
     sortstyle [style]
     version
     !shell command

Type

   help <cmd>

at the BWSORT prompt to get an on-line help on the commands supported.


INSTALLATION
------------

First check if you have the GNU readline library. If yes, edit the
Makefile and set

CFLAGS = -O2 -lreadline -DREADLINE_INSTALLED

If the readline library is installed in a different name, change the
-l directive accordingly. Similarly change the lines

#include <readline/*.h>

in bwsort.c, if the readline header files are installed elsewhere.

If you do not have readline at all, set

CFLAGS = -O2

and leave bwsort.c unaffected. Now type

make

to build the executable (bwsort). Subsequently

make install

installs the executable in BIN_DIR specified in the Makefile. It also
installs the bwsort manual in MAN_DIR defined the the Makefile.


ALSO SEE
--------

The manpage of bwsort can be viewed as
   man bwsort
(given that the installation is successful).

The file ALGORITHM discusses about the BWSORT algorithm and the
differences between the DEFAULT and OLD sorting schemes.

The URL's

   http://www2.csa.iisc.ernet.in/~abhij/bwsort/
   http://www.geocities.com/SiliconValley/Lab/6024/bwsort.html

can be visited for html documentation on BWSORT. For similar documentation
on the related packages (bwfu, bwti, bwedit etc.) look at

   http://www2.csa.iisc.ernet.in/~abhij/
   http://www.geocities.com/SiliconValley/Lab/6024/bengali.html


COPYRIGHT
---------

BWSORT is copyrighted 1998 by the author

   Abhijit Das (Barda)
   Department of Computer Science and Automation
   Indian Institute of Science
   Bangalore 560 012
   E-mail: abhij@csa.iisc.ernet.in
   URL: http://www.geocities.com/SiliconValley/Lab/6024/

BWSORT is a freeware. Permission is hereby granted to use and distribute
it free of charge for all sorts of personal and academic purposes. Use of
this software for commercial purposes is strictly prohibited.

