%% /u/sy/beebe/tex/biblabel/README, Mon Oct 31 23:23:43 1994
%% Edit by Nelson H. F. Beebe <beebe@sunrise>

------------------------------------------------------------------------
Author:
	Nelson H. F. Beebe
	Center for Scientific Computing
	Department of Mathematics
	University of Utah
	Salt Lake City, UT 84112
	USA
	Email: beebe@math.utah.edu (Internet)
	Tel: +1 801 581 5254
	FAX: +1 801 581 4148

------------------------------------------------------------------------
Copyright status:
	This code is made available without copyright or copyleft, and
	without any warranty.  It is in the PUBLIC DOMAIN.  It may be
	freely distributed without any restrictions whatsoever.
	However, the author DOES expect the courtesy of proper
	scientific accreditation, and notification of bugs, porting
	problems, and extensions, so that others can benefit too.

------------------------------------------------------------------------
Where to get this code:
	The master copy of this code resides in the anonymous ftp
	archive files ftp.math.utah.edu:/pub/tex/bib/biblable-x.yy.*,
	where x.yy is a version number, like 1.00.  It may also be found
	on other Internet archive sites that mirror ftp.math.utah.edu,
	including the Comprehensive TeX Archive Network (finger
	ctan@pip.shsu.edu for a list), Netlib, and the huge Computer
	Science bibliography archive on ftp.ira.uka.de.

------------------------------------------------------------------------
Overview:
	This directory contains biblabel, and its companion program,
	citesub.

	biblabel generates standardized BibTeX citation labels from one
	or more input bibliographies, outputting on stdout lines with
	old and new citation label pairs.

	citesub uses the output of biblabel (or a similar file prepared
	by hand, or other software), and applies the substitutions to
	one or more files, usually BibTeX, LaTeX, or TeX files.  The
	substitution algorithm is highly efficient, with a run time
	linear in the size of the input, but INDEPENDENT of the number
	of citation labels to be substituted.

	These programs can be applied to bibliographies, and files that
	use them, to convert existing bibliography citation labels to
	the new form adopted for the BibNet Project.

------------------------------------------------------------------------
Installation:
	To compile and build the C version of citesub, you MUST do

		make targetname

	where targetname is one of a few dozen host-specific names
	provided in the Makefile.

	If you have a C++ compiler for which there is a supported
	targetname, I strongly urge that you use it, because the
	stronger type-checking of C++ ferrets out many problems that
	would only be discovered at core dump time with C compilation.

	Regrettably, deviations from the C Standard are common, and in
	porting the author's TeX DVI driver 3.0 code to more than 50
	different operating system / compiler combinations, it has been
	found necessary on some systems to provide specific compile-time
	flags.  All of the .h files listed below, and hash.c, are taken
	from the as-yet unreleased DVI development code.  Because this
	code must run under several operating systems, I have rejected
	the use of the Free Software Foundation configure script
	approach to handling this problem.

	Other Makefile targets of interest are install, uninstall,
	install-ftp, and uninstall-ftp, to install and remove the
	programs from system and anonymous ftp directories.

------------------------------------------------------------------------
Summary of distribution files:
	CHANGELOG		Revision history (reverse time order).
	Makefile		UNIX Makefile for building and
				installing programs.
	README			This file.
	biblabel.awk		Implementation of biblabel as an awk program.
	biblabel.hlp		DEC VMS helpfile generated from ASCII
				version of biblabel formatted UNIX manual
				page.
	biblabel.man		UNIX manual page file for biblabel.
	biblabel.ps		PostScript version of biblabel formatted UNIX
				manual page
	biblabel.sh		UNIX shell script to execute biblabel.awk.
	biblabel.txt		ASCII version of biblabel formatted UNIX
				manual page
	bibnet.ini		Modified bibclean patterns for BibNet project.
	citesub.awk		Prototype implementation of citesub as an awk
				program; this can be used in place of
				citesub.c, in the event a C compiler is
				unavailable.
	citesub.c		Implementation of citesub in C.
	citesub.hlp		DEC VMS helpfile generated from ASCII
				version of citesub formatted UNIX manual
				page.
	citesub.man		UNIX manual page file for citesub.
	citesub.ps		PostScript version of citesub formatted UNIX
				manual page
	citesub.txt		ASCII version of citesub formatted UNIX
				manual page
	fixnames.sed		Sample file used in Makefile to apply
				UNIX sed stream editor commands in the
				conversion of .bib files to .bib-new files.
				The distributed Makefile disables the
				use of this file by setting the
				BIBFILTER pipeline to an empty string.
	hash.c			Generic hash table code used by citesub.c.
	hash.h			Header file for generic hash table support.
	man2ps			UNIX shell script to run programs to convert
				UNIX man page files to PostScript.
	os.h			Header file.
	rofvms.awk		Awk program to convert nroff output to a
				DEC VMS help file.
	strdup.c		Private string duplication function.
	stricm.c		Private string comparison function, ignoring
				lettercase.
	typedefs.h		Header file.
	unixlib.h		Header file.
	xalloc.c		Private memory management routines (they
				interface to Standard C's
				malloc()/realloc()/free() routines,
				rather than to non-portable lower-level
				code).
	xalloc.h		Header file.
	xctype.h		Header file.
	xerrno.h		Header file.
	xstat.h			Header file.
	xstddef.h		Header file.
	xstdlib.h		Header file.
	xstring.h		Header file.
	xtypes.h		Header file.
------------------------------------------------------------------------
