RTags for Debian
----------------

This package includes the `rc` and `rdm` binaries renamed to
`rtags-rc` and `rtags-rdm` correspondingly to avoid collision with
already existing files from other debian packages.

In order to create a complete index, rtags may need additional include
path to find `stddef.h` or `stdarg.h` or similar files.  One way to
achieve that is to install recommended package
`libclang-common-7-dev`. Alternatively you can specify the path to the
files in `$XDG_CONFIG_HOME/rtags/rdmrc` configuration file. For
example in case you have installed package `libgcc-8-dev`, add line

    --include-path /usr/lib/gcc/x86_64-linux-gnu/8/include/

to the `~/.config/rtags/rdmrc` file.

To manually start the `rtags-rdm` indexer, run `rtags-rdm` in a shell.

Emacs with `elpa-rtags` package can automatically start the indexer
process unless the process is already running with the function
`(rtags-start-process-unless-running)` for example added to a hook

    (add-hook 'c-mode-hook 'rtags-start-process-unless-running)
    (add-hook 'c++-mode-hook 'rtags-start-process-unless-running)

Finally, users of `systemd` service manager can use the units shipped
within the `rtags` package by running the following commands:

    systemctl --user enable rdm.socket
    systemctl --user start rdm.socket