"Fossies" - the Fresh Open Source Software Archive

Member "global-6.6.5/gozilla/manual.in" (3 Sep 2020, 3869 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 "manual.in": 6.6.4_vs_6.6.5.

    1 #
    2 # Copyright (c) 1996, 1997, 1998, 1999, 2000, 2002, 2006, 2010
    3 #	Tama Communications Corporation
    4 #
    5 # This file is part of GNU GLOBAL.
    6 #
    7 # This program is free software: you can redistribute it and/or modify
    8 # it under the terms of the GNU General Public License as published by
    9 # the Free Software Foundation, either version 3 of the License, or
   10 # (at your option) any later version.
   11 # 
   12 # This program is distributed in the hope that it will be useful,
   13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
   14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   15 # GNU General Public License for more details.
   16 # 
   17 # You should have received a copy of the GNU General Public License
   18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
   19 #
   20 # This file is converted to the following files:
   21 #       o command source file (for usage and help).
   22 #       o man format reference manual.
   23 #       o texinfo format reference manual.
   24 #
   25 @HEADER GOZILLA,1,March 2010,GNU Project
   26 @NAME   gozilla - force firefox to display specified part of a source file
   27 @SYNOPSIS
   28 	@name{gozilla} [-b browser][-p][+no] file
   29 	@name{gozilla} [-b browser][-p] -d name
   30 @DESCRIPTION
   31 	@name{Gozilla} forces firefox to display specified part of a source file.
   32 	@name{Gozilla} can be used with other browsers like chrome.
   33 
   34 	In advance of using this command, you must execute @xref{gtags,1}
   35 	and @xref{htags,1} at the root directory of the project to make tag files.
   36 	Then you can execute this command anywhere in the project.
   37 
   38 	First form:@br
   39 	You can specify a source file and optional line number.
   40 	This syntax is similar to @xref{vi,1} and @xref{emacs,1}.
   41 
   42 	Second form:@br
   43 	You can specify a definition name directly. The definition name should
   44 	exist in @file{GTAGS}. This option requires @file{HTML/MAP} generated
   45 	by @xref{htags,1}.
   46 
   47 	Some browsers require you to load it before executing @name{gozilla}.
   48 @OPTIONS
   49 	The following options are available:
   50 	@begin_itemize
   51 	@item{@option{+no}}
   52 		Line number.
   53 	@item{@option{-b} @arg{browser}}
   54 		Browser to use. By default, it is assumed @name{firefox}.
   55 	@item{@option{-d} @arg{name}}
   56 		Print definitions.
   57 	@item{@option{--help}}
   58 		Show help.
   59 	@item{@option{-p}}
   60 		Just print a generated URL instead of displaying it.
   61 	@item{@arg{file}}
   62 		File name or alias name.
   63 	@item{@option{-q}, @option{--quiet}}
   64 		Quiet mode.
   65 	@item{@option{-v}, @option{--verbose}}
   66 		Verbose mode.
   67 	@item{@option{--version}}
   68 		Show version number.
   69 	@end_itemize
   70 @FILES
   71 	@begin_itemize
   72 	@item{@file{GTAGS}}
   73 		Tag file for definitions.
   74 	@item{@file{HTML/}}
   75 		Hypertext of source code.
   76 	@item{@file{HTML/MAP}}
   77 		Mapping file for converting tag name into the path of tag list.
   78 	@item{@file{gtags.conf}, @file{$HOME/.globalrc}}
   79 		Configuration data for GNU GLOBAL.
   80 		See @xref{gtags.conf,5}.
   81 	@end_itemize
   82 @ENVIRONMENT
   83 	@begin_itemize
   84 	@item{@var{BROWSER}}
   85 		Browser to use. By default, it is assumed @name{firefox}.
   86 		If you want to load the default browser in OSX, you may set this variable
   87 		to @name{osx-default}.
   88 	@item{@var{GTAGSDBPATH}}
   89 		The directory in which the tag files exist.
   90 		This value is ignored when @var{GTAGSROOT} is not defined.
   91 	@item{@var{GTAGSROOT}}
   92 		The root directory of the project.
   93 	@end_itemize
   94 @EXAMPLES
   95 	@begin_verbatim
   96 	$ gtags
   97 	$ htags
   98 	$ global -x main
   99 	main              82 ctags.c          main(argc, argv)
  100 	$ gozilla +82 ctags.c
  101 	$ gozilla -d main
  102 
  103 	$ gozilla -b lynx +82 ctags.c
  104 	@end_verbatim
  105 @DIAGNOSTICS
  106 	@name{Gozilla} exits with a non-0 value if an error occurred, 0 otherwise.
  107 @SEE ALSO
  108 	@xref{global,1},
  109 	@xref{gtags,1},
  110 	@xref{htags,1},
  111 	@xref{epiphany,1},
  112 	@xref{firefox,1},
  113 	@xref{gtags.conf,5}.
  114 
  115 	GNU GLOBAL source code tag system@br
  116 	(http://www.gnu.org/software/global/).
  117 @AUTHORS
  118 	Shigio YAMAGUCHI.
  119 @HISTORY
  120 	The @name{gozilla} command appeared in FreeBSD 2.2.2 but was not
  121 	installed by default.