This HOWTO guide applies to Windows only


HOW TO USE CODEQUERY WITH C/C++ CODE?


1. Change directory to the base folder of your source code like this:

cd c:\projects\myproject\src


2. Create a cscope.files file with all the C/C++ source files listed
   in it. Files with inline assembly code should be excluded from
   this list. See: http://en.wikipedia.org/wiki/Inline_assembler

dir /b/a/s *.c    > cscope.files   
dir /b/a/s *.cpp >> cscope.files   
dir /b/a/s *.cxx >> cscope.files   
dir /b/a/s *.cc  >> cscope.files   
dir /b/a/s *.h   >> cscope.files   
dir /b/a/s *.hpp >> cscope.files   
dir /b/a/s *.hxx >> cscope.files   
dir /b/a/s *.hh  >> cscope.files   


3. Create a cscope database like this (add k, if you don't want standard include paths like for stdio.h):

cscope -cb

Omission of c (to use compressed cscope database) is now supported experimentally.

4. Create a ctags database like this.

ctags --fields=+i -n -L cscope.files


5. Run cqmakedb to create a CodeQuery database out of the
   cscope and ctags databases, like this:

cqmakedb -s .\myproject.db -c cscope.out -t tags -p


6. Open myproject.db using the CodeQuery GUI tool. Wild card search
   (* and ?) supported if Exact Match is switched off.
   Or use cqsearch, the CLI-version of CodeQuery (type `cqsearch -h`
   for more info).

Use cqmakedb -h to get help on cqmakedb command line arguments.
Use codequery -h to get help on codequery command line arguments.




HOW TO USE CODEQUERY WITH JAVA CODE?


1. Change directory to the base folder of your source code like this:

cd c:\projects\myproject\src


2. Create a cscope.files file with all the Java source
   files listed in it.

dir /b/a/s *.java > cscope.files 


3. Create a cscope database like this:

cscope -cb

Omission of c (to use compressed cscope database) is now supported experimentally.

4. Create a ctags database like this:

ctags --fields=+i -n -L cscope.files


5. Run cqmakedb to create a CodeQuery database out of the
   cscope and ctags databases, like this:

cqmakedb -s .\myproject.db -c cscope.out -t tags -p


6. Open myproject.db using the CodeQuery GUI tool. Wild card search
   (* and ?) supported if Exact Match is switched off.
   Or use cqsearch, the CLI-version of CodeQuery (type `cqsearch -h`
   for more info).

Use cqmakedb -h to get help on cqmakedb command line arguments.
Use codequery -h to get help on codequery command line arguments.



HOW TO USE CODEQUERY WITH PYTHON CODE?

Please install pycscope manually by following instructions on its page here:
https://github.com/portante/pycscope

1. Change directory to the base folder of your source code like this:

cd c:\projects\myproject\src


2. Create a cscope.files file with all the Python source
   files listed in it.

dir /b/a/s *.py    > cscope.files  


3. Create a cscope database like this:

pycscope -i cscope.files


4. Create a ctags database like this.

ctags --fields=+i -n -L cscope.files


5. Run cqmakedb to create a CodeQuery database out of the
   cscope and ctags databases, like this:

cqmakedb -s .\myproject.db -c cscope.out -t tags -p


6. Open myproject.db using the CodeQuery GUI tool. Wild card search
   (* and ?) supported if Exact Match is switched off.
   Or use cqsearch, the CLI-version of CodeQuery (type `cqsearch -h`
   for more info).

Use cqmakedb -h to get help on cqmakedb command line arguments.
Use codequery -h to get help on codequery command line arguments.




HOW TO USE CODEQUERY WITH RUBY, GO AND JAVASCRIPT CODE?

Please install starscope manually by following instructions on its page here:
https://github.com/eapache/starscope

1. Change directory to the base folder of your source code like this:

cd c:\projects\myproject\src


2. Create a cscope.files file with all the Ruby, Go or Javascript source
   files listed in it.

dir /b/a/s *.rb    > cscope.files  
dir /b/a/s *.go    > cscope.files 
dir /b/a/s *.js    > cscope.files 


3. Create a cscope database like this:

starscope -e cscope


4. Create a ctags database like this.

ctags --fields=+i -n -L cscope.files


5. Run cqmakedb to create a CodeQuery database out of the
   cscope and ctags databases, like this:

cqmakedb -s .\myproject.db -c cscope.out -t tags -p


6. Open myproject.db using the CodeQuery GUI tool. Wild card search
   (* and ?) supported if Exact Match is switched off.
   Or use cqsearch, the CLI-version of CodeQuery (type `cqsearch -h`
   for more info).

Use cqmakedb -h to get help on cqmakedb command line arguments.
Use codequery -h to get help on codequery command line arguments.