"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/global.info" between
global-6.6.4.tar.gz and global-6.6.5.tar.gz

About: GNU GLOBAL is a source code tag system that works the same way across diverse environments. It is similar to ctags or etags, but it is independent of any editor.

global.info  (global-6.6.4):global.info  (global-6.6.5)
File: global.info, Node: Top, Next: Introduction, Up: (dir) File: global.info, Node: Top, Next: Introduction, Up: (dir)
GNU GLOBAL source code tagging system GNU GLOBAL source code tagging system
************************************* *************************************
This manual documents version 6.6.4 of the GNU GLOBAL source code This manual documents version 6.6.5 of the GNU GLOBAL source code
tagging system. tagging system.
* Menu: * Menu:
* Introduction:: Overview of this tool. * Introduction:: Overview of this tool.
* Command line:: Command line. * Command line:: Command line.
* Applications:: Various applications. * Applications:: Various applications.
* Other topics:: Other topics. * Other topics:: Other topics.
* Reference:: Command References. * Reference:: Command References.
* Copying This Manual:: Copying This Manual. * Copying This Manual:: Copying This Manual.
skipping to change at line 29 skipping to change at line 29
File: global.info, Node: Introduction, Next: Command line, Prev: Top, Up: To p File: global.info, Node: Introduction, Next: Command line, Prev: Top, Up: To p
1 Overview of this tool 1 Overview of this tool
*********************** ***********************
1.1 What is GNU GLOBAL? 1.1 What is GNU GLOBAL?
======================= =======================
GNU GLOBAL is a source code tagging system that works the same way GNU GLOBAL is a source code tagging system that works the same way
across diverse environments, such as Emacs editor, Vi editor, Less across diverse environments, such as Emacs editor, Vi editor, Less
viewer, Bash shell, various web browsers, etc. You can locate specified viewer, Bash shell, various web browsers, etc. You can find the
symbols, such as functions, macros, structs and classes in your source locations of symbols such as functions, macros, structs and classes in
files and move there easily. It is useful for hacking large projects your source code and move there easily. It is useful for hacking a
which contain many sub-directories, many '#ifdef' and many 'main()' large project which contains many sub-directories, many '#ifdef' and
functions. It is similar to ctags or etags, but is different from them many 'main()' functions. It is similar to ctags or etags, but is
at the point of independence of any editor. different from them at the point of independence of any editor.
1.2 Concept of project 1.2 Concept of project
====================== ======================
GNU GLOBAL can treat a source tree containing sub-directories as a GNU GLOBAL can treat a source tree containing sub-directories as a
project. Anywhere in the project, you can utilize a high performance project. Anywhere in the project, you can utilize a high performance
tag database. You need not specify where the database is, as global(1) tag database. You need not specify where the database is, as global(1)
locates it by itself. Because of this feature, you can move freely in a locates it by itself. Because of this feature, you can move freely in a
project, and in and out of many projects. project, and in and out of many projects.
1.3 Features 1.3 Features
============ ============
GNU GLOBAL has the following features: GNU GLOBAL has the following features:
* supports C, C++, Yacc, Java, PHP4 and assembly. * supports C, Yacc, Java, PHP4 and assembly.
* works the same way across diverse environments like follows: * works the same way across diverse environments like follows:
- Shell command line - Shell command line
- Bash shell - Bash shell
- Vi editor (Nvi, Elvis, vim) - Vi editor (Nvi, Elvis, vim)
- Less viewer - Less viewer
- Emacs editor (Emacs, Mule, Xemacs) - Emacs editor (Emacs, Mule, Xemacs)
- Web browser - Web browser
- Doxygen documentation system - Doxygen documentation system
skipping to change at line 569 skipping to change at line 569
(Load editor and show boot/alpha/boot1/boot1.c at line 227.) (Load editor and show boot/alpha/boot1/boot1.c at line 227.)
The default editor is vi(1). You can specify it statically by The default editor is vi(1). You can specify it statically by
'EDITOR' environment variable or temporarily by options. 'EDITOR' environment variable or temporarily by options.
[/usr/src/sys] show -e 3 [/usr/src/sys] show -e 3
(Preloaded emacs show boot/alpha/boot1/boot1.c at line 227.) (Preloaded emacs show boot/alpha/boot1/boot1.c at line 227.)
[/usr/src/sys] show -l 3 [/usr/src/sys] show -l 3
(Load less and show boot/alpha/boot1/boot1.c at line 227.) (Load less and show boot/alpha/boot1/boot1.c at line 227.)
[/usr/src/sys] show -g 3 [/usr/src/sys] show -g 3
(Preloaded mozilla show boot/alpha/boot1/boot1.c at line 227.) (Preloaded firefox show boot/alpha/boot1/boot1.c at line 227.)
Otherwise, you can use the following commands (with abbreviated Otherwise, you can use the following commands (with abbreviated
form): form):
'list (l)' 'list (l)'
print tag list. print tag list.
'first' 'first'
go to the first tag. go to the first tag.
skipping to change at line 1169 skipping to change at line 1169
else it is equivalent to ':Gtags -s CURRENT-TOKEN'. else it is equivalent to ':Gtags -s CURRENT-TOKEN'.
:GtagsCursor :GtagsCursor
Suggested map: Suggested map:
map <C-\>^] :GtagsCursor<CR> map <C-\>^] :GtagsCursor<CR>
Though the mapping of ':GtagsCursor' to '^]' seems suitable, it Though the mapping of ':GtagsCursor' to '^]' seems suitable, it
will bring an inconvenience in the help screen. will bring an inconvenience in the help screen.
* If you have the hypertext generated by htags(1) then you can * If you have a hypertext generated by htags(1) then you can display
display the same part of the source code in the mozilla browser. the same part of the source code in your browser. Let's load
Let's load mozilla and try this: firefox and try this:
:Gozilla :Gozilla
Suggested map: Suggested map:
map <C-g> :Gozilla<CR> map <C-g> :Gozilla<CR>
* If you want to load Vim with all main()s then following command * If you want to load Vim with all main()s then following command
line is useful. line is useful.
$ vim '+Gtags main' $ vim '+Gtags main'
skipping to change at line 1381 skipping to change at line 1381
* Features(browser):: Features. * Features(browser):: Features.
* Preparation(browser):: Preparation. * Preparation(browser):: Preparation.
* Usage(browser):: Usage. * Usage(browser):: Usage.
File: global.info, Node: Features(browser), Next: Preparation(browser), Up: W eb browser File: global.info, Node: Features(browser), Next: Preparation(browser), Up: W eb browser
3.8.1 Features 3.8.1 Features
-------------- --------------
* Htags makes a hypertext from C, C++, Yacc and Java source files. * Htags makes a hypertext from C, Yacc and Java source files.
* Once the hypertext is generated, you need nothing other than a web * Once the hypertext is generated, you need nothing other than a web
browser. browser.
* You can move the hypertext to anywhere; it is independent of the * You can move the hypertext to anywhere; it is independent of the
source code. source code.
* You can use all of your browser's functions, such as search, * You can use all of your browser's functions, such as search,
history, bookmark, save, frames, windows, etc. history, bookmark, save, frames, windows, etc.
File: global.info, Node: Preparation(browser), Next: Usage(browser), Prev: Fe atures(browser), Up: Web browser File: global.info, Node: Preparation(browser), Next: Usage(browser), Prev: Fe atures(browser), Up: Web browser
3.8.2 Preparation 3.8.2 Preparation
skipping to change at line 1437 skipping to change at line 1437
Please start a web browser like this: Please start a web browser like this:
$ lynx HTML/index.html $ lynx HTML/index.html
You will understand the usage by looking at the examples. You will understand the usage by looking at the examples.
You can move the HTML directory to anywhere. It is independent of You can move the HTML directory to anywhere. It is independent of
the source code as long as CGI facility is not used. the source code as long as CGI facility is not used.
Using mozilla, you can also utilize the hypertext from your command Using firefox, you can also utilize the hypertext from your command
line like this: line like this:
$ mozilla # load mozilla
$ global -x main $ global -x main
main 10 main.c main(int argc, char *argv[]) { main 10 main.c main(int argc, char *argv[]) {
$ gozilla +10 main.c # usage is similar to vi editor. $ gozilla +10 main.c # usage is similar to vi editor.
(show main.c at 10 on mozilla's screen.) (show main.c at 10 on your browser.)
But in this case, you must not move the HTML directory from the But in this case, you must not move the HTML directory from the
source directory. source directory.
File: global.info, Node: Doxygen documentation system, Prev: Web browser, Up: Applications File: global.info, Node: Doxygen documentation system, Prev: Web browser, Up: Applications
3.9 Doxygen using GLOBAL 3.9 Doxygen using GLOBAL
======================== ========================
You can use GLOBAL as a source browser of Doxygen. You can use GLOBAL as a source browser of Doxygen.
skipping to change at line 1574 skipping to change at line 1573
5 Command References 5 Command References
******************** ********************
* Menu: * Menu:
* global:: global - print locations of given symbols * global:: global - print locations of given symbols
* gtags:: gtags - create tag files for global * gtags:: gtags - create tag files for global
* htags:: htags - generate a hypertext from a set of source files * htags:: htags - generate a hypertext from a set of source files
* htags-server:: htags-server - a private Web/CGI server for htags * htags-server:: htags-server - a private Web/CGI server for htags
* gozilla:: gozilla - force a browser to display specified part of a sour ce file * gozilla:: gozilla - force firefox to display specified part of a source file
* gtags-cscope:: gtags-cscope - interactively examine a C program * gtags-cscope:: gtags-cscope - interactively examine a C program
* globash:: globash - a special shell for GLOBAL using GNU bash * globash:: globash - a special shell for GLOBAL using GNU bash
* gtags.conf:: gtags.conf - configuration data for GNU GLOBAL * gtags.conf:: gtags.conf - configuration data for GNU GLOBAL
File: global.info, Node: global, Next: gtags, Up: Reference File: global.info, Node: global, Next: gtags, Up: Reference
5.1 global - print locations of given symbols 5.1 global - print locations of given symbols
============================================= =============================================
NAME NAME
skipping to change at line 1604 skipping to change at line 1603
global -f[adlnqrstvx][-L file-list][-S dir] files global -f[adlnqrstvx][-L file-list][-S dir] files
global -g[aEGilMnoOqtvVx][-L file-list][-S dir][-e] pattern [files] global -g[aEGilMnoOqtvVx][-L file-list][-S dir][-e] pattern [files]
global -I[ailMnqtvx][-S dir][-e] pattern global -I[ailMnqtvx][-S dir][-e] pattern
global -P[aEGilMnoOqtvVx][-S dir][-e] pattern global -P[aEGilMnoOqtvVx][-S dir][-e] pattern
global -p[qrv] global -p[qrv]
global -u[qv] global -u[qv]
DESCRIPTION DESCRIPTION
----------- -----------
Global finds locations of given symbols in C, C++, Yacc, Java, PHP and Global finds locations of given symbols in C, Yacc, Java, PHP and
Assembly source files, and prints the path name, line number and line assembly source files, and prints the path name, line number and line
image of the locations. Global can locate not only definitions but also image of the locations. Global can locate not only definitions but also
references and other symbols. references and other symbols.
Global can treat a source tree, that is, a directory that has Global can treat a source tree, that is, a directory that has
sub-directories and source files, as a project. In advance of using sub-directories and source files, as a project. In advance of using
this command, you must execute gtags(1) at the root directory of the this command, you must execute gtags(1) at the root directory of the
project which you want to investigate to make tag files. Then you can project which you want to investigate to make tag files. Then you can
use global command anywhere in the project. You need not specify where use global command anywhere in the project. You need not specify where
the tag file is. Instead, global locates it by itself. the tag file is. Instead, global locates it by itself.
skipping to change at line 1674 skipping to change at line 1673
'-a', '--absolute' '-a', '--absolute'
Print absolute path names. By default, print relative path names. Print absolute path names. By default, print relative path names.
'--color' when '--color' when
Use color to highlight the pattern within the line; when may be one Use color to highlight the pattern within the line; when may be one
of: never, always or auto (default). The default color is bold red of: never, always or auto (default). The default color is bold red
text on current background; the environment variable GREP_COLORS text on current background; the environment variable GREP_COLORS
(only MT and MS are effective at present) or GREP_COLOR defines it. (only MT and MS are effective at present) or GREP_COLOR defines it.
This option is effective to the following commands: <no command>, This option is effective to the following commands: <no command>,
-f, -g, -I, -P. -f, -g, -I, -P.
'-C', '--directory' dir
Change the directory before doing all the work including parameter
analysis.
'-d', '--definition' '-d', '--definition'
Print locations of definitions. Print locations of definitions.
'-e', '--regexp' pattern '-e', '--regexp' pattern
Use pattern as the pattern; useful to protect patterns starting Use pattern as the pattern; useful to protect patterns starting
with '-'. with '-'.
'-E', '--extended-regexp' '-E', '--extended-regexp'
Interpret pattern as a extended regular expression. This is the Interpret pattern as a extended regular expression. This is the
default. default.
'--encode-path' chars '--encode-path' chars
Convert path characters in chars into a '%' symbol, followed by the Convert path characters in chars into a '%' symbol, followed by the
skipping to change at line 1876 skipping to change at line 1878
The directory in which the tag files exist. This value is ignored The directory in which the tag files exist. This value is ignored
when GTAGSROOT is not defined. Use of this variable is not when GTAGSROOT is not defined. Use of this variable is not
recommended. recommended.
GTAGSFORCECPP GTAGSFORCECPP
If this variable is set, each file whose suffix is '.h' is treated If this variable is set, each file whose suffix is '.h' is treated
as a C++ source file. as a C++ source file.
GTAGSLABEL GTAGSLABEL
Configuration label. The default is default. Configuration label. The default is default.
GTAGSLIBPATH GTAGSLIBPATH
If this variable is set, it is used as the path to search for If this variable is set, it is used as the path to search for
library functions. If the given symbol is not found in the library functions. If the given symbol is not found in the current
project, global also searches in these paths. Since only 'GTAGS' project, global also searches in these paths. Since only 'GTAGS'
is targeted in the retrieval, this variable is ignored when '-r' or is targeted in the retrieval, this variable is ignored when '-r' or
'-s' is specified. '-s' is specified.
GTAGSLOGGING GTAGSLOGGING
If this variable is set, '$GTAGSLOGGING' is used as the path name If this variable is set, '$GTAGSLOGGING' is used as the path name
of a log file. There is no default value. of a log file. There is no default value.
GTAGSROOT GTAGSROOT
The root directory of the project. Usually, it is recognized by The root directory of the project. Usually, it is recognized by
existence of 'GTAGS'. Use of this variable is not recommended. existence of 'GTAGS'. Use of this variable is not recommended.
GTAGSTHROUGH GTAGSTHROUGH
skipping to change at line 1941 skipping to change at line 1943
======================================= =======================================
NAME NAME
---- ----
gtags - create tag files for global gtags - create tag files for global
SYNOPSIS SYNOPSIS
-------- --------
gtags [-ciIOqvw][-d tag-file][-f file][dbpath] gtags [-ciIOqvw][-C dir][-d tag-file][-f file][dbpath]
DESCRIPTION DESCRIPTION
----------- -----------
Gtags is used to create tag files for global(1). Gtags is used to create tag files for global(1).
Gtags recursively collects source files under the current directory, Gtags recursively collects source files under the current directory,
picks up symbols and writes the cross-reference data into the tag files picks up symbols and writes the cross-reference data into the tag files
('GTAGS', 'GRTAGS' and 'GPATH'). ('GTAGS', 'GRTAGS' and 'GPATH').
By default, gtags picks up C, Yacc, assembly language, Java, C++ and
PHP source files. Files whose names end in '.c', '.h' are assumed to be
C source files. Files whose names end in '.y' are assumed to be Yacc
source files. Files whose names end in '.s', '.S' are assumed to be
assembly language source files. Files whose names end in '.java' are
assumed to be Java source files. Files whose names end in '.c++',
'.cc', '.hh', '.cpp', '.cxx', '.hxx', '.hpp', '.C', '.H' are assumed to
be C++ source files. Files whose names end in '.php', '.php3', '.phtml'
are assumed to be PHP source files. Other files are assumed to be text
files. Gtags does not treat binary files.
If 'gtags.files' exists in the current directory or a file is If 'gtags.files' exists in the current directory or a file is
specified by the '-f' option, target files are limited by it. Lines specified by the '-f' option, target files are limited by it. Lines
starting with '. ' are comments. starting with '. ' are comments.
C, yacc, Assembly, Java, C++ and PHP source files are supported.
Files whose names end in '.c', '.h' are assumed to be C source files.
Files whose names end in '.y' are assumed to be yacc source files.
Files whose names end in '.s', '.S' are assumed to be Assembly source
files. Files whose names end in '.java' are assumed to be Java source
files. Files whose names end in '.c++', '.cc', '.hh', '.cpp', '.cxx',
'.hxx', '.hpp', '.C', '.H' are assumed to be C++ source files. Files
whose names end in '.php', '.php3', '.phtml' are assumed to be PHP
source files. Other files are assumed to be text files. Gtags does not
treat binary files.
OPTIONS OPTIONS
------- -------
The following options are available: The following options are available:
'--accept-dotfiles' '--accept-dotfiles'
Accept files and directories whose names begin with a dot. By Accept files and directories whose names begin with a dot. By
default, gtags ignores them. default, gtags ignores them.
'-c', '--compact' '-c', '--compact'
Make 'GTAGS' in compact format. This option does not influence Make 'GTAGS' in compact format. This option does not influence
'GRTAGS', because that is always made in compact format. 'GRTAGS', because that is always made in compact format.
'-C', '--directory' dir
Change the directory before doing all the work including parameter
analysis. This option is ignored in GTAGS_OPTIONS. Please specify
it on the command line directly.
'--config'[=name] '--config'[=name]
Print the value of config variable name. If name is not specified Print the value of config variable name. If name is not specified
then print all names and values. In addition to the variables then print all names and values. In addition to the variables
listed in the ENVIRONMENT section, you can refer to install listed in the ENVIRONMENT section, you can refer to install
directories by read only variables: BINDIR, LIBDIR, DATADIR, directories by read only variables: BINDIR, LIBDIR, DATADIR,
LOCALSTATEDIR and SYSCONFDIR. LOCALSTATEDIR and SYSCONFDIR.
'-d', '--dump' tag-file '-d', '--dump' tag-file
Dump a tag file as text to the standard output. Output format is Dump a tag file as text to the standard output. Output format is
'key<tab>data'. This is for debugging. 'key<tab>data'. This is for debugging.
'--explain' '--explain'
skipping to change at line 1999 skipping to change at line 2005
'-f', '--file' file '-f', '--file' file
Give a list of candidates of target files. Files which are not on Give a list of candidates of target files. Files which are not on
the list are ignored. The argument file can be set to '-' to the list are ignored. The argument file can be set to '-' to
accept a list of files from the standard input. File names must be accept a list of files from the standard input. File names must be
separated by newline. To make the list you may use find(1), which separated by newline. To make the list you may use find(1), which
has rich options for selecting files. has rich options for selecting files.
'--gtagsconf' file '--gtagsconf' file
Set environment variable GTAGSCONF to file. Set environment variable GTAGSCONF to file.
'--gtagslabel' label '--gtagslabel' label
Set environment variable GTAGSLABEL to label. Set environment variable GTAGSLABEL to label.
'--help'
Print a usage message.
'-I', '--idutils' '-I', '--idutils'
In addition to tag files, make ID database for idutils(1). In addition to tag files, make ID database for idutils(1).
'-i', '--incremental' '-i', '--incremental'
Update tag files incrementally. It's better to use global(1) with Update tag files incrementally. It's better to use global(1) with
the '-u' command. the '-u' command.
'-O', '--objdir' '-O', '--objdir'
Use BSD-style obj directory as the location of tag files. If Use BSD-style obj directory as the location of tag files. If
GTAGSOBJDIRPREFIX is set and '$GTAGSOBJDIRPREFIX' directory exists, GTAGSOBJDIRPREFIX is set and '$GTAGSOBJDIRPREFIX' directory exists,
gtags creates '$GTAGSOBJDIRPREFIX/<current directory>' directory gtags creates '$GTAGSOBJDIRPREFIX/<current directory>' directory
and makes tag files in it. Though you can use MAKEOBJDIRPREFIX and makes tag files in it. Though you can use MAKEOBJDIRPREFIX
skipping to change at line 2031 skipping to change at line 2039
'--sqlite3' '--sqlite3'
Use Sqlite 3 API to make tag files. By default, BSD/DB 1.85 API is Use Sqlite 3 API to make tag files. By default, BSD/DB 1.85 API is
used. To use this option, you need to invoke configure script with used. To use this option, you need to invoke configure script with
'--with-sqlite3' in the build phase. '--with-sqlite3' in the build phase.
'--statistics' '--statistics'
Print statistics information. Print statistics information.
'-q', '--quiet' '-q', '--quiet'
Quiet mode. Quiet mode.
'-v', '--verbose' '-v', '--verbose'
Verbose mode. Verbose mode.
'--version'
Show version number.
'-w', '--warning' '-w', '--warning'
Print warning messages. Print warning messages.
dbpath dbpath
The directory in which tag files are generated. The default is the The directory in which tag files are generated. The default is the
current directory. current directory.
EXAMPLES EXAMPLES
-------- --------
$ ls -F $ ls -F
skipping to change at line 2124 skipping to change at line 2134
the shared object path, an optional colon followed by a function the shared object path, an optional colon followed by a function
name. If the function name is not specified, 'parser' is assumed. name. If the function name is not specified, 'parser' is assumed.
As a special exception, gtags collects values from multiple As a special exception, gtags collects values from multiple
'gtags_parser' variables. For these mappings, the first match is 'gtags_parser' variables. For these mappings, the first match is
adopted. adopted.
'gtags_hook' (command line) 'gtags_hook' (command line)
Specify a command line which should be executed at the beginning of Specify a command line which should be executed at the beginning of
gtags after loading configuration file. You can use this hook to gtags after loading configuration file. You can use this hook to
update 'gtags.files' dynamically. "./" in it always means the update 'gtags.files' dynamically. "./" in it always means the
project root directory, since gtags is always invoked there. project root directory, since gtags is always invoked there.
This hook is ignored when the following options are specified:
-version, -help, -config, -dump.
'icase_path' (boolean) 'icase_path' (boolean)
Ignore case distinctions in the path. Suffixes check is affected Ignore case distinctions in the path. Suffixes check is affected
by this capability. by this capability.
'langmap' (comma separated list) 'langmap' (comma separated list)
Language mapping. Each comma-separated map consists of a language Language mapping. Each comma-separated map consists of a language
name, a colon, and a list of file extensions. You can specify a name, a colon, and a list of file extensions. You can specify a
glob pattern surrounded by parentheses instead of an extension for glob pattern surrounded by parentheses instead of an extension for
the files without extensions (e.g. Make:([Mm]akefile).mak.mk). As the files without extensions (e.g. Make:([Mm]akefile).mak.mk). As
a special exception, gtags collects values from multiple 'langmap' a special exception, gtags collects values from multiple 'langmap'
variables. For these mappings, the first match is adopted. variables. For these mappings, the first match is adopted.
skipping to change at line 2174 skipping to change at line 2186
GNU GLOBAL source code tag system GNU GLOBAL source code tag system
(http://www.gnu.org/software/global/). (http://www.gnu.org/software/global/).
BUG BUG
--- ---
'GTAGS' and 'GRTAGS' are very large. In advance of using this command, 'GTAGS' and 'GRTAGS' are very large. In advance of using this command,
check the space of your disk. check the space of your disk.
Assembly support is far from complete. It extracts only 'ENTRY()' Assembly language support is far from complete. It extracts only
and 'ALTENTRY()' from source file. Probably valid only for FreeBSD and 'ENTRY()' and 'ALTENTRY()' from source file. Probably valid only for
Linux kernel source. FreeBSD and Linux kernel source.
C++ support is deprecated.
There is no concurrency control about tag files. There is no concurrency control about tag files.
AUTHOR AUTHOR
------ ------
Shigio YAMAGUCHI, Hideki IWAMOTO and others. Shigio YAMAGUCHI, Hideki IWAMOTO and others.
HISTORY HISTORY
------- -------
skipping to change at line 2208 skipping to change at line 2222
htags - generate a hypertext from a set of source files htags - generate a hypertext from a set of source files
SYNOPSIS SYNOPSIS
-------- --------
htags [-aDfFghInosTvw][-d dbpath][-m name][-t title][dir] htags [-aDfFghInosTvw][-d dbpath][-m name][-t title][dir]
DESCRIPTION DESCRIPTION
----------- -----------
Htags generates a hypertext from a set of source files of C, C++, Yacc, Htags generates a hypertext from a set of source files of C, Yacc, Java,
Java, PHP and Assembly. PHP and assembly.
In advance of using this command, you should execute gtags(1) in the In advance of using this command, you should execute gtags(1) in the
root directory of a source project. Then you can execute htags in the root directory of a source project. Then you can execute htags in the
same place. Htags makes a directory named 'HTML', and puts a hypertext same place. Htags makes a directory named 'HTML', and puts a hypertext
in it. You can start browsing at 'HTML/index.html'. in it. You can start browsing at 'HTML/index.html'.
Since htags generates a static hypertext as long as neither '-D' nor Since htags generates a static hypertext as long as neither '-D' nor
'-f' option is not specified, you can move it anywhere and browse it by '-f' option is not specified, you can move it anywhere and browse it by
any browser without any HTTP server. If you use '-D' or '-f' option, any browser without any HTTP server. If you use '-D' or '-f' option,
you need to use HTTP server. Though any HTTP server is available, you need to use HTTP server. Though any HTTP server is available,
skipping to change at line 2237 skipping to change at line 2251
------- -------
The following options are available: The following options are available:
'-a', '--alphabet' '-a', '--alphabet'
Make an alphabetical index suitable for a large project. Make an alphabetical index suitable for a large project.
'--auto-completion'[=limit] '--auto-completion'[=limit]
Enable auto-completion facility for the input form. If limit is Enable auto-completion facility for the input form. If limit is
specified, number of candidates is limited to the value. Please specified, number of candidates is limited to the value. Please
note this function requires javascript language in your browser. note this function requires javascript language in your browser.
'-C', '--directory' dir
Change the directory before doing all the work including parameter
analysis.
'--caution' '--caution'
Display a caution message on the top page. Display a caution message on the top page.
'--cflow' cflowfile '--cflow' cflowfile
Add a call tree by cflow(1). cflowfile must be posix format. If Add a call tree by cflow(1). cflowfile must be posix format. If
you use GNU cflow, invoke the command at the project root directory you use GNU cflow, invoke the command at the project root directory
with the '--format=posix' option. This option is deprecated; with the '--format=posix' option. This option is deprecated;
please use '--call-tree' or '--callee-tree' instead. please use '--call-tree' or '--callee-tree' instead.
'--call-tree' callfile '--call-tree' callfile
Add a call tree by cflow(1); callfile must be posix format. If you Add a call tree by cflow(1); callfile must be posix format. If you
use GNU cflow, invoke the command at the project root directory use GNU cflow, invoke the command at the project root directory
skipping to change at line 2293 skipping to change at line 2310
Execute gtags(1) before starting job. The '-v', '-w' and dbpath Execute gtags(1) before starting job. The '-v', '-w' and dbpath
options are passed to gtags. options are passed to gtags.
'--gtagsconf' file '--gtagsconf' file
Set environment variable GTAGSCONF to file. Set environment variable GTAGSCONF to file.
'--gtagslabel' label '--gtagslabel' label
Set environment variable GTAGSLABEL to label. Set environment variable GTAGSLABEL to label.
'-h', '--func-header'[=position] '-h', '--func-header'[=position]
Insert a function header for each function. By default, htags Insert a function header for each function. By default, htags
doesn't generate them. You can choose the position using position, doesn't generate them. You can choose the position using position,
which allows one of 'before', 'right' or 'after' (default). which allows one of 'before', 'right' or 'after' (default).
'--help'
Print a usage message.
'--html-header' file '--html-header' file
Insert a header record derived from file into the HTML header of Insert a header record derived from file into the HTML header of
each file. each file.
'-I', '--icon' '-I', '--icon'
Use icons instead of text for some links. Use icons instead of text for some links.
'--insert-footer' file '--insert-footer' file
Insert custom footer derived from file before '</body>' tag. Insert custom footer derived from file before '</body>' tag.
'--insert-header' file '--insert-header' file
Insert custom header derived from file after '<body>' tag. Insert custom header derived from file after '<body>' tag.
'--item-order' spec '--item-order' spec
skipping to change at line 2353 skipping to change at line 2372
'--table-list' '--table-list'
Use '<table>' tag to display the tag list. Use '<table>' tag to display the tag list.
'--tree-view'[=type] '--tree-view'[=type]
Use treeview for the file index. Please note this function Use treeview for the file index. Please note this function
requires javascript language in your browser. Possible values of requires javascript language in your browser. Possible values of
type are as follows: treeview, filetree, treeview-red, type are as follows: treeview, filetree, treeview-red,
treeview-black, treeview-gray, treeview-famfamfam. The default is treeview-black, treeview-gray, treeview-famfamfam. The default is
treeview. treeview.
'-v', '--verbose' '-v', '--verbose'
Verbose mode. Verbose mode.
'--version'
Show version number.
'-w', '--warning' '-w', '--warning'
Print warning messages. Print warning messages.
dir dir
The directory in which the result of this command is stored. The The directory in which the result of this command is stored. The
default is the current directory. default is the current directory.
EXAMPLES EXAMPLES
-------- --------
$ gtags -v $ gtags -v
skipping to change at line 2562 skipping to change at line 2583
Shigio YAMAGUCHI. Shigio YAMAGUCHI.
HISTORY HISTORY
------- -------
The htags-server command appeared in GLOBAL-6.3 (2014). The htags-server command appeared in GLOBAL-6.3 (2014).
File: global.info, Node: gozilla, Next: gtags-cscope, Prev: htags-server, Up : Reference File: global.info, Node: gozilla, Next: gtags-cscope, Prev: htags-server, Up : Reference
5.5 gozilla - force a browser to display specified part of a source file 5.5 gozilla - force firefox to display specified part of a source file
======================================================================== ======================================================================
NAME NAME
---- ----
gozilla - force a browser to display specified part of a source file gozilla - force firefox to display specified part of a source file
SYNOPSIS SYNOPSIS
-------- --------
gozilla [-b browser][-p][+no] file gozilla [-b browser][-p][+no] file
gozilla [-b browser][-p] -d name gozilla [-b browser][-p] -d name
DESCRIPTION DESCRIPTION
----------- -----------
Gozilla forces firefox to display specified part of a source file. Gozilla forces firefox to display specified part of a source file.
Gozilla can be used with other browsers like chrome and epiphany. Gozilla can be used with other browsers like chrome.
In advance of using this command, you must execute gtags(1) and In advance of using this command, you must execute gtags(1) and
htags(1) at the root directory of the project to make tag files. Then htags(1) at the root directory of the project to make tag files. Then
you can execute this command anywhere in the project. you can execute this command anywhere in the project.
First form: First form:
You can specify a source file and optional line number. This syntax is You can specify a source file and optional line number. This syntax is
similar to vi(1) and emacs(1). similar to vi(1) and emacs(1).
Second form: Second form:
skipping to change at line 2664 skipping to change at line 2685
$ gozilla -b lynx +82 ctags.c $ gozilla -b lynx +82 ctags.c
DIAGNOSTICS DIAGNOSTICS
----------- -----------
Gozilla exits with a non-0 value if an error occurred, 0 otherwise. Gozilla exits with a non-0 value if an error occurred, 0 otherwise.
SEE ALSO SEE ALSO
-------- --------
global(1), gtags(1), htags(1), epiphany(1), mozilla(1), firefox(1), global(1), gtags(1), htags(1), epiphany(1), firefox(1), gtags.conf(5).
gtags.conf(5).
GNU GLOBAL source code tag system GNU GLOBAL source code tag system
(http://www.gnu.org/software/global/). (http://www.gnu.org/software/global/).
AUTHORS AUTHORS
------- -------
Shigio YAMAGUCHI. Shigio YAMAGUCHI.
HISTORY HISTORY
skipping to change at line 3136 skipping to change at line 3156
(3) [project root]/gtags.conf (3) [project root]/gtags.conf
(4) [project root]/[objdir]/gtags.conf (4) [project root]/[objdir]/gtags.conf
(5) $HOME/.globalrc (5) $HOME/.globalrc
(6) /etc/gtags.conf (6) /etc/gtags.conf
(7) [sysconfdir]/gtags.conf (7) [sysconfdir]/gtags.conf
[sysconfdir] is '/usr/local/etc' by default; you can change it by the [sysconfdir] is '/usr/local/etc' by default; you can change it by the
-sysconfdir option of the configure script. [objdir] is 'obj' by -sysconfdir option of the configure script. [objdir] is 'obj' by
default; you can change it by GTAGSOBJDIR or MAKEOBJDIR. default; you can change it by GTAGSOBJDIR or MAKEOBJDIR.
Syntax is similar to termcap(5) except for some extensions described Its syntax is similar to termcap(5) except for some extensions
later. A file includes one or more records. You should select a record described later. A file includes one or more records. You should
using a label. Default label is 'default'. If GTAGSLABEL is set, its select a record using a label. Default label is 'default'. If
value is used. Please be aware the meaning of 'default' is different GTAGSLABEL is set, its value is used. Please be aware the meaning of
from that of termcap(5). 'default' is different from that of termcap(5).
Lines starting with '#' are ignored. A record consists of one or Lines starting with '#' are ignored. A record consists of one or
more fields separated by ':' and ends with a newline. The first field more fields separated by ':' and ends with a newline. The first field
must have a label name. Each field of the rest has a variable must have a label name. Each field of the rest has a variable
definition. There are three types in those variables. definition. There are three types in those variables.
Boolean: This type has no value; existence of variable means true else false. Boolean: This type has no value; existence of variable means true else false.
Number: This type has a number value after '#'. Number: This type has a number value after '#'.
String: This type has a string value after '='. String: This type has a string value after '='.
Most variables are relevant to string type. Most variables are relevant to string type.
skipping to change at line 3170 skipping to change at line 3190
Variable substitution similar to sh(1) is available. You can refer to Variable substitution similar to sh(1) is available. You can refer to
any string variable using '$' prefix. For example, the following b has any string variable using '$' prefix. For example, the following b has
a value 'XYZ'. a value 'XYZ'.
:a=Y:b=X${a}Z: :a=Y:b=X${a}Z:
Including another record Including another record
------------------------ ------------------------
Tc is a special variable; it reads in definitions in another record. It Tc is a special variable; it reads in definitions in another record. It
is similar to the tc of termcap(5). Syntax is as follows: is similar to the tc of termcap(5). Its syntax is as follows:
tc=label[@file] tc=label[@file]
If only a label is given, tc is read from a record specified by the If only a label is given, tc is read from a record specified by the
label in the same file. If @file is also given, tc is read from a label in the same file. If @file is also given, tc is read from a
record specified by the label in the specified file. File should be an record specified by the label in the specified file. File should be an
absolute path, and should not include variables. Different from absolute path, and should not include variables. Different from
termcap(5), you can use tc anytime anywhere. termcap(5), you can use tc anytime anywhere.
CONFIGURATION CONFIGURATION
------------- -------------
 End of changes. 31 change blocks. 
49 lines changed or deleted 69 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)