Gurmukhi for TeX
                           User Manual

                           Version 1.0
                           October 1995

                          Amarjit Singh
                         
________________________________________________________________________

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 1, or (at your option)
    any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
________________________________________________________________________

The purpose of the "Gurmukhi for TeX" software package is to convert the 
characters in a document from English Alphabet to Gurmukhi utilizing the
TeX and Metafont software packages. Gurmukhi is a script for the Punjabi
language mostly used in North India.

TeX is a typesetting system is a trademark of the American Mathematical
Society, used widely on Unix systems, and occassionally on other
operating environments. Metafont, a trademark of Addison Wesley
Publishing Company, is a font generation tool used by TeX. Both TeX and
Metafont are free software packages which can be downloaded from a TeX
archive sites.  A working knowledge of TeX will greatly help in using
this package.

This software package is greatly inspired by "Devanagari for TeX" which
is written by Frans J. Velthuis. I would like to thank him for giving
me permission to change his software package to support Gurmukhi.


This package consists of following file:

    gurmukhi.c      C-source code of preprocessor
    gmmacs.tex      macro file for TeX
    defs.mf, gmchars.mf, grmk8.mf, grmk9.mf, grmk10.mf
                    METAFONT-Source code of Gurmukhi characters.
    grmk8.tfm, grmk9.tfm, grmk10.tfm
                    TFM Font format of Gurmukhi characters.
    readme          This file, describing this package.
    install.ux      File with some help on installation in Unix env.
    install.dos     Some help to install this package on DOS.
    manual.gm and manual.ps
                    Manual on how to create documents using this package
    bani.gm and eg.gm
                    Example files with Gurmukhi characters and other
                    information.
    known.prob      Known issues, and your help will be appreciated.

All these files are put together in a tar file such that at the time of
extraction all file go into same directory. For every specific operating
environment, these files may need to move to different directories, and
that information is provided in install.* file for that environment.

Details of each file included in this package:

o gurmukhi.c, is the c-source file for preprocessor and you would need to
  create an executable file by compiling this with a c compiler. I
  believe, compilation should be fairly easy on any environment as the
  source code has no system dependency.

  The purpose of this preprocessor is to convert text in a .gm file to a
  .tex file in a format understanable by TeX.

o gmmacs.tex, contains macros for TeX, and should be included in your
  text file. This file has macros for fonts, for spacing and for other
  macros which are generated by the Gurmukhi preprocessor.

o *.mf, are the METAFONT source files for Gurmukhi fonts in various
  point sizes. These files will be used to produce Gurmukhi fonts in
  different formats.
  
o *.tfm are the font files in TFM format. A TFM file can be generated
  from a MF file using METAFONT. Usually, TeX internally calls METAFONT
  to create required files.

o manual.* contain the information on preparing an input text file (.gm)
  and use of this package in detail. A postscript version of this manual
  is also included, which can be directly sent to a postscript printer.
  It may be useful, to get information on the package, while writing an
  input text file.

o *.gm, are some file to serve as examples. These can be used to 
  understand the features of a Gurmukhi text, and can also be used
  as input text to see if the installation is complete.


If you have comments or suggestion, feel free to send them to me at 
the following address:

E-mail: asingh@evolving.com

Current Postal Mail: 8405 E. Hampden Ave #11N Denver CO 80231 USA
Permanent Postal Address : A-3 ManSarover Garden, New Delhi 110015 India