README #2

p4prompt - Munge tcsh $prompt values to include client name

Legal Notice
------------
Copyright (c) 2002 Anders Johnson. All rights reserved.

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

The GNU General Public License may be found at
"http://www.gnu.org/copyleft/gpl.html", or by writing to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
The Clarified Artistic License may be found at
"http://www.statistica.unimib.it/utenti/dellavedova/software/artistic2.html".
Additional information regarding these licenses may be found at
"http://www.gnu.org/philosophy/license-list.html".

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.

Prerequisites
-------------
Compiles with any ANSI-compliant C compiler under UNIX.
pod2man(1) (distributed with Perl) is required to generate the man page.
gzip(1) is required to generate a new distribution.
The Perforce API (to be found within ftp://ftp.perforce.com/pub/perforce)
and a compatible C++ compiler are required to enable the -p option.

Installation has been tested under Suse Linux 7.2 (Linux 2.4) on a Pentium II
PC with GCC/G++ 2.95.3, Perl 5.6.0, GNU Make 3.79.1 and Perforce API model II.

Installation
------------
To compile with the -p option disabled, just install it in the usual way:

	% make
	% make install # optionally, "make install PREFIX=/..."

$(CXX) (normally C++) is always used to link the executable. If you don't
have a C++ compiler, then add the following line to the Makefile:

	CXX = $(CC)

You might consider static linking if any dynamically linked libraries
might become unavailable due to network or environment problems, because
otherwise users of p4prompt will lose their prompt when such problems
occur, which is very user-unfriendly. This can be accomplished thusly:

	LDFLAGS = -static

To install with the -p option enabled, you'll need to set the P4API variable
(either in the Makefile or on the command line) to point to the directory
containing the Perforce API libraries, e.g.:

	% make P4API=/usr/local/lib/p4api
	% make install # optionally, "make install PREFIX=/..."

You'll need to make sure that $(CXX) is compatible with $(P4API). In
particular, gcc 3.* and later is not object-code compatible with gcc 2.95.*
and earlier, due to differences in the C++ name mangling rules.

You might also run into other platform-specific issues related to the
Perforce API. See the "p4api.txt" file (from Perforce) for more information.

Release History
---------------
Version	Date		Notes
-------	----		-----
0.01	1/3/02		First Release
0.02	1/9/02		Added -p option

Submitting Patches
------------------
You are encouraged to submit patches to <[email protected]>. Please append the
Makefile's VERSION variable with underscore and a single-word description of
the patch. For example, if the basis of the patch is version 0.02, and the
patch causes the prompt to clear to the end-of line, then change VERSION to
"0.02_cleareol".