mirror of
https://github.com/gryf/tagbar.git
synced 2025-12-18 03:50:26 +01:00
bafd7c51e0
Clearly steer users away from Exuberant Ctags and be more explicit that it is less well supported and will be deprecated. Rephrase sentence on additional providers because an exemplary enumeration (such as) does not redundantly need to add (or others).
101 lines
4.3 KiB
Markdown
101 lines
4.3 KiB
Markdown
# Tagbar: a class outline viewer for Vim
|
|
|
|
[](https://github.com/preservim/tagbar/actions?workflow=Vint)
|
|
[](https://github.com/preservim/tagbar/actions?workflow=Check)
|
|
|
|
## What Tagbar is
|
|
|
|
Tagbar is a Vim plugin that provides an easy way to browse the tags of the
|
|
current file and get an overview of its structure. It does this by creating a
|
|
sidebar that displays the ctags-generated tags of the current file, ordered by
|
|
their scope. This means that for example methods in C++ are displayed under
|
|
the class they are defined in.
|
|
|
|
## What Tagbar is not
|
|
|
|
Tagbar is not a general-purpose tool for managing `tags` files. It only
|
|
creates the tags it needs on-the-fly in-memory without creating any files.
|
|
`tags` file management is provided by other plugins, like for example
|
|
[easytags](https://github.com/xolox/vim-easytags).
|
|
|
|
## Dependencies
|
|
|
|
* [Vim](http://www.vim.org/) >= 7.3.1058
|
|
or any version of [NeoVim](https://neovim.io/).
|
|
|
|
* A ctags implementation: We _highly recommend_ any version of [Universal
|
|
Ctags](https://ctags.io). It is a maintained fork of Exuberant Ctags with
|
|
many bugfixes, support for many more formats, and proper Unicode support.
|
|
|
|
[Exuberant Ctags](http://ctags.sourceforge.net/) 5.5 or higher works to some
|
|
degree but will be deprecated eventually.
|
|
|
|
Some additional formats can also be handled by other providers such as
|
|
[jsctags](https://github.com/sergioramos/jsctags) or
|
|
[phpctags](https://github.com/vim-php/phpctags).
|
|
|
|
## Installation
|
|
|
|
Extract the archive or clone the repository into a directory in your
|
|
`'runtimepath'`, or use a plugin manager of your choice like
|
|
[pathogen](https://github.com/tpope/vim-pathogen). Don't forget to run
|
|
`:helptags` if your plugin manager doesn't do it for you so you can access the
|
|
documentation with `:help tagbar`.
|
|
|
|
If the ctags executable is not installed in one of the directories in your
|
|
`$PATH` environment variable you have to set the `g:tagbar_ctags_bin`
|
|
variable, see the documentation for more info.
|
|
|
|
## Quickstart
|
|
|
|
Put something like the following into your ~/.vimrc:
|
|
|
|
```vim
|
|
nmap <F8> :TagbarToggle<CR>
|
|
```
|
|
|
|
If you do this the F8 key will toggle the Tagbar window. You can of course use
|
|
any shortcut you want. For more flexible ways to open and close the window
|
|
(and the rest of the functionality) see the [documentation](https://github.com/majutsushi/tagbar/blob/master/doc/tagbar.txt) using `:help tagbar`.
|
|
|
|
## Support for additional filetypes
|
|
|
|
For filetypes that are not supported by Exuberant Ctags check out [the
|
|
wiki](https://github.com/preservim/tagbar/wiki) to see whether other projects
|
|
offer support for them and how to use them. Please add any other
|
|
projects/configurations that you find or create yourself so that others can
|
|
benefit from them, too.
|
|
|
|
## Note: If the file structure display is wrong
|
|
|
|
If you notice that there are some errors in the way your file's structure is
|
|
displayed in Tagbar, please make sure that the bug is actually in Tagbar
|
|
before you report an issue. Since Tagbar uses
|
|
[exuberant-ctags](http://ctags.sourceforge.net/) and compatible programs to do
|
|
the actual file parsing, it is likely that the bug is actually in the program
|
|
responsible for that filetype instead.
|
|
|
|
There is an example in `:h tagbar-issues` about how to run ctags manually so
|
|
you can determine where the bug actually is. If the bug is actually in ctags,
|
|
please report it on their website instead, as there is nothing I can do about
|
|
it in Tagbar. Thank you!
|
|
|
|
You can also have a look at [ctags bugs that have previously been filed
|
|
against Tagbar](https://github.com/preservim/tagbar/issues?labels=ctags-bug&page=1&state=closed).
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
Tagbar is distributed under the terms of the *Vim license*, see the included [LICENSE](LICENSE) file.
|
|
|
|
## Contributors
|
|
|
|
Tagbar was originally written by [Jan Larres](https://github.com/majutsushi).
|
|
It is actively maintained by [Caleb Maclennan](https://github.com/alerque).
|
|
At least [45 others have contributed](https://github.com/preservim/tagbar/graphs/contributors) features and bug fixes over the years.
|
|
Please document [issues](https://github.com/preservim/tagbar/issues) or submit [pull requests](https://github.com/preservim/tagbar/issues) on Github.
|