# autotags

**Repository Path**: love2share/autotags

## Basic Information

- **Project Name**: autotags
- **Description**: 调用inotify 监控目录的变化 , 然后更新tags文件
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-03-06
- **Last Updated**: 2023-03-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

这备份仅方便网友快速查看.但我个人并未使用 , 因为从它的执行脚本(autotags/autotags)发现, 它使用系统自带inotify监控文件的改变状态 , 即使我加个注释并保存 , 它也会遍历项目目录更新一遍tags文件 , 太废磁盘了!

	$ 实际我是自己编写vim脚本 , 仅在自己需要时更新tags文件


# Autotags

[![Build Status](https://travis-ci.org/dotboris/autotags.svg?branch=master)](https://travis-ci.org/dotboris/autotags)

A little tool that watches a given directory and generates
[ctags](http://ctags.sourceforge.net/) whenever you save your code.

## Why?

Many editors and tools make use of ctags to provide a better coding experience.
This is great. The only issue is that every time you add a class, function,
variable, method, etc. you need to run ctags again so that your editor knows
about your new code. Autotags solves that issue by keeping an eye on your files
and then running ctags for you when anything changes.

## Install

### Debian & Ubuntu family

__TODO__

### Fedora & Redhat family

__TODO__

### Arch Linux

Autotags is available in AUR (https://aur.archlinux.org/packages/autotags/). You
can install it using your favorite AUR helper.

    $ aurhelper -S autotags

### Other Linux distributions

1. Install `ctags`
1. Install `inotify-tools`
1. Download [`autotags`](https://github.com/dotboris/autotags/releases/download/v0.2.0/autotags)
  somewhere in your `$PATH`

### Mac or Windows

You're out of luck. Autotags depends on inotify which is a Linux specific
protocol.

Usage
-----

Start generating ctags with:

    $ autotags watch

This will watch the current directory and generate ctags whenever you save your
files.

Optionally, you can specify a folder to watch:

    $ autotags watch path/to/directory

Once you're done, stop generating ctags with:

    $ autotags stop

This will stop watching the current directory.

Optionally, you can specify a folder to stop watching:

    $ autotags stop path/to/directory

You can get more help with:

    $ autotags help

### A note on source control

Autotags creates files in the directory it's watching. If you're running
autotags in a directory that is managed by source control you're going to want
to ignore those files.

You can do this by adding the following lines in your source control's ignore
file:

    .tags
    .autotags.pid

## Contributing

If you have a question, found a bug or would like to discuss anything, open a
[pull request](https://github.com/dotboris/autotags/compare).

If you'd like to contribute code:

1. [Fork](https://github.com/dotboris/autotags#fork-destination-box) this
  repository
1. Clone your fork
1. Make, commit & push your changes
1. Open a [pull request](https://github.com/dotboris/autotags/compare)

Check out [CONTRIBUTING.md](CONTRIBUTING.md) for more details on how to
contribute.