Prerequisites

1. Editor

You can find Emacs for Unix/Linux systems at ftp://ftp.gnu.org/pub/gnu/emacs GNU ftp site. Emacs for MS-Windows can be downloaded from ftp://ftp.gnu.org/gnu/windows/emacs. More info about Emacs for Windows can be found on http://www.gnu.org/software/emacs/windows/ntemacs.html . All Emacs packages required by Xrefactory are included in the standard Emacs distribution.

XEmacs for nearly all platforms can be downloaded from http://www.xemacs.org pages. Majority of Xrefactory functions will work with the default Xemacs installation. Installation of 'mail-lib' package is required to get javadoc browsing available and installation of 'xemacs-base' package is required to XEmacs IDE functions (compile, run, etc.).

2. JDK

Installation

  Installation for jEdit

• The easiest way to install Xrefactory under jEdit is to use the jEdit plugin manager. To do this, start jEdit and select 'Plugins -> Plugin Manager' menu item. Click on 'Install Plugins' button and check Xrefactory in the list of proposed plugins. The plugin manager will then download and install Xrefactory automatically. If for any reason this does not work, you can install Xrefactory manually as follows:
• Choose and download Xrefactory distribution corresponding to your platform. If none (SunOS, FreeBSD, ...), or you have some troubles then select the 'xrefactory-any-platform' distribution containing the newest source based portable version. To finish the installation follow one of the next two points:
  
  
• Installing xrefactory-any-platform distribution on a Unix like pltaform:
  • Decompress the file with "gunzip xref-xxx.tar.gz" command and then de-tar it with "tar xfv xref-xxx.tar" command.
  • To finish the installation, go to the created directory and type:

    sh ./xrefsetup
    

• Installing a binary distribution:
  • Unpack the distribution in the jars subdirectory of your jedit installation and restart jEdit.

  Installation for Emacs and XEmacs

• Choose and download Xrefactory distribution corresponding to your platform. If none (SunOS, FreeBSD, ...), or you have some troubles then select the 'xrefactory-any-platform' distribution containing the newest source based portable version. To finish the installation follow one of the next two points:
  
  
• On Unix systems:
  • Decompress the file with "gunzip xref-xxx.tar.gz" command and then de-tar it with "tar xfv xref-xxx.tar" command.
  • To finish the installation, go to the created directory and type:

    sh ./xrefsetup
    

• On Windows 95/98/NT/2000: This port contains no xrefsetup script, in order to install Xrefactory, unzip downloaded file and follow instructions written in the INSTALL.txt file. Compiling Xrefactory from sources on Windows platform is not recommended, if you really need to do this then compile it with "__WIN32__" macro predefined

Upgrade

• Unpack the new version in the same directory as the older one.
• If you are using (X)Emacs version under MS-Windows then copy xref.el, xrefactory.el and xref.exe files into their respective folders.
• Restart your editor.
• ReCreate Tag files for all your projects.