 ______________________________________________________________________________
|                                                                              |
|   FAR Ctags v0.04                    (c) 2017+ Pepak, https://www.pepak.net  |
|______________________________________________________________________________|

This is a source code navigation plugin based on Ctags. According to
Wikipedia (2017-07-28):

    Ctags is a programming tool that generates an index (or tag) file
    of names found in source and header files of various programming
    languages. Depending on the language, functions, variables, class
    members, macros and so on may be indexed. These tags allow definitions
    to be quickly and easily located by a text editor or other utility.

This plugin uses a Ctags utility (which must be provided by the user, see
the USAGE section below) to locate names in the current editor and provide
means for quickly navigating to a selected name.



USAGE
-----

Before you can use this plugin, you need to install Ctags. Any standard
implementation should work, e.g. the plugin was tested with both
Exuberant Tags ( http://ctags.sourceforge.net/ ) and Universal Ctags
( https://ctags.io/ ) and worked fine. Ctags may be installed either in
a regular fashion with ctags.exe available in the PATH, or you can copy
the necessary executables to the ctags subdirectory of the plugin; in this
scenario the Ctags support is "portable", as in, it doesn't need any
installation and if you need to use your specific .ctags file, you can
store it in the same directory. Alternatively, you can setup a path to
pre-existing ctags.exe in the plugin's options.

When Ctags is available, simply press F11 in an editor and select FAR Ctags
from the menu of plugins. If any names were found, a list will appear;
here you can start searching the names by typing into the search window,
or you can navigate the names by pressing UP, DOWN, PAGEUP, PAGEDOWN (you
don't need to activate the list first, these keys work even when the search
window is focused). The list displays a line number, symbol name, symbol
type. Under the list, a context information about the symbol is displayed
(e.g. to let you distinguish between several overloaded variants of a
function). The OK button will close the dialog and move the cursor to the
selected name.



LICENSE
-------

The plugin is released under the Modified (3-clause) BSD License. See
license.txt for details.



BUILDING THE PLUGIN
-------------------

You will need Delphi version at least XE2. Older versions are not supported.
Newer versions should work fine.

Make sure the chosen Delphi's BIN directory is in the PATH, go into the
SOURCE directory and run BUILD. You should get a new .dll file in the BIN
directory.

You can use several command-line options with BUILD. The most important are:

    FAR2 ........ Build the FAR2 version of the plugin.
    FAR3 ........ Build the FAR3 version of the plugin (default).
    X86 ......... Build the 32-bit version of the plugin (default).
    X64 ......... Build the 64-bit version of the plugin.



CONTACT
-------

If you have any questions or want to suggest a new feature, you can do so
either at FAR Manager's forums ( https://forum.farmanager.com ),
or my own forums ( https://forum.pepak.net ).
