Installation
============

gnotepad+ uses the GNU autoconf package, so installation should be
relatively simple.  The quick and dirty way to install gnotepad+ is to
simply do:

	./configure
	make
	make install

This installs an executable called "gnp" into "/usr/local/bin/", a
manpage in "/usr/local/man/man1/", and pixmap image files into
"/usr/local/share/gnotepad+/xpm/".

However, there are a number configuration options which one may want
to change.  By permanently disabling unwanted options, code is omitted
and may save a little bit of disk space as well as memory use.

--prefix=DIR
	Install gnotepad+ in DIR instead of /usr/local

--enable-debug		[default=no]
	Enable runtime debugging code.  This is useful only if you are
	debugging gnotepad+.  By default, this option is disabled.
	However, enabling this does not hurt since it does not take up
	much code, and greatly improves debugging.

--enable-warnings	[default=yes]
	If "configure" detects that you are using gcc or g++ as your
	compiler, it will add these additional compiler flags:
	
		-Wall -Wmissing-prototypes -Wno-implicit-int

	The "-Wno-implicit-int" is actually a little misleading and
	contradictory to the previous two.  This is added because
	depending on the version of gcc you are using, and depending
	on your X11 header files, there could be a LOT of warning
	messages printed since a lot of the prototypes in the X11
	header files are declared with implicit integer return types.

	See the gcc man page for an explanation of these options.  The
	default is to enable these options, and it suggested that you
	leave this alone.

--enable-ansi		[default=no]
	If gcc or g++ is detected as your compiler, enabling ansi will
	automatically add '-ansi -pedantic' as additional compiler
	flags.  By default, this is not enabled since it is really
	only useful for development purposes.

--enable-gnome		[default=yes]
	gnotepad+ will look for the GNOME libraries and header files
	and will enable GNOME support if they are found.  If they are
	not found, no GNOME support will be available.

--enable-background	[default=yes]
	gnotepad+ has the ability to automatically run itself in the
	background.  This feature is user configurable through the
	preferences.  However, if you do decide that you NEVER want
	this feature (that is, gnotepad+ will ALWAYS run itself in the
	foreground, unless otherwise specified by a '&' on the command
	line), you can disable this option.

--enable-splash		[default=yes]
	On startup, gnotepad+ normally displays a small "splash"
	screen, which basically informs the user how many file are
	left to be opened.  This feature is user configurable through
	the preferences.  However, if you decide that you NEVER want
	this feature, you can disable this option.

--enable-clipboard	[default=yes]
	Enable features for cutting, copying, and pasting text.

--enable-undoredo	[default=yes]
	Enable ability for unlimited undo and redo.

--enable-search		[default=yes]
	Enable search and replace features.

--enable-regex-search	[default=yes]
	By default, gnotepad+ will look for the regular expression
	libraries and header files on your system.  If available,
	regular expression searches can be used.

--enable-recent		[default=yes]
	Enable menu option for opening recently accessed documents.

--enable-autosave	[default=yes]
	gnotepad+ has the option of automatically saving files at
	configurable, set intervals.  This option can be disabled by
	the user through the preferences.  However, if you decide that
	you NEVER want this feature, you can disable this option.

--enable-backup		[default=yes]
	gnotepad+ has the option of creating a backup copy of a file
	before saving it.  This option can be disabled by the user
	through the preferences.  However, if you decide that you
	NEVER want this feature, you can disable this option.

--enable-shell-insert	[default=yes]
	Enables the menu feature to run an shell command and insert
	its output directly into the current document.

--enable-toolbars	[default=yes]
	By default, gnotepad+ can show toolbars in its interface.
	This is configurable by the user in the preferences.  However,
	if you decide that you never want to have toolbars, you can
	disable this option.

--enable-doclist	[default=yes]
	Enable the document list feature.  The document list is a
	seperate popup window created which shows you a list of
	currently opened documents.

--enable-fileinfo	[default=yes]
	Enable a menu-option and a button down by the message bar
	which allows you to get detailed information about the current
	file/document (e.g., file size, permissions, etc.).

--enable-winlist	[default=yes]
	Enable the window list feature.  The window list is a seperate
	popup window created which shows you a list of current
	windows, where each window may contain zero or more open
	documents.

--enable-random-tips	[default=yes]
	At set intervals, a random "tip of the day" (or other,
	hopefully useful, message) will be printed in the message bar.
	This feature can be disabled in the user preferences, but if
	you do not even want the code to be compiled in, you can
	disable it entirely.

--enable-msgbox		[default=yes]
	The message box is a seperate popup window which displays a
	list of gnotepad+ messages (e.g., file opened, closed, saved,
	etc.).  This is useful as a mechanism to show a history of
	what has happened.

--enable-htmltags	[default=yes]
	To aid in editing HTML documents, gnotepad+ can offer the
	option of quickly inserting commonly used HTML tags.  This is
	available both as a menu option, and as well as a toolbar.

--enable-flock		[default=no]
	Use flock() to lock files.  It is safe to leave this untouched
	unless you know what you are doing when it comes to UNIX file
	locking.

--enable-fcntl		[default=yes]
	By default, gnotepad+ uses fcntl() to lock files.  Over NFS
	this can result in poor performance on read/write.  It is safe
	to leave this untouched unless you know what you are doing
	when it comes to file locking.

--enable-gtk-xmhtml	[default=yes]
	By default, gnotepad+ will look for the gtkxmhtml library.
	This library is a simple HTML renderer, and allows you to view
	an HTML document as WYSIWYG (What You See Is What You Get).
	Note the gtkxmhtml library is an HTML *viewer*, not an editor.
	
	The gtkxmhtml library is normally distributed with the GNOME
	libraries (gnome-libs), so if you are using GNOME, you should
	already have this on your system.  If you not have GNOME, or
	do not already have this library, you can get it from the
	gnotepad+ homepage.

gnotepad+ should compile cleanly (without errors), and hopefully also
compile without any warnings.  If successful, you should end up with a
binary called in the "src/" subdirectory called "gnp".


Platform Notes
==============

Linux

	On recent Linux systems, flock() and fcntl() locks don't mix.
	If you use the --enable-flock switch on such systems, be sure
	to also use the --disable-fcntl option.


Miscellaneous Notes
===================

	1. "gnp --help" shows available command line options.

	2. "gnp --version" shows version information.

	3. "gnp --info" shows compiler options used.

	4. gnp will automatically create a subdirectory called ".gnp"
	in your home directory.  in here, you can create "gtkrc" and
	put any GTK specific settings (e.g., the text font).  there
	will also be three other files: "apprc", "appgtkrc", and
	"recentrc".  you do NOT need to edit these by hand.