silentbob/silent_bob.pod

   1 =head1 NAME
   2
   3 silent_bob - The SilentBob is yet another indexing tool.
   4
   5 =head1 SYNOPSIS
   6
   7  silent_bob [<files>] [<options>] [<function>]
   8  bob [<files>] [<options>] [<function>]
   9  tags ...
  10  the_tt <files>
  11  structs <files>
  12
  13 =head1 DESCRIPTION
  14
  15 The SilentBob is yet another indexing tool helping you to find your way through
  16 the software source code. Although SilentBob is also able to index sources in
  17 many popular programming languages, currently C/C++ is the most functional back-end. Main features are:
  18   - Code indexing
  19   - Function call traverse
  20   - Call backtrace
  21   - File searching
  22   - Fast searching in the source code
  23
  24 B<silent_bob> -.
  25         When started with single argument the SillentBob traverse the given function name
  26         up to he most outer caller. A simple to understand tree will be build on the screen.
  27         Both "tags" and "call_tags" files are required to perform traversal quickly.
  28
  29         the SilentBob is also capable to handle  "tags" file by "exuberant-ctags" program,
  30         but it is not designed to do so.
  31
  32 B<bob> - runs silent_bob
  33
  34 B<tags> - alias for "silent_bob --tags"
  35
  36 B<the_tt> - alias for "silent_bob --the-tt"
  37
  38 B<structs> - alias for "silent_bob --give-structs"
  39
  40 =head1 OPTIONS
  41
  42 B<-V> show version info and exit
  43
  44 B<-L> specify file list to process as a text file
  45
  46 B<--cfiles> list all C/C++ related files (.h, .cpp etc)
  47
  48 B<--file> dump all function names from file
  49
  50 B<--give-structs> dump all C structures from file
  51
  52 B<--indent> indent the source code
  53
  54 B<--tags> show parts of referenced code
  55
  56 B<--make-ctags> Create "./tags" index file
  57
  58 B<--call-tags> Create function calls index file ("./call_tags")
  59
  60 B<--cgrep> Search by operation (exmpl: bob --cgrep if,var -- finds all comparisons of var)
  61
  62 B<--plugins-info> list available plug-in's
  63
  64 B<--u> Show reversed function call tree
  65
  66 B<--tag-style> Enforce ctags file format (for "--cgrep")
  67
  68 B<--depth> Set maximum traversal (tree) depth
  69
  70 B<-fn> Show source file names while traversing function calls
  71
  72 =head1 EXAMPLES
  73
  74 Build "ctags" file:
  75
  76           bob --make-ctags
  77
  78 Build "call_tags" :
  79
  80           bob --cfiles
  81           bob -L ./cfiles --call-tags
  82
  83 Created "call_tags" file is compatible with Vim!
  84
  85 Show code of "sys_socket" and "file_operations" :
  86
  87           bob --make-ctags
  88           tags sys_socket file_operations
  89
  90 =head1 AUTHOR
  91
  92 Oleg Puchinin <graycardinalster@gmail.com>
  93