silentbob/silent_bob.1

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SILENT_BOB 1"
 132 .TH SILENT_BOB 1 "2006-12-13" "SilentBob 1.2" ""
 133 .SH "NAME"
 134 silent_bob \- The SilentBob is yet another indexing tool.
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 5
 138 \& silent_bob [<files>] [<options>] [<function>]
 139 \& bob [<files>] [<options>] [<function>]
 140 \& tags ...
 141 \& the_tt <files>
 142 \& structs <files>
 143 .Ve
 144 .SH "DESCRIPTION"
 145 .IX Header "DESCRIPTION"
 146 The SilentBob is yet another indexing tool helping you to find your way through
 147 the software source code. Although SilentBob is also able to index sources in
 148 many popular programming languages, currently C/\*(C+ is the most functional back\-end. Main features are:
 149   \- Code indexing
 150   \- Function call traverse
 151   \- Call backtrace
 152   \- File searching
 153   \- Fast searching in the source code
 154 .PP
 155 \&\fBsilent_bob\fR \-.
 156         When started with single argument the SillentBob traverse the given function name
 157         up to he most outer caller. A simple to understand tree will be build on the screen.
 158         Both \*(L"tags\*(R" and \*(L"call_tags\*(R" files are required to perform traversal quickly.
 159 .PP
 160 .Vb 2
 161 \&        the SilentBob is also capable to handle  "tags" file by "exuberant\-ctags" program,
 162 \&        but it is not designed to do so.
 163 .Ve
 164 .PP
 165 \&\fBbob\fR \- runs silent_bob
 166 .PP
 167 \&\fBtags\fR \- alias for \*(L"silent_bob \-\-tags\*(R"
 168 .PP
 169 \&\fBthe_tt\fR \- alias for \*(L"silent_bob \-\-the\-tt\*(R"
 170 .PP
 171 \&\fBstructs\fR \- alias for \*(L"silent_bob \-\-structs\*(R"
 172 .SH "OPTIONS"
 173 .IX Header "OPTIONS"
 174 \&\fB\-V\fR show version info and exit
 175 .PP
 176 \&\fB\-L\fR specify file list to process as a text file
 177 .PP
 178 \&\fB\-\-cfiles\fR list all C/\*(C+ related files (.h, .cpp etc)
 179 .PP
 180 \&\fB\-\-file\fR dump all function names from file
 181 .PP
 182 \&\fB\-\-give\-structs\fR dump all C structures from file
 183 .PP
 184 \&\fB\-\-indent\fR indent the source code
 185 .PP
 186 \&\fB\-\-tags\fR show parts of referenced code
 187 .PP
 188 \&\fB\-\-make\-ctags\fR Create \*(L"./tags\*(R" index file
 189 .PP
 190 \&\fB\-\-call\-tags\fR Create function calls index file (\*(L"./call_tags\*(R")
 191 .PP
 192 \&\fB\-\-cgrep\fR Search by operation (exmpl: bob \-\-cgrep if,var \*(-- finds all comparisons of var)
 193 .PP
 194 \&\fB\-\-plugins\-info\fR list available plug\-in's
 195 .PP
 196 \&\fB\-u\fR Show reversed function call tree
 197 .PP
 198 \&\fB\-\-tag\-style\fR Enforce ctags file format (for \*(L"\-\-cgrep\*(R")
 199 .PP
 200 \&\fB\-\-depth\fR Set maximum traversal (tree) depth
 201 .PP
 202 \&\fB\-fn\fR Show source file names while traversing function calls
 203 .SH "EXAMPLES"
 204 .IX Header "EXAMPLES"
 205 Build \*(L"ctags\*(R" file:
 206 .PP
 207 .Vb 1
 208 \&          bob \-\-make\-ctags
 209 .Ve
 210 .PP
 211 Build \*(L"call_tags\*(R" :
 212 .PP
 213 .Vb 2
 214 \&          bob \-\-cfiles
 215 \&          bob \-L ./cfiles \-\-call\-tags
 216 .Ve
 217 .PP
 218 Created \*(L"call_tags\*(R" file is compatible with Vim!
 219 .PP
 220 Show code of \*(L"sys_socket\*(R" and \*(L"file_operations\*(R" :
 221 .PP
 222 .Vb 2
 223 \&          bob \-\-make\-ctags
 224 \&          tags sys_socket file_operations
 225 .Ve
 226 .SH "AUTHOR"
 227 .IX Header "AUTHOR"
 228 Oleg Puchinin <graycardinalster@gmail.com>