INSTALL

___________________________________
|      |  |  |     |  _  |     |  |
|  |___|  |  |  |  |    _|  |  |  |    GNU GLOBAL source code tag system
|  |   |  |  |  |  |     |     |  |
|  ~~  |   ~~|     |  ~  |  |  |   ~~|          for all hackers.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Copyright (c) 2000, 2002, 2003, 2004, 2006, 2011 Tama Communications Corporation

 This file is free software; as a special exception the author gives
 unlimited permission to copy and/or distribute it, with or without
 modifications, as long as this notice is preserved.

 This program is distributed in the hope that it will be useful, but
 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

		----------------------------------

Installation of GNU GLOBAL.

[Note]  Though GNU GLOBAL supports only UNIX(POSIX) environment,
        some outside projects develop DOS or Windows 32 version of it.
        Please see:
                http://www.gnu.org/software/global/download.html

1. Preparation.

o If you want to use the -I option of global(1) then idutils(1) is needed.

   You can get idutils at:

	ftp://ftp.gnu.org/pub/gnu/idutils/
  
o If you want to use the --form(-f) or --dynamic(-D) option of htags(1) then
  Perl version 5 or later is needed.

   If you don't have it, you can fetch it from this site.

	http://www.perl.com/CPAN/

2. How to install.

	$ ./configure
	$ make
	# make install

	(You can see the options of configure by invoking './configure --help')

3. Using GLOBAL with editors.

o Emacs

   Global supports GNU Emacs and XEmacs. If you meet some troubles,
   please mail to bug-global@gnu.org.

   You can get them at:

	GNU emacs:
		ftp://ftp.gnu.org/pub/gnu/emacs/
	XEmacs:
		http://www.xemacs.org

   Installation procedure is written in gtags.el itself.

o Elvis

   You need Elvis 2.1 or later. You can get it at:

	http://elvis.vi-editor.org/

   Please copy an elvis script to your home directory.

	$ cp /usr/local/share/gtags/elvis.rc $HOME/.elvisrc
	$ PATH=/usr/local/share/gtags/script:$PATH

o Vim

   You can get it at:

	http://www.vim.org/

   Please copy vim scripts to your plug-in directory.

	$ cp /usr/local/share/gtags/gtags.vim $HOME/.vim/plugin
	$ cp /usr/local/share/gtags/gtags-cscope.vim $HOME/.vim/plugin

Good luck!