Skip to content

Commit

Permalink
docs: note that jansson is required for interactive mode
Browse files Browse the repository at this point in the history
  • Loading branch information
vrischmann committed Jan 26, 2018
1 parent 66c7915 commit 9a407b9
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/interactive-mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ can be used programmatically to control ctags generation. In this mode, json
commands are received over stdin, and corresponding responses are emitted over
stdout.

This feature needs ctags to be built with json support and this requires libjansson to be installed
at build-time. If it's supported it will be listed in the output of ``--list-features``:

.. code-block:: console
$ ./ctags --list-features | grep json
json
Communication with Universal ctags over stdio uses the `json lines`_ format, where each
json object appears on a single line and is terminated with a newline.

Expand Down

0 comments on commit 9a407b9

Please sign in to comment.