aboutsummaryrefslogtreecommitdiff
path: root/ctags/README.md
diff options
context:
space:
mode:
authorIndrajith K L2022-12-03 17:00:20 +0530
committerIndrajith K L2022-12-03 17:00:20 +0530
commitf5c4671bfbad96bf346bd7e9a21fc4317b4959df (patch)
tree2764fc62da58f2ba8da7ed341643fc359873142f /ctags/README.md
downloadcli-tools-windows-master.tar.gz
cli-tools-windows-master.tar.bz2
cli-tools-windows-master.zip
Adds most of the toolsHEADmaster
Diffstat (limited to 'ctags/README.md')
-rw-r--r--ctags/README.md123
1 files changed, 123 insertions, 0 deletions
diff --git a/ctags/README.md b/ctags/README.md
new file mode 100644
index 0000000..fe49941
--- /dev/null
+++ b/ctags/README.md
@@ -0,0 +1,123 @@
+# Universal Ctags
+
+[![Coverity Scan Build Status](https://scan.coverity.com/projects/4355/badge.svg)](https://scan.coverity.com/projects/4355)
+[![Coverage Status](https://coveralls.io/repos/universal-ctags/ctags/badge.svg?branch=master&service=github)](https://coveralls.io/github/universal-ctags/ctags?branch=master)
+[![Build status](https://ci.appveyor.com/api/projects/status/6hk2p5lv6jsrd9o7/branch/master?svg=true)](https://ci.appveyor.com/project/universalctags/ctags/branch/master)
+[![RTD build status](https://readthedocs.org/projects/ctags/badge)](https://docs.ctags.io)
+[![CircleCI Build Status](https://circleci.com/gh/universal-ctags/ctags.svg?style=shield&circle-token=2e582261da84ebc6d21725b05381f410bc5de29d)](https://circleci.com/gh/universal-ctags)
+![GitHub Actions/VALGRIND](https://github.com/universal-ctags/ctags/workflows/run%20units%20target%20under%20VALGRIND/badge.svg)
+
+[Universal Ctags](https://ctags.io/) (abbreviated as u-ctags) is a *maintained*
+implementation of `ctags`.
+`ctags` generates an index (or tag) file of language objects found in source
+files for programming languages.
+This index makes it easy for text editors and other tools to locate the indexed
+items.
+
+[Exuberant Ctags](http://ctags.sourceforge.net/) (e-ctags) maintained by Darren
+Hiebert, the ancestor of Universal Ctags, improved traditional `ctags` with
+multi-language support, the ability for the user to define new languages
+searched by regular expressions (called optlib in Universal Ctags), and the
+ability to generate emacs-style TAGS files.
+But the activity of the project unfortunately stalled.
+
+Universal Ctags has the objective of continuing the development of Exuberant
+Ctags.
+Reza Jelveh <reza.jelveh@gmail.com> initially created a personal fork of
+Exuberant Ctags on GitHub.
+As interest and participation grew, it was decided to move development to a
+dedicated project as Universal Ctags.
+The goal of this project is to maintain a common/unified working space where
+people interested in making ctags better can work together.
+
+Some of major features of Universal Ctags are;
+
+* more numbers of improved language support
+ * new extended C/C++ language parser, etc.
+* fully extended optlib (a feature to define a new language parser from a
+ command line)
+* interactive mode (experimental)
+
+## The latest build and package ##
+
+If you want to try the latest Universal Ctags without building it yourself...
+
+### Windows
+Daily builds are available at the [ctags-win32](https://github.com/universal-ctags/ctags-win32) project.
+Go to the [releases](https://github.com/universal-ctags/ctags-win32/releases) page to download zip packages.
+
+### Mac
+See [Homebrew Tap for Universal Ctags](https://github.com/universal-ctags/homebrew-universal-ctags)
+
+### Snap
+Go to [ctags-snap](https://github.com/universal-ctags/ctags-snap) and
+clone the `ctags-snap` repo. Then, follow instructions to build the
+snap package of Universal Ctags. Snapcraft will automatically fetch the source
+code from GitHub.
+
+## How to build and install ##
+
+To build with Autotools (Autoconf, Automake, and Libtool) on GNU/Linux, OSX, or Windows 10 WSL,
+```
+ $ git clone https://github.com/universal-ctags/ctags.git
+ $ cd ctags
+ $ ./autogen.sh
+ $ ./configure --prefix=/where/you/want # defaults to /usr/local
+ $ make
+ $ make install # may require extra privileges depending on where to install
+```
+
+See
+[`docs/autotools.rst`](https://github.com/universal-ctags/ctags/blob/master/docs/autotools.rst)
+for more information.
+
+To build on Windows, see
+[`docs/windows.rst`](https://github.com/universal-ctags/ctags/blob/master/docs/windows.rst)
+for more information.
+
+To build on OSX, see
+[`docs/osx.rst`](https://github.com/universal-ctags/ctags/blob/master/docs/osx.rst)
+for more information.
+
+## Manual ##
+The primary documents of Universal Ctags are man pages.
+Users should first consult the
+[ctags(1)](https://docs.ctags.io/en/latest/man/ctags.1.html), and [other man
+pages](https://docs.ctags.io/en/latest/man-pages.html) if necessary.
+
+[Universal Ctags Hacking Guide](https://docs.ctags.io), which also includes the
+man pages, is primarily for developers and provides additional information to
+the man pages, including experimental features.
+
+See also `*/README.md` on this repository.
+
+## Differences from exuberant-ctags ##
+
+You may be interested in how Universal Ctags is different from Exuberant Ctags.
+See
+[ctags-incompatibilities(7)](https://docs.ctags.io/en/latest/man/ctags-incompatibilities.7.html)
+and [Introduced changes](https://docs.ctags.io/en/latest/news.html) for details.
+
+The most significant incompatible changes:
+
+* Universal Ctags doesn't load `~/.ctags` and `./.ctags` at starting up time.
+ Instead, it loads `~/.ctags.d/*.ctags` and `./.ctags.d/*.ctags`.
+
+* Universal Ctags is more strict about characters that can be
+ used in kind letters and kind names than Exuberant-ctags.
+
+ - The letter must be an alphabetical character (`[a-zA-EG-Z]`).
+ `F` is reserved for `file` kind.
+
+ - The first character of the name must be alphabetic, and
+ the rest characters must be alphanumeric (`[a-zA-Z][a-zA-Z0-9]*`).
+
+ The detailed background is explained in
+ [#1737](https://github.com/universal-ctags/ctags/pull/1737).
+
+ If you want to reuse your `.ctags` written for Exuberant-ctags,
+ you must review kind letters and names defined with `--regex-<LANG>=...`
+ options. When updating the definitions, using `--kinddef-<LANG>=...` option
+ is appreciated.
+
+Pull-requests are welcome!