
Files in the Distribution
=========================

	Documentation
	=============

	README		Program usage
	INSTALL		Installation procedure
	COPYING		GNU General Public Licence
	NEWS		Summary of changes from previous versions
	ChangeLog	Detailed CVS changes
	FILELIST	List of files and their functions (This file)
	TODO		To do list for future versions
	BUGREPORT	Instruction for generating stack trace for
			bug report
	ABOUT-NLS	Notes on the Free Translation Project
	UNICODE		About Unicode support
	
	kcd.1		Man page

	RPM		Instruction to build RPM files
	kcd-*.spec	spec file for RPM

	Scripts for configure and Makefile generation
	=============================================

	configure	Configuration (generated by autoconf)
	configure.in	Configuration source (for autoconf)
	aclocal.m4	Macros used by configure.in (for autoconf)
	Makefile.in	Make file source (to be processed by configure)
			(generated by autodep which can be downloaded from
			ftp://metalab.unc.edu/pub/Linux/devel/make or
			ftp://kcd.sourceforge.net/pub/kcd/infrastructure/)
	ad.rule		Source files and target (for autodep)
	ad.prepend	Variable definition for Makefile.in (for autodep)
	ad.append	Additional rules not automatically generated
			(for autodep)

	Scripts for files installation
	==============================

	Makefile.inst		Script called by `Makefile' to update
				`/etc/profile', `/etc/csh.login',
				`/etc/zprofile' [system-wide]
	Makefile.userinst	Install files [user-specific]
	Makefile.userinst2	Script called by `Makefile.userinst' to update
				`~/.profile', `~/.login', ~/.zprofile' 
				[user-specific]

	Scripts to setup `kcd' shell alias/function
	===========================================

	kcd.sh.init.in		Initialize kcd alias/function for ash,bash,
				pdksh,zsh [system-wide] (to be processed by 
				configure)
	kcd.csh.init.in		Initialize kcd alias for tcsh [system-wide]
				(to be processed by configure)
	kcd.sh.userinit		Initialize kcd alias/function for ash,bash,
				pdksh,zsh [user-specific]
	kcd.csh.userinit	Initialize kcd alias for tcsh [user-specific]
	kcd-inst.in		Install kcd setup commands in user's shell
				startup scripts (to be processed by
				configure)

	Script to invoke `kcdmain' when `kcd' command is typed
	======================================================

	kcdscr		A shell script used to invoke kcdmain and change
			shell's current working directory

	Program Source Codes
	====================

	kcdmain.cc	Main part of kcd
	confobj.cc	Configuration file class
	confobj.h	Configuration file class header
	conffile.cc	Configuration file functions
	conffile.h	Configuration file functions header
	cstrlib.h	Add C++ string handling to C library functions header
	cstrlib.cc	Add C++ string handling to C library functions
	cxxlib.cc	Fix C++ library problems
	cxxlib.h	Fix C++ library problems header
	error.cc	Error report functions
	error.h		Error report functions header
	gentree.cc	Generate directory tree display functions
	gentree.h	Generate directory tree display functions header
	gtstream.cc	C++ stream supporting gettext usage
	gtstream.h	C++ stream supporting gettext usage header
	list.h		Linked-list classes header
	seek.cc		Character search functions
	seek.h		Character search functions header
	miscobj.cc	Miscellaneous classes
	miscobj.h	Miscellaneous classes header
	editbox.cc	Edit box class
	editbox.h	Edit box class header
	strmisc.cc	String-related class & functions
	strmisc.h	String-related class & functions header
	khwin.cc	Hypertext window classes
	khwin.h		Hypertext window classes header
	khdoc.cc	Hypertext document classes
	khdoc.h		Hypertext document classes header
	buffer.cc	Buffer management classes
	buffer.h	Buffer management classes header
	gzfileio.cc	gzipped file I/O
	gzfileio.h	gzipped file I/O header
	dirobj.cc	Directory class
	dirobj.h	Directory class header
	dirtree.cc	Directory tree
	dirtree.h	Directory tree header
	dirutil.cc	Directory utility functions
	dirutil.h	Directory utility functions header
	scandir.cc	Scan directory functions
	scandir.h	Scan directory functions header
	scrnman.cc	Screen management
	scrnman.h	Screen management header
	statwin.cc	Status window
	statwin.h	Status window header
	scroll.cc	Scrollbar
	scroll.h	Scrollbar header
	setupcurses.h	ncurses header inclusion
	utf8dec.cc	UTF-8 decoder
	utf8dec.h	UTF-8 decoder header
	version.cc	Version information

	config.h.in	Configuration header (generated by autoheader, to be
			processed by configure)
	acconfig.h	Source for `config.h.in' (for autoheader)
	config.h.bot	Source for `config.h.in' (for autoheader)

	utf8test.cc	UTF-8 stress test

	Various configure tests
	=======================

	acinclude.m4/cxxac.m4	C++ tests
	acinclude.m4/ncurses.m4	ncurses tests
	acinclude.m4/zlib.m4		zlib tests

	Documentation and source codes with no version and date stamp
	=============================================================

	pkgsrc/README.src
	pkgsrc/NEWS.src
	pkgsrc/kcd.1.src
	pkgsrc/lsm.src
	pkgsrc/spec.src
	pkgsrc/version.cc.src
	pkgsrc/kcd.dtd.src

	Scripts for package maintainance and configuration
	==================================================

	scripts/README		Short description of the directory
	scripts/commit		CVS commit script
	scripts/commit-template	Header for ChangeLog entry
	scripts/dircheck	Check if scripts are run from the correct
				directory
	scripts/makelink	Create links for files not in CVS
	scripts/makepkg		Build prereleased .tar.gz file
	scripts/makepkg-release	Build final .tar.gz file and tag CVS
	scripts/makepkg-real	Used by scripts/makepkg and 
				scripts/makepkg-release
	scripts/miscout		File size stamp
	scripts/rpcp		Stamp version, date and file size
	scripts/version		Version number

	scripts/uglyboolhack.pl	Script for configure when ncurses does not
				support C++ building
	scripts/copy-message.pl Copy locale messages
	scripts/utf-quotes.pl	Produce nice quotes for UTF-8 locales
	scripts/en_GB.pl	Produce en_GB locale messages
	scripts/install-sh	File installation script to be used in case
				`install' is not available in the system.
	scripts/mkinstalldirs	Directory installation script.

	New Documentations (still under development)
	============================================

	doc/kcd.dtd		DTD for DocBook documentation
	doc/*.sgml		DocBook documentation

	gettext Support
	===============

	intl/*			gettext support for system without installed gettext
	po/*			Message catalog

Installed Files Belong to kcd
=============================
	The following files are belong to kcd:

	[For system-wide		[For user-specific
	 installation]			 installation]

	/usr/bin/kcdscr			~/kcd-bin/kcdscr
	 or /usr/local/bin/kcdscr

	/usr/bin/kcdmain		~/kcd-bin/kcdmain
	 or /usr/local/bin/kcdmain

	/usr/bin/kcd-inst		~/kcd-bin/kcd-inst
	 or /usr/local/bin/kcd-inst

	/etc/kcd.sh.init		~/kcd-bin/kcd.sh.userinit

	/etc/kcd.csh.init		~/kcd-bin/kcd.csh.userinit

	/usr/man/man1/kcd.1		(not automatically installed)
	 or /usr/local/man/man1/kcd.1
	 or /usr/man/man1/kcd.1.gz
	 or /usr/local/man/man1/kcd.1.gz

	The following files are modified by kcd during installation:

	[For system-wide		[For user-specific
	 installation]			 installation]

	/etc/profile			~/.profile  (created if not present)
	 or /etc/profile.d/kcd.sh
	    (if /etc/profile.d is 
	     present)

	/etc/csh.login			~/.login  (created if not present)
	 or /etc/profile.d/kcd.csh
	    (if /etc/profile.d is 
	     present)

	The following files are created automatically by kcd:

	~/.kcd.save.gz	Contains directory tree
	~/.kcd.newdir	Temporary file for changing directory

	The following files might be created by users:

	/etc/kcd.conf		System-wide configuration file for kcd
	/usr/etc/kcd.conf
	/usr/local/etc/kcd.conf

	~/.kcd.conf		User-specific configuration file

