"Fossies" - the Fresh Open Source Software Archive

Member "global-6.6.5/doc/gozilla.ref" (3 Sep 2020, 2841 Bytes) of package /linux/misc/global-6.6.5.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "gozilla.ref": 6.6.4_vs_6.6.5.

    1 @c This file is generated automatically by convert.pl from gozilla/manual.in.
    2 @unnumberedsubsec NAME
    3 gozilla - force firefox to display specified part of a source file
    4 @unnumberedsubsec SYNOPSIS
    5 @quotation
    6 gozilla [-b browser][-p][+no] file@*
    7 gozilla [-b browser][-p] -d name@*
    8 @end quotation
    9 @unnumberedsubsec DESCRIPTION
   10 Gozilla forces firefox to display specified part of a source file.
   11 Gozilla can be used with other browsers like chrome.
   12 
   13 In advance of using this command, you must execute gtags(1)
   14 and htags(1) at the root directory of the project to make tag files.
   15 Then you can execute this command anywhere in the project.
   16 
   17 First form:@*
   18 You can specify a source file and optional line number.
   19 This syntax is similar to vi(1) and emacs(1).
   20 
   21 Second form:@*
   22 You can specify a definition name directly. The definition name should
   23 exist in @file{GTAGS}. This option requires @file{HTML/MAP} generated
   24 by htags(1).
   25 
   26 Some browsers require you to load it before executing gozilla.
   27 @unnumberedsubsec OPTIONS
   28 The following options are available:
   29 @table @asis
   30 @item @samp{+no}
   31 Line number.
   32 @item @samp{-b} browser
   33 Browser to use. By default, it is assumed firefox.
   34 @item @samp{-d} name
   35 Print definitions.
   36 @item @samp{--help}
   37 Show help.
   38 @item @samp{-p}
   39 Just print a generated URL instead of displaying it.
   40 @item file
   41 File name or alias name.
   42 @item @samp{-q}, @samp{--quiet}
   43 Quiet mode.
   44 @item @samp{-v}, @samp{--verbose}
   45 Verbose mode.
   46 @item @samp{--version}
   47 Show version number.
   48 @end table
   49 @unnumberedsubsec FILES
   50 @table @asis
   51 @item @file{GTAGS}
   52 Tag file for definitions.
   53 @item @file{HTML/}
   54 Hypertext of source code.
   55 @item @file{HTML/MAP}
   56 Mapping file for converting tag name into the path of tag list.
   57 @item @file{gtags.conf}, @file{$HOME/.globalrc}
   58 Configuration data for GNU GLOBAL.
   59 See gtags.conf(5).
   60 @end table
   61 @unnumberedsubsec ENVIRONMENT
   62 @table @asis
   63 @item @var{BROWSER}
   64 Browser to use. By default, it is assumed firefox.
   65 If you want to load the default browser in OSX, you may set this variable
   66 to osx-default.
   67 @item @var{GTAGSDBPATH}
   68 The directory in which the tag files exist.
   69 This value is ignored when @var{GTAGSROOT} is not defined.
   70 @item @var{GTAGSROOT}
   71 The root directory of the project.
   72 @end table
   73 @unnumberedsubsec EXAMPLES
   74 @example
   75 $ gtags
   76 $ htags
   77 $ global -x main
   78 main              82 ctags.c          main(argc, argv)
   79 $ gozilla +82 ctags.c
   80 $ gozilla -d main
   81 $ gozilla -b lynx +82 ctags.c
   82 @end example
   83 @unnumberedsubsec DIAGNOSTICS
   84 Gozilla exits with a non-0 value if an error occurred, 0 otherwise.
   85 @unnumberedsubsec SEE ALSO
   86 global(1),
   87 gtags(1),
   88 htags(1),
   89 epiphany(1),
   90 firefox(1),
   91 gtags.conf(5).
   92 
   93 GNU GLOBAL source code tag system@*
   94 (http://www.gnu.org/software/global/).
   95 @unnumberedsubsec AUTHORS
   96 Shigio YAMAGUCHI.
   97 @unnumberedsubsec HISTORY
   98 The gozilla command appeared in FreeBSD 2.2.2 but was not
   99 installed by default.