This is global.info, produced by makeinfo version 4.8 from global.texi. INFO-DIR-SECTION Development START-INFO-DIR-ENTRY * GLOBAL: (global). GNU GLOBAL source code tag system. END-INFO-DIR-ENTRY This file documents the GNU GLOBAL source code tag system. Copyright (c) 2000, 2001, 2002, 2003, 2004, 2005, 2006 Tama Communications Corporation Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".  File: global.info, Node: Top, Next: Introduction, Up: (dir) GNU GLOBAL source code tag system ********************************* This manual documents version 5.6.2 of the GNU GLOBAL source code tag system. * Menu: * Introduction:: Overview of the tools. * Global:: Command line GLOBAL. * Applications:: Various applications. * Other topics:: Other topics. * Reference:: Command References. * Copying This Manual:: Copying This Manual. * Business Model:: Business Model for Free Software. * Index:: Option index.  File: global.info, Node: Introduction, Next: Global, Prev: Top, Up: Top 1 Overview of the tools *********************** 1.1 What is this? ================= GLOBAL is a source code tagging system (like ctags/etags) that is compatible with numerous application environments including vi, emacs, less, bash. You can locate specified object in source files and move there easily. It is useful for hacking a large project containing many subdirectories, many `#ifdef' and many `main()' functions. 1.2 Concept of project. ======================= GNU GLOBAL can treat a source tree containing subdirectories as a project. It is similar to CVS. You need not specify where the tag file is. Instead, global(1) will locate the tag file by itself. If tag file isn't found in the current directory, global(1) search parent directories for tag file. User's position (current directory) is the first argument for GLOBAL's command. 1.3 Features. ============= GNU GLOBAL has following features: * support C, C++, Yacc, Java, PHP4 and assembly. * work the same way across diverse environments. Currently, support followings: - Shell command line - Bash shell. - Vi editor clone (nvi, elvis, vim) - Less viewer - Emacs editor (emacs, mule, xemacs) - Glimmer editor - Web browser - Doxygen documentation system * find the locations of specified object quickly. * locate not only object definitions but also object references. * allows duplicate objects. * locate also path which includes specified pattern. * search not only in a source tree but also in library paths. * understand POSIX 1003.2 regular expressions. * support external search engine (grep and idutils). * generate hypertext of source code. * tag files are independent of machine architecture. * plugin parser is available to treat new language. * support incremental updating of tag files. * support customizing with gtags.conf. * generate completion list for completing input method.  File: global.info, Node: Global, Next: Applications, Prev: Introduction, Up: Top 2 Command line GLOBAL ********************* You can use tag facilities from shell command line. It is a big merit of GLOBAL compared with any other tag system. * Menu: * Preparation:: Preparation. * Basic usage:: Basic usage. * Applied usage:: Applied usage.  File: global.info, Node: Preparation, Next: Basic usage, Up: Global 2.1 Preparation. ================ First of all, you must execute gtags(1)(*note gtags::) at the root of source tree. For example, if you want to browse vi's source code: $ cd /usr/src/usr.bin/vi $ gtags Gtags traverse subdirectories and makes four databases at the root of the source tree. $ ls G* GPATH GRTAGS GSYMS GTAGS * `GTAGS' database of object definitions * `GRTAGS' database of object references * `GSYMS' database of other symbols * `GPATH' database of path names You should prepare for considerable disk space for tag files. For example, FreeBSD 7.0 kernel source code requires: source code(/usr/src/sys) 123MB GPATH 1MB GTAGS 24MB GRTAGS 28MB GSYMS 32MB ------------------------------------- total of tag files 85MB  File: global.info, Node: Basic usage, Next: Applied usage, Prev: Preparation, Up: Global 2.2 Basic usage. ================ Consider the following source tree: ROOT/ <- the root of source tree (GTAGS,GRTAGS,...) | |- DIR1/ | | | |- fileA.c ..... +---------------+ | | |main(){ | | | | func1();| | | | func2();| | | |} | | | +---------------+ | | | |- fileB.c ..... +---------------+ | |func1(){ ... } | | +---------------+ |- DIR2/ | |- fileC.c ..... +---------------+ |#ifdef X | |func2(){ i++; }| |#else | |func2(){ i--; }| |#endif | |func3(){ | | func1();| |} | +---------------+ * You can get the relative path of your object from anywhere in the source tree. You need not specify where the tag file is. Global will locate the tag file by itself. $ cd ROOT $ global func1 DIR1/fileB.c # func1() is defined in fileB.c $ cd DIR1 $ global func1 fileB.c # relative path from DIR1 $ cd ../DIR2 $ global func1 ../DIR1/fileB.c # relative path from DIR2 * The `-r' option locates object references. $ global -r func2 ../DIR1/fileA.c # func2() is referred from fileA.c * You can use POSIX regular expressions. $ cd ROOT $ global 'func[1-3]' DIR1/fileB.c # func1, func2 and func3 are matched DIR2/fileC.c * The `-x' option shows the details. It is similar to the `-x' option in ctags(1). $ global func2 DIR2/fileC.c $ global -x func2 func2 2 DIR2/fileC.c func2(){ i++; } func2 4 DIR2/fileC.c func2(){ i--; } * The `-a' option produces the absolute path name. $ global -a func1 /home/user/ROOT/DIR1/fileB.c * The -s command locates any symbols which are not defined in `GTAGS'. $ global -xs X X 1 DIR2/fileC.c #ifdef X * The -g command locates any patterns including symbols. It is similar to grep(1). $ global -xg '#ifdef' #ifdef 1 DIR2/fileC.c #ifdef X * The -P command enables you to locate path which includes specified string. $ global -P fileB DIR1/fileB.c $ global -P '1/' DIR1/fileA.c DIR1/fileB.c $ global -P '\.c$' DIR1/fileA.c DIR1/fileB.c DIR2/fileC.c * The -f command enables you see the list of objects of specified file. $ global -f DIR2/fileC.c func2 2 DIR2/fileC.c func2(){ i++; } func2 4 DIR2/fileC.c func2(){ i--; } func3 6 DIR2/fileC.c func3(){  File: global.info, Node: Applied usage, Prev: Basic usage, Up: Global 2.3 Applied usage. ================== You can make multiple tag files. For example, you can execute gtags at ROOT/, version1.0/ and version2.0/. ROOT/ <- the root of source tree (GTAGS,...) | |- version1.0/ <- the root of version1.0 (GTAGS,...) | | | |- file.c ..... +---------------+ | |func1(){ i++; }| | +---------------+ | |- version2.0/ <- the root of version2.0 (GTAGS,...) | |- file.c ..... +---------------+ |func1(){ i--; }| +---------------+ * When you are in the version1.0 directory, global will only locate objects that are in version1.0. $ cd ROOT/version1.0 $ global -x func1 func1 1 file.c func1(){ i++; } * When you are in the version2.0, global will only locate objects that are in version2.0. $ cd ROOT/version2.0 $ global -x func1 func1 1 file.c func1(){ i--; } * If you are at ROOT/, or you set the `GTAGSROOT' environment variable to ROOT, then global will locate objects in both directories. $ cd ROOT $ global -x func1 func1 1 version1.0/file.c func1(){ i++; } func1 1 version2.0/file.c func1(){ i--; } There is another usage of `GTAGSROOT'. * If your source files are on a read-only device, such as CDROM, then you cannot make databases at the root of the source tree. In such cases, please do the following: $ mkdir /var/dbpath $ cd /cdrom/src # the root of source tree $ gtags /var/dbpath # make tag file in /var/dbpath $ export GTAGSROOT=`pwd` $ export GTAGSDBPATH=/var/dbpath $ global func * If you want all references to an object that is not defined in the source tree to be treated as calls to library functions or system calls, then you can specify library directories with the `GTAGSLIBPATH' environment variable. You should execute gtags at each directory of the path. If `GTAGS' is not found in a directory, global ignores that directory. $ pwd /develop/src/mh # this is the source tree $ gtags $ ls G*TAGS GRTAGS GTAGS $ global mhl uip/mhlsbr.c # mhl() is found $ global strlen # strlen() is not found $ (cd /usr/src/lib; gtags) # library source $ (cd /usr/src/sys; gtags) # kernel source $ export GTAGSLIBPATH=/usr/src/lib:/usr/src/sys $ global strlen ../../../usr/src/lib/libc/string/strlen.c # found in library $ global access ../../../usr/src/sys/kern/vfs_syscalls.c # found in kernel Of course, the user program does not call kernel functions directly, but at least it is useful. * If you forget a object name, you can use the -c (complete) command. $ global -c kmem # maybe k..k.. kmem.. kmem_alloc kmem_alloc_pageable kmem_alloc_wait kmem_free kmem_free_wakeup kmem_init kmem_malloc kmem_suballoc # This is what I need! $ global kmem_suballoc ../vm/vm_kern.c * You can use the -c command with complete command in shell. In bash: $ funcs() > { > local cur > cur=${COMP_WORDS[COMP_CWORD]} > COMPREPLY=(`global -c $cur`) > } $ complete -F funcs global $ global kmem_TABTAB kmem_alloc kmem_alloc_wait kmem_init kmem_alloc_nofault kmem_free kmem_malloc kmem_alloc_pageable kmem_free_wakeup kmem_suballoc $ global kmem_sTAB $ global kmem_suballoc ../vm/vm_kern.c In tcsh: % set funcs=(`global -c`) % complete global 'n/*/$funcs/' % global kmem_TAB kmem_alloc kmem_free_wakeup kmem_alloc_pageable kmem_init kmem_alloc_wait kmem_malloc kmem_free kmem_suballoc % global kmem_sTAB % global kmem_suballoc ../vm/vm_kern.c * You can edit all files that include specified object by typing one command, for example: $ vi `global func1` # edit fileB.c * If you want to browse many files in order, do the following: $ global -xr fork | awk '{printf "view +%s %s\n",$2,$3}' view +650 ../dev/aic7xxx/aic7xxx_asm.c view +250 ibcs2/ibcs2_misc.c view +401 linux/linux_misc.c view +310 ../kern/init_main.c view +318 ../kern/init_main.c view +336 ../kern/init_main.c view +351 ../kern/init_main.c $ !! | sh # from now on, go to next tag with 'ZZ'.  File: global.info, Node: Applications, Next: Other topics, Prev: Global, Up: Top 3 Various applications ********************** * Menu: * GloBash:: Global facility for Bash. * Less viewer:: Less using GLOBAL. * Nvi-1.79 editor:: Extended nvi-1.79 using GLOBAL. * Nvi-1.81.5 editor:: nvi-1.81.5 using GLOBAL. * Elvis editor:: Elvis using GLOBAL. * Vim editor:: Vim using GLOBAL. * Emacs editor:: Extended emacs using GLOBAL. * Web browser:: Hypertext generator. * Doxygen documentation system:: Doxygen using GLOBAL.  File: global.info, Node: GloBash, Next: Less viewer, Up: Applications 3.1 Global facility for Bash ============================ Special support for bash is available. * Menu: * Features(globash):: Features. * Preparation(globash):: Preparation. * Basic usage(globash):: Basic usage. * Applied usage(globash):: Applied usage.  File: global.info, Node: Features(globash), Next: Preparation(globash), Up: GloBash 3.1.1 Features. --------------- * Vi-like tag stack is available. * Emacs-like tag name completion is available. * Editor or viewer is automatically invoked. * Tag mark facility is available. * Yor can manage directory list by cookie facility.  File: global.info, Node: Preparation(globash), Next: Basic usage(globash), Prev: Features(globash), Up: GloBash 3.1.2 Preparation. ------------------ First, do the preparation of global. *Note Preparation::. And you can invoke bash(1) with --rcfile option. $ bash --rcfile /usr/local/share/gtags/globash.rc You will see a prompt like this: [/usr/src/sys]/kern _ This prompt means that the current directory is '/usr/src/sys/kern' and the root of the source tree is '/usr/src/sys'. Tag and marker are valid only in a project. When you get out of the project, globash warns like: [/usr/src/sys] cd .. You are going to get out of current project. Tag stack and marker will be removed. Sure? ([y]/n)_ If you answer 'y' and `RET' or just `RET' in above example then tag stack and marker will be removed. If you need help then please type 'ghelp'.  File: global.info, Node: Basic usage(globash), Next: Applied usage(globash), Prev: Preparation(globash), Up: GloBash 3.1.3 Basic usage. ------------------ * Almost global(1)(*note global::)'s command character is available as a command. [/usr/src/sys] x fork <- (global -x fork) > 1 fork 94 kern/kern_fork.c fork(p, uap) [/usr/src/sys] r <- (global -xr fork) > 1 fork 85 alpha/linux/linux_machdep.c 2 fork 184 i386/linux/linux_machdep.c [/usr/src/sys] s lbolt <- (global -xs lbolt) > 1 lbolt 1210 i386/isa/wd_cd.c tsleep((cad 2 lbolt 1211 i386/isa/wd_cd.c tsleep((cad 3 lbolt 709 i386/isa/wfd.c tsleep ((caddr ... [/usr/src/sys] g <- (global -xg lbolt) > 1 lbolt 1210 i386/isa/wd_cd.c tsleep((cad ... [/usr/src/sys] P init <- (global -xP init) > 1 path 1 dev/hea/eni_init.c 2 path 1 dev/hfa/fore_init.c 3 path 1 i386/i386/initcpu.c 4 path 1 kern/init_main.c 5 path 1 kern/init_sysent.c 6 path 1 kern/vfs_init.c 7 path 1 vm/vm_init.c [/usr/src/sys] _ If no tag name is specified then it is assumed the latest tag name. * You can select a tag by show command. [/usr/src/sys] x main > 1 main 70 alpha/alpha/gensetdefs.c main(in 2 main 1500 alpha/alpha/ieee_float.c main(i 3 main 227 boot/alpha/boot1/boot1.c main() .... [/usr/src/sys] show 3 (Load editor and show boot/alpha/boot1/boot1.c at line 227.) The default editor is vi(1) but you can specify it statically by `EDITOR' environment variable or temporarily by option. [/usr/src/sys] show -e 3 (Preloaded emacs show boot/alpha/boot1/boot1.c at line 227.) [/usr/src/sys] show -l 3 (Load less and show boot/alpha/boot1/boot1.c at line 227.) [/usr/src/sys] show -g 3 (Preloaded mozilla show boot/alpha/boot1/boot1.c at line 227.) * You can use vi-like tag stack. You can return previous tag list by pop or `CTL-T' command. [/usr/src/sys] x main > 1 main 70 alpha/alpha/gensetdefs.c main(in 2 main 1500 alpha/alpha/ieee_float.c main(i 3 main 227 boot/alpha/boot1/boot1.c main() .... [/usr/src/sys] show 3 (Load editor and show boot/alpha/boot1/boot1.c at line 227.) [/usr/src/sys] x fork <- push new tag on tag stack. > 1 fork 94 kern/kern_fork.c fork(p, uap) [/usr/src/sys] pop <- pop tag stack. [/usr/src/sys] show (Load editor and show boot/alpha/boot1/boot1.c at line 227.)  File: global.info, Node: Applied usage(globash), Prev: Basic usage(globash), Up: GloBash 3.1.4 Applied usage. -------------------- * You can memory tags using 'mark' command. [/usr/src/sys] x fork > 1 fork 94 kern/kern_fork.c fork(p, uap) [/usr/src/sys] mark [/usr/src/sys] x main > 1 main 70 alpha/alpha/gensetdefs.c main(in 2 main 1500 alpha/alpha/ieee_float.c main(i 3 main 227 boot/alpha/boot1/boot1.c main() .... [/usr/src/sys] mark -l <- show marker list. 1 fork 94 kern/kern_fork.c fork(p, uap) [/usr/src/sys] mark 1 <- select a marker. (Load editor and show kern/kern_fork.c at line 227.) [/usr/src/sys] list > 1 main 70 alpha/alpha/gensetdefs.c main(in 2 main 1500 alpha/alpha/ieee_float.c main(i 3 main 227 boot/alpha/boot1/boot1.c main() .... Marked tags are valid until you get out of current project or quit current bash session. * You can memory directories using 'cookie' command. [/usr/src/sys] cookie <- drop cookie. [/usr/src/sys] cd kern [/usr/src/sys]/kern cookie <- drop cookie again. [/usr/src/sys]/kern cd ../i386 [/usr/src/sys]/i386 cookie -l <- show cookie list. 1 /usr/src/sys/kern 2 /usr/src/sys [/usr/src/sys]/i386 warp 2 <- warp to selected cookie. [/usr/src/sys] _ Cookie directories are valid until you delete them.  File: global.info, Node: Less viewer, Next: Nvi-1.79 editor, Prev: GloBash, Up: Applications 3.2 Less using GLOBAL. ====================== You can use GLOBAL as a tag system of less instead of ctags. * Menu: * Features(less):: Features. * Preparation(less):: Preparation. * Basic usage(less):: Basic usage. * Applied usage(less):: Applied usage.  File: global.info, Node: Features(less), Next: Preparation(less), Up: Less viewer 3.2.1 Features. --------------- * You can use most of GLOBAL's facilities from less-370 or the later. * Less viewer support duplicated tag.  File: global.info, Node: Preparation(less), Next: Basic usage(less), Prev: Features(less), Up: Less viewer 3.2.2 Preparation. ------------------ First, do the preparation of global. *Note Preparation::. Second, to use global from less, you need to set environment variable `LESSGLOBALTAGS' to "global". $ export LESSGLOBALTAGS=global  File: global.info, Node: Basic usage(less), Next: Applied usage(less), Prev: Preparation(less), Up: Less viewer 3.2.3 Basic usage. ------------------ * To go to func1, you can say $ less -t func1 Please note that if `tags' exist then less use it. If you want to use `GTAGS' even if `tags' exist then please specify tag file explicitly like this. $ less -TGTAGS -t func1 * To go to the referenced point of func1, please specify `GRTAGS'. $ less -TGRTAGS -t func1 In the same way, you can use `GTAGS', `GRTAGS', `GSYMS', `GPATH' as tag file. * If a number of objects are located, less goes to the first tag. You can go to next tag by typing `t' and back by typing `T'. `t' go to next tag. `T' go to previous tag. * From less session, you can use `:t' command to locate new symbol. But in this case, you cannot change tag file from one specified by `-T' option.  File: global.info, Node: Applied usage(less), Prev: Basic usage(less), Up: Less viewer 3.2.4 Applied usage. -------------------- * With `-T-' option, less read standard input as tag file. It is very valuable. You can connect global and less with pipe line. $ global -x func | less -T- In the same way, you can use following command lines. # pattern match with grep(1). $ global -xg 'lseek(.*)' | less -T- # pattern match with idutils(1). $ global -xI func | less -T- # all objects definitions in *.c. $ global -f *.c | less -T- # all files includes 'init' in its path. $ global -Px init | less -T- * If your editor doesn't support GLOBAL directly then you can use less as a footstool. # invoke less $ less -t main main(int argc, char **argv) { int i; ..... [xxx/main.c (tag 1 of 55)] # type 'v'(vi) command in less session. v # load vi and show the same position. ..... main((int argc, char **argv) { int i; ..... [xxx/main.c 313 lines, 7783 char] # type 'ZZ' command in vi session. ZZ # exit vi and back to less session. main(int argc, char **argv) { int i; ..... [xxx/main.c (tag 1 of 55)]  File: global.info, Node: Nvi-1.79 editor, Next: Nvi-1.81.5 editor, Prev: Less viewer, Up: Applications 3.3 Extended nvi-1.79 using GLOBAL. =================================== You can use GLOBAL as a tag system of Nvi editor instead of ctags. * Menu: * Features(nvi-1.79):: Features. * Preparation(nvi-1.79):: Preparation. * Basic usage(nvi-1.79):: Basic usage. * Applied usage(nvi-1.79):: Applied usage.  File: global.info, Node: Features(nvi-1.79), Next: Preparation(nvi-1.79), Up: Nvi-1.79 editor 3.3.1 Features. --------------- * You can use most of GLOBAL's facilities from the editor. * Recognition of the current token and its type. * Extended nvi is completely backward-compatible with the original nvi. You can use GLOBAL's facilities only in 'gtags mode'.  File: global.info, Node: Preparation(nvi-1.79), Next: Basic usage(nvi-1.79), Prev: Features(nvi-1.79), Up: Nvi-1.79 editor 3.3.2 Preparation. ------------------ First, do the preparation of global. *Note Preparation::. Second, to use global from nvi, you need to get into "gtagsmode". There are several ways to do this: 1. Start nvi with `-G' option $ nvi -G file.c 2. Start nvi and execute `set gtagsmode'. $ nvi file.c ~ ~ ~ :set gtagsmode 3. Write the above set command to the `.exrc' or `.nexrc' and start nvi $HOME/.exrc +---------------------------- |set gtagsmode You must start nvi under the source tree described in *Note Preparation::.  File: global.info, Node: Basic usage(nvi-1.79), Next: Applied usage(nvi-1.79), Prev: Preparation(nvi-1.79), Up: Nvi-1.79 editor 3.3.3 Basic usage. ------------------ * To go to func1, you can say :tag func1 It seemes the same as original nvi, but extended nvi use `GTAGS' instead of `tags'. * To go to the referenced point of func1, add the option `-r' :tag -r func1 Extended nvi use `GRTAGS'. * If a number of objects are located, extended nvi goes to the first tag. You can go to next tag by typing `:tagnext' and back by typing `:tagprev'. Suggested .nexrc: set gtagsmode map ^N :tagnext^M map ^P :tagprev^M * `CTL-]' command is available. In gtags mode, if current token is not a function then it is equivalent to `:tag -s CURRENT TOKEN'. Otherwise, if you are in the first column of a line, it is equivalent to `:tag -r CURRENT TOKEN' else it is equivalent to `:tag CURRENT TOKEN'. * You can use the `-s' option. It locates any symbols which are not defined in `GTAGS'. :tag -s pat Extended nvi use `GSYMS'. * The `-g', `-f' and `-P' option are also available. It works like command line. Extended nvi use no index file. :tag -g pat * Other tag commands are also available: `CTL-T' Return to the most recent tag context. `:tagpop' Go to the specified tag in the tags stack. `:tagtop' Go to the top tag in the tags stack. `:display tags' Display the tags stack.  File: global.info, Node: Applied usage(nvi-1.79), Prev: Basic usage(nvi-1.79), Up: Nvi-1.79 editor 3.3.4 Applied usage. -------------------- * In large projects that include many main() function like MH, you can start nvi like this: $ nvi -G -t main You can browse all commands sequentially. * When you want to check objects the name of which start with "set" or "get", use: $ nvi -G -t '^[sg]et' Of course, the following command is also available: :tag ^[sg]et * If your source files are on a read only device like a CD-ROM, please do the following: $ mkdir /var/dbpath # directory for the tag file $ cd /cdrom/src # the root of the source tree $ gtags /var/dbpath # make tag files in /var/dbpath $ export GTAGSROOT=`pwd` $ export GTAGSDBPATH=/var/dbpath $ nvi -G -t main * If you want all references to an object that is not defined in the source tree to be treated as references to library functions or as system calls, do the following: $ cd /usr/src/lib $ gtags # probably as a root $ cd /usr/src/sys $ gtags $ export GTAGSLIBPATH=/usr/src/lib:/usr/src/sys * If you examine vi's source, $ cd /usr/src/usr.bin/vi $ gtags $ nvi -G -t main You can start from nvi and browse the whole unix world as if you were using hypertext.  File: global.info, Node: Nvi-1.81.5 editor, Next: Elvis editor, Prev: Nvi-1.79 editor, Up: Applications 3.4 nvi-1.81.5 using GLOBAL. ============================ You can use GLOBAL as a tag system of Nvi editor instead of ctags. * Menu: * Features(nvi-1.81.5):: Features. * Preparation(nvi-1.81.5):: Preparation. * Basic usage(nvi-1.81.5):: Basic usage.  File: global.info, Node: Features(nvi-1.81.5), Next: Preparation(nvi-1.81.5), Up: Nvi-1.81.5 editor 3.4.1 Features. --------------- * You can use most of GLOBAL's facilities from the editor. * Recognition of the current token and its type.  File: global.info, Node: Preparation(nvi-1.81.5), Next: Basic usage(nvi-1.81.5), Prev: Features(nvi-1.81.5), Up: Nvi-1.81.5 editor 3.4.2 Preparation. ------------------ First, do the preparation of global. *Note Preparation::. Second, to use global from nvi, you need write to `.nexrc' like this: It assumed that gtags.pl is put on `$HOME/perl'. $HOME/.nexrc +---------------------------- |perl use lib "$ENV{'HOME'}/perl" |perl require 'gtags.pl' |map ^P :tagprev^M |map ^N :tagnext^M |map ^] :perl tag^M |ab gtag perl tag qw( |ab gta perl tag qw( |ab gt perl tag qw( You must start nvi under the source tree described in *Note Preparation::.  File: global.info, Node: Basic usage(nvi-1.81.5), Prev: Preparation(nvi-1.81.5), Up: Nvi-1.81.5 editor 3.4.3 Basic usage. ------------------ * To go to func1, you can say :perl tag qw(func1) Suggested .nexrc: ab gtag perl tag qw( ab gta perl tag qw( ab gt perl tag qw( * To go to the referenced point of func1, add the option `-r' :perl tag qw(-r func1) * If a number of objects are located, nvi goes to the first tag. You can go to next tag by typing `:tagnext' and back by typing `:tagprev'. Suggested .nexrc: map ^N :tagnext^M map ^P :tagprev^M * If you don't specify any argument. ':perl tag' command do the followins: If current token is not a function then it is equivalent to `:perl tag qw(-s CURRENT TOKEN)'. Otherwise, if you are in the first column of a line, it is equivalent to `:perl tag qw(-r CURRENT TOKEN)' else it is equivalent to `:perl tag qw(CURRENT TOKEN)'. Suggested .nexrc: map ^] :perl tag^M It is similar to `CTL-]' command. * You can use the `-s' option. It locates any symbols which are not defined in `GTAGS'. :perl tag qw(-s pat) * The `-g', `-f' and `-P' option are also available. It works like command line. :perl tag qw(-g pat) * When you want to check objects the name of which start with "set" or "get", use: :perl tag qw(^[sg]et) * Other tag commands are also available: `CTL-T' Return to the most recent tag context. `:tagpop' Go to the specified tag in the tags stack. `:tagtop' Go to the top tag in the tags stack. `:display tags' Display the tags stack.  File: global.info, Node: Elvis editor, Next: Vim editor, Prev: Nvi-1.81.5 editor, Up: Applications 3.5 Elvis using global ====================== Elvis 2.1 has new `tagprg' and `tagprgonce' variables for running an external tag search program. You can use them with GLOBAL. * Menu: * Features(elvis):: Features. * Preparation(elvis):: Preparation. * Basic usage(elvis):: Basic usage. * Applied usage(elvis):: Applied usage.  File: global.info, Node: Features(elvis), Next: Preparation(elvis), Up: Elvis editor 3.5.1 Features. --------------- * You can use most of GLOBAL's facilities from the editor. * No source level patch is needed. * Mouse events are supported.  File: global.info, Node: Preparation(elvis), Next: Basic usage(elvis), Prev: Features(elvis), Up: Elvis editor 3.5.2 Preparation. ------------------ First, do the preparation of global. *Note Preparation::. Second, start elvis and execute `set tagprg="global -t $1"' like this. $ elvis ~ ~ ~ ~ ~ ~ :set tagprg="global -t $1"  File: global.info, Node: Basic usage(elvis), Next: Applied usage(elvis), Prev: Preparation(elvis), Up: Elvis editor 3.5.3 Basic usage. ------------------ * To go to func1, you can say :tag func1 It seemes the same as original elvis, but elvis execute `global -t func1' internally and read it instead of tags file. * To go to the referenced point of func1, add `-r' option. :tag -r func1 Elvis executes command like `global -t -r func1' internally. * To go to any symbols which are not defined in `GTAGS', try this. :tag -s lbolt * To go to any strings other than symbols, try this. :tag -g Copyright * When using -r, -s or -g, you had better to use browse command. :browse -r fork It brings a following selection list. You can select tag and go to the point. Browse -r fork (2 matches) +----------------+----------------+-------------------- | TAG NAME | SOURCE FILE | SOURCE LINE +----------------+----------------+-------------------- |fork |ux/linux_misc.c | (line 565) |fork |ern/init_main.c | (line 191) +----------------+----------------+-------------------- * To get list of objects in a file, use -f command. :browse -f main.c <- locate definitions in main.c * Other tag commands are also available: `CTL-]' go to the definition of current token. `CTL-T' return to the most recent tag context. `:tag' without argument, go to the next tag. `:pop' return to the most recent tag context. `:stack' display the tags stack. `:stag' creates a new window and moves its cursor to the tag's definition point. `:sbrowse' same with 'browse' but show in a new window.  File: global.info, Node: Applied usage(elvis), Prev: Basic usage(elvis), Up: Elvis editor 3.5.4 Applied usage. -------------------- * You can use POSIX regular expressions. :tag ^put_ <- locate objects start with 'put_' :browse -g 'fseek(.*L_SET)' <- locate fseek() using L_SET argument * You can browse object list of many files. :browse -f *.c <- locate objects in *.c * You can browse project files whose path includs specified pattern. :browse -P /vm/ <- under vm/ directory :browse -P \.h$ <- all include files :browse -P init <- path including 'init' * You can use mouse to select tag. +----------------+----------------+-------------------- | TAG NAME | SOURCE FILE | SOURCE LINE +----------------+----------------+-------------------- |fork |ux/linux_misc.c | (line 565) |fork |ern/init_main.c | (line 191) +----------------+----------------+-------------------- Please select tag name with mouse cursor and double click on the left button and you go to the tag's point. In source screen, also select an object name and double click on the left button and you can go to the point that the object is defined. To come back, double click on the right button.  File: global.info, Node: Vim editor, Next: Emacs editor, Prev: Elvis editor, Up: Applications 3.6 Vim using global ==================== In vim 6.2 or later, you can use gtags.vim script. * Menu: * Features(vim):: Features. * Preparation(vim):: Preparation. * Basic usage(vim):: Basic usage. * Applied usage(vim):: Applied usage.  File: global.info, Node: Features(vim), Next: Preparation(vim), Up: Vim editor 3.6.1 Features. --------------- * You can use most of GLOBAL's facilities from the editor. * Intelligent recognition of the current token and its type. * Special character '%', '#' and input completion are available.  File: global.info, Node: Preparation(vim), Next: Basic usage(vim), Prev: Features(vim), Up: Vim editor 3.6.2 Preparation. ------------------ First, do the preparation of global. *Note Preparation::. Second, copy `gtags.vim' to your plugin directory or source it from your vimrc. $ cp /usr/local/share/gtags/gtags.vim $HOME/.vim/plugin  File: global.info, Node: Basic usage(vim), Next: Applied usage(vim), Prev: Preparation(vim), Up: Vim editor 3.6.3 Basic usage. ------------------ * To go to main, you can say :Gtags main Vim execute `global -t main', parse the output, list located objects in quickfix window and load the first entry. The quickfix windows is like this: gctags/gctags.c|119| main global/global.c|154| main gozilla/gozilla.c|156| main gtags/gtags.c|199| main libglibc/getopt.c|701| main libglibc/getopt1.c|93| main [Error List] You can go to any entry using quickfix command. `:cn' go to the next entry. `:cp' go to the previous entry. `:ccN' go to the N'th entry. `:cl' list all entries. You can see the help of quickfix like this: :h quickfix * To go to the referenced point of func1, add `-r' option. :Gtags -r func1 vim executes command like `global -t -r func1' internally. * To go to any symbols which are not defined in `GTAGS', try this. :Gtags -s lbolt * To go to any strings other than symbols, try this. :Gtags -g Copyright * To get list of objects in a file, use -f command. :Gtags -f main.c <- locate objects in main.c If you are editing `main.c' itself, you can use '%' instead. :Gtags -f % <- locate objects in main.c  File: global.info, Node: Applied usage(vim), Prev: Basic usage(vim), Up: Vim editor 3.6.4 Applied usage. -------------------- * You can use POSIX regular expressions. :Gtags ^put_ <- locate objects start with 'put_' :Gtags -g fseek(.*SEEK_SET) <- locate fseek() using SEEK_SET * Input completion is available. :Gtags fu`TAB' :Gtags func1 <- 'nc1' is appended by vim * You can browse project files whose path includes specified pattern. :Gtags -P /vm/ <- under vm/ directory :Gtags -P \.h$ <- all include files :Gtags -P init <- path including 'init' * You can use all options of global(1) except for the -c, -p, -u and all long name options. They are sent to global(1) as is. For example, :Gtags -gi paTtern <- match to both 'PATTERN' and 'pattern'. About the other options, *Note global::. * The GtagsCursor command brings you to the definition or reference of the current token in C language. The GtagsCursor is not perfect though is considerably wise. If current token is not a function then it is equivalent to `:Gtags -s CURRENT TOKEN'. Otherwise, if you are in the first column of a line, it is equivalent to `:Gtags -r CURRENT TOKEN' else it is equivalent to `:Gtags CURRENT TOKEN'. :GtagsCursor Suggested map: map :GtagsCursor * If you have the hypertext generated by htags(1) then you can display the same place on mozilla browser. Let's load mozilla and try this: :Gozilla Suggested map: map :Gozilla * If you want to load vim with all main()s then following command line is useful. $ vim '+Gtags main'  File: global.info, Node: Emacs editor, Next: Web browser, Prev: Vim editor, Up: Applications 3.7 Extended emacs using global =============================== You can use GLOBAL as a tag system of Emacs editor instead of etags. * Menu: * Features(emacs):: Features. * Preparation(emacs):: Preparation. * Basic usage(emacs):: Basic usage. * Applied usage(emacs):: Applied usage.  File: global.info, Node: Features(emacs), Next: Preparation(emacs), Up: Emacs editor 3.7.1 Features. --------------- * You can use most of GLOBAL's facilities from the editor. * More intelligent recognition of the current token and its type. * Tag completion is available for input tag name. * Mouse events are supported.  File: global.info, Node: Preparation(emacs), Next: Basic usage(emacs), Prev: Features(emacs), Up: Emacs editor 3.7.2 Preparation. ------------------ First, do the preparation of global. *Note Preparation::. Second, to use global from emacs, you need to load the `gtags.el' and execute gtags-mode function in it. 1. Write the autoload function to the `$HOME/.emacs', start emacs and execute the gtags-mode function. If you don't put `gtags.el' in standard macro directory, you need to add the directory to `load-path'. $HOME/.emacs +------------------------------------------------------ |(setq load-path (cons "/home/owner/global" load-path)) |(autoload 'gtags-mode "gtags" "" t) $ emacs | |J_:-----Mule: *scratch* (Lisp Interaction)--L16--All---- |M-x gtags-mode[RET] +------------------------------------------------------ If you want to get into gtags-mode on c-mode then you can append followings into the `$HOME/.emacs'. (setq c-mode-hook '(lambda () (gtags-mode 1) )) 2. Specify the root directory of the source tree using `gtags-visit-rootdir'. If you have tag files in /usr/src/sys then please do like this: Visit root directory: /usr/src/sys  File: global.info, Node: Basic usage(emacs), Next: Applied usage(emacs), Prev: Preparation(emacs), Up: Emacs editor 3.7.3 Basic usage. ------------------ * To go to func1, invoke `gtags-find-tag' and you can see a prompt in mini-buffer. Then input the tag name. Find tag: func1 <- 'Find tag: ' is a prompt * To go to a point that references func1, invoke `gtags-find-rtag'. Find tag (reference): func1 * Tag name completion is available. You need to execute `gtags-make-complete-list' command before it. Find tag: fuTAB Find tag: func1 <- 'nc1' is appended by emacs * If a number of objects are located, emacs goes into "GTAGS SELECT MODE" like this: +------------------------------------------------------------- |main 347 i386/isa/ultra14f.c main() |main 128 kern/init_main.c main(framep) |main 104 netiso/clnp_debug.c main() |main 164 netiso/xebec/main.c main(argc, argv) | | | | | |J_:--%*-Mule: *scratch* (Gtags Select)--L1--All---- |[GTAGS SELECT MODE] 4 lines +------------------------------------------------------------- You can select a tag line by using any emacs command and pressing `RET', and you can go to the tag's point. When you want to go to the next or the previous tag, you can return to 'GTAGS SELECT MODE' with `gtags-pop-stack' and reselect. * `gtags-find-tag-from-here' command is available. If current token is a definition, it is equivalent to `Find tag (reference): CURRENT TOKENRET', otherwise it is equivalent to `Find tag: CURRENT TOKENRET'. (This facility is supported only in C language. GLOBAL decides this intelligentlly, but may sometimes misunderstand.) * To go to any symbols which are not defined in `GTAGS', try `gtags-find-symbol'. Find symbol: lbolt <- 'Find symbol:' is a prompt * To go to any strings other than symbols, try `gtags-find-with-grep'. Find pattern: Copyright  File: global.info, Node: Applied usage(emacs), Prev: Basic usage(emacs), Up: Emacs editor 3.7.4 Applied usage. -------------------- * You can use POSIX regular expressions. Find tag: ^put_ <- locate tags start with 'put_' * If your source files are on a read-only device like a CDROM, please do the following: $ mkdir /var/dbpath # directory for the tag file $ cd /cdrom/src # the root of the source tree $ gtags /var/dbpath # make tag files in /var/dbpath $ export GTAGSROOT=`pwd` $ export GTAGSDBPATH=/var/dbpath $ emacs -f gtags-mode * If you want all references to an object that is not defined in the source tree to be treated as references to library functions or as system calls, do the following: $ cd /usr/src/lib $ gtags <- probably as a root $ cd /usr/src/sys $ gtags $ export GTAGSLIBPATH=/usr/src/lib:/usr/src/sys $ emacs -f gtags-mode * Mouse command is avalable. If you use X version emacs, try the following Move the mouse cursor to an object name and click the middle button. You will then go to the object's definition, or to its references, depending on the context. In 'GTAGS SELECT MODE', move the mouse cursor to a line and click the center button. To return to the previous position, click the right button.  File: global.info, Node: Web browser, Next: Doxygen documentation system, Prev: Emacs editor, Up: Applications 3.8 Hypertext generator ======================= You can use GLOBAL's facilities from WWW browser. * Menu: * Features(browser):: Features. * Preparation(browser):: Preparation. * Usage(browser):: Usage.  File: global.info, Node: Features(browser), Next: Preparation(browser), Up: Web browser 3.8.1 Features. --------------- * Htags makes hypertext from C, C++, Yacc and Java source files. * Once the hypertext is generated, you need nothing other than a WWW browser. * You can move the hypertext to anywhere. It is independent of the source code. * You can use all of your browser's functions, such as search, history, bookmark, save, frames, windows.  File: global.info, Node: Preparation(browser), Next: Usage(browser), Prev: Features(browser), Up: Web browser 3.8.2 Preparation. ------------------ At first, you must ensure that you have a lot of disk space for hypertext. For example, FreeBSD 7.0 kernel source code (123MB) requires disk space from 600 to 1200MB. source code(/usr/src/sys) 123MB GPATH,GTAGS,GRTAGS,GSYMS 86MB hypertext (with no option) 645MB hypertext (with -s option) 1168MB hypertext (with -D option) 383MB hypertext (with -s and -D option) 616MB Please invoke gtags(1)(*note gtags::) and htags(1)(*note htags::) in order like this: (at your source directory) $ gtags # make tag files(GTAGS,GRTAGS,GSYMS) $ htags # make hypertext(HTML/) Then you will find an `HTML' subdirectory in the current directory. Htags has many options. Suggested option: $ htags -vsanohIT If http server is available then the -D and -f option are also useful.  File: global.info, Node: Usage(browser), Prev: Preparation(browser), Up: Web browser 3.8.3 Usage. ------------ Please start a web browser like this: $ lynx HTML/index.html You will understand the usage by looking at the examples. You can move the HTML directory to anywhere. It is independent of the source code. Using mozilla, you can also utilize hypertext from your command line like this: $ mozilla # load mozilla $ global -x main main 10 main.c main(int argc, char *argv[]) { $ gozilla +10 main.c # usage is similar to vi editor. (show main.c at 10 on mozilla's screen.) But in this case, you must not move HTML directory from the source directory.  File: global.info, Node: Doxygen documentation system, Prev: Web browser, Up: Applications 3.9 Doxygen using global ======================== You can use GLOBAL as a source browser of Doxygen. Doxygen Release 1.4.3 or later includs config option USE_HTAGS. When enabled in combination with SOURCE_BROWSER=YES, htags(1) is used as the source browser instead of doxygen's own. Here is an example. (in source directory) $ doxygen -g $ vi Doxyfile +--------------------------------- |... |INPUT = . |RECURSIVE = YES |SOURCE_BROWSER = YES |USE_HTAGS = YES |... $ doxygen $ lynx html/index.html  File: global.info, Node: Other topics, Next: Reference, Prev: Applications, Up: Top 4 Other topics ************** * Menu: * Configuration:: How to config GLOBAL. * Plugin:: Plug-in parser. * Incremental updating:: Incremental updating.  File: global.info, Node: Configuration, Next: Plugin, Up: Other topics 4.1 How to config GLOBAL. ========================= You can customize GLOBAL using configuration file. # cp gtags.conf /etc/gtags.conf # system wide config file. # vi /etc/gtags.conf $ cp gtags.conf $HOME/.globalrc # personal config file. $ vi $HOME/.globalrc If `$HOME/.globalrc' exists then GLOBAL use it. Else if `/etc/gtags.conf' exists then GLOBAL use it. Otherwise default value will be used. The format of `gtags.conf' is resemble to termcap(5). By default, 'default' target is used. About the capabilities, please see each command manual. *Note Reference::.  File: global.info, Node: Plugin, Next: Incremental updating, Prev: Configuration, Up: Other topics 4.2 Plug-in parser. =================== You can write new parser and use as a plugin parser. 4.2.1 How to plug in a parser. ------------------------------ Copy `gtags.conf' to `/etc/gtags.conf' or `$HOME/.globalrc'. If you would like to use exuberant ctags included by Vim editor, $ cd /VIM SOURCE DIRECTORY/src/ctags $ cp Makefile.unix Makefile $ make # cp ctags /usr/local/bin/ctags-exuberant $ export GTAGSLABEL=ctags-exuberant # see gtags.conf $ gtags $ ls G* GPATH GTAGS `GRTAGS' and `GSYMS' don't exist, simply because these parsers don't support the `-r' option and `-s' option like gtags-parser(1) does. 4.2.2 Requirement of plugin parser. ----------------------------------- Plug-in parser must print tag information to standard output in the same style as `ctags -x', ie.: [1] [2] [3] [4] ---------------------------------------------------------------- main 20 ./main.c main(argc, argv) /* xxx */ [1] tag name [2] line number the tag appeared [3] path name. It must be equal to argument path name. [4] line image Plug-in parser must process the files in the order they are given in the argument. In each file, any order is acceptable. * Good example The following `good-prog' does correct operation as a plugin parser. $ good-prog a.c b.c <= order: a.c -> b.c ~~~~~~~ main 25 a.c main(int argc, char *argv[]) func 45 a.c func(int a) { sub2 20 b.c sub2() { sub1 10 b.c sub1() { ^ | *** order: a.c -> b.c (Good!) * Bad example The following `bad-prog' does wrong operation as a plugin parser. $ bad-prog a.c b.c <= order: a.c -> b.c main 25 a.c main(int argc, char *argv[]) sub2 20 b.c sub2() { sub1 10 b.c sub1() { func 45 a.c func(int a) { ^ | *** order: b.c -> a.c (BAD!!!)  File: global.info, Node: Incremental updating, Prev: Plugin, Up: Other topics 4.3 Incremental updating. ========================= Modifying some source files, you need not remake whole tag files. Instead, you can use incremental updating facility (`-u' option). $ gtags $ cd kern $ vi tty.c # modify tty.c ... :wq $ global -vu # -v means verbose [Sun Dec 6 16:27:47 JST 1998] Gtags started Tag found in '/usr/src/sys'. Incremental update. [Sun Dec 6 16:28:48 JST 1998] Updating 'GTAGS'. [1/1] deleting tags of kern/tty.c [1/1] adding tags of kern/tty.c [Sun Dec 6 16:28:59 JST 1998] Updating 'GRTAGS'. [1/1] deleting tags of kern/tty.c [1/1] adding tags of kern/tty.c [Sun Dec 6 16:28:14 JST 1998] Updating 'GSYMS'. [1/1] deleting tags of kern/tty.c [1/1] adding tags of kern/tty.c Global databases have been modified. [Sun Dec 6 16:28:30 JST 1998] Done. $ global -vu # try again [Sun Dec 6 16:28:48 JST 1998] Gtags started Tag found in '/usr/src/sys'. Incremental update. Global databases are up to date. # do nothing [Sun Dec 6 16:28:52 JST 1998] Done.  File: global.info, Node: Reference, Next: Copying This Manual, Prev: Other topics, Up: Top 5 Command References ******************** * Menu: * global:: global - print the locations of specified object. * gtags:: gtags - create tag files for global. * htags:: htags - generate hypertext from source code. * gtags-parser:: gtags-parser - print cross reference list for gtags. * gozilla:: gozilla - force mozilla to display specified source file. * gtags-cscope:: gtags-cscope - pseudo cscope which implements the line-oriented interface  File: global.info, Node: global, Next: gtags, Up: Reference 5.1 global - print the locations of specified object. ===================================================== NAME ---- global - print the locations of specified object. SYNOPSIS -------- global [-aGilnqrstTvx][-e] pattern global -c[qrsv] prefix global -f[anqrstvx] files global -g[aGilnoOqtvx][-e] pattern global -I[ailnqtvx][-e] pattern global -p[qrv] global -P[aGilnoOqtvx][-e] pattern global -u[qv] DESCRIPTION ----------- Global find the locations of specified object in C, C++, Yacc, Java, PHP and Assembly source files. Global can treat a source tree, that is, a directory that has subdirectories and source files. You can get the relative path of objects from anywhere within the tree. Global can locate not only object definitions but also object references and other symbols. Duplicate entries are allowed. In advance of using this command, you must execute gtags(1) at the root directory of the source tree to make tag files. Then you can execute at anywhere in the source tree. COMMANDS -------- The following commands are available: pattern Print object which match to the pattern. Extended regular expressions which are the same as those accepted by egrep(1) are available. `-c', `--completion' [prefix] Print candidate definition names which start with specified prefix. Prefix is not specified, print all definition names. `-f', `--file' files Print all tags in the files. This option implies -x option. `-g', `--grep' Print all lines which match to the pattern. `-I', `--idutils' Print all lines which match to the pattern. This function use idutils(1) as a search engine. To use this command, you need to install idutils(1) in your system and you must execute gtags(1) with `-I' option. `-p', `--print-dbpath' Print the location of `GTAGS'. `-P', `--path' [pattern] Print the path which match to the pattern. If no pattern specified, print all. `-u', `--update' Locate tag files and update them incrementally. `--version' Show version number. `--help' Show help. OPTIONS ------- The following options are available: `-a', `--absolute' Print absolute path name. By default, print relative path name. `-e', `--regexp' pattern Use pattern as the pattern; useful to protect patterns beginning with -. `-G', `--basic-regexp' Interpret pattern as a basic regular expression. The default is extended regular expression. This option is valid for the `-g' and `-P' command. `-i', `--ignore-case' ignore case distinctions in pattern. `-l', `--local' Print just objects which exist under the current directory. `-n', `--nofilter' Suppress sort filter and path conversion filter. `-o', `--other' Search pattern in not only source files but also other files like `README'. This option is valid only with `-g' or `-P' command. `-O', `--only-other' Search pattern only in other files like `README'. This option is valid only with `-g' or `-P' command. This option override the `-o' option. `-q', `--quiet' Quiet mode. `-r', `--reference', `--rootdir' Print the locations of object references. By default, print object definitions. With the `-p' option, print the root directory of source tree. `--result' format format may be 'path', `ctags', `ctags-x', `grep' or 'cscope'. The `--result=ctags' and `--result=ctags-x' are equivalent to the `-t' and `-x' respectively. The -result option is given to priority more than the -t and -x option. `-s', `--symbol' Print the locations of specified symbol other than definitions. `-t', `--tags' Print with standard ctags format. `-T', `--through' Go through all the tag files listed in GTAGSLIBPATH. By default, stop searching when tag is found. This option is ignored when either `-s', `-r' or `-l' option is specified. `-v', `--verbose' Verbose mode. `-x', `--cxref' In addition to the default output, produce the line number and the line contents. EXAMPLES -------- $ ls -F Makefile src/ lib/ $ gtags $ global main src/main.c $ global -x main main 10 src/main.c main (argc, argv) { $ global -x '^[sg]et' set_num 20 lib/util.c set_num(values) get_num 30 lib/util.c get_num() { $ global -rx '^[sg]et' set_num 113 src/op.c set_num(32); set_num 225 src/opop.c if (set_num(0) > 0) { get_num 90 src/op.c while (get_num() > 0) { $ cd lib $ global -rx '^[sg]et' set_num 113 ../src/op.c set_num(32); set_num 225 ../src/opop.c if (set_num(0) > 0) { get_num 90 ../src/op.c while (get_num() > 0) { $ global strlen $ (cd /usr/src/sys; gtags) $ export GTAGSLIBPATH=/usr/src/sys $ global strlen ../../../usr/src/sys/libkern/strlen.c $ (cd /usr/src/lib; gtags) $ GTAGSLIBPATH=/usr/src/lib:/usr/src/sys $ global strlen ../../../usr/src/lib/libc/string/strlen.c FILES ----- `GTAGS' Tag file for object definitions. `GRTAGS' Tag file for object references. `GSYMS' Tag file for other symbols. `GPATH' Tag file for path of source files. `GTAGSROOT' If environment variable GTAGSROOT is not set and `GTAGSROOT' exist in the same directory with `GTAGS' then use the value as GTAGSROOT. `/etc/gtags.conf', `$HOME/.globalrc' Configuration file. ENVIRONMENT ----------- The following environment variables affect the execution of global: GTAGSROOT The directory which is the root of source tree. GTAGSDBPATH The directory on which gtags database exist. This value is ignored when GTAGSROOT is not defined. GTAGSLIBPATH If this variable is set, it is used as the path to search for library functions. If the specified function is not found in a source tree, global also search in these paths. GTAGSLABEL If this variable is set, its value is used as the label of configuration file. The default is `default'. CONFIGURATION ------------- The following configuration variables affect the execution of global: `icase_path'(boolean) Ignore case distinctions in the pattern. DIAGNOSTICS ----------- Global exits with a non 0 value if an error occurred, 0 otherwise. SEE ALSO -------- gtags-parser(1), gtags(1), htags(1), less(1). GNU GLOBAL source code tag system (http://www.gnu.org/software/global/). AUTHOR ------ Tama Communications Corporation. HISTORY ------- The global command appeared in FreeBSD 2.2.2.  File: global.info, Node: gtags, Next: htags, Prev: global, Up: Reference 5.2 gtags - create tag files for global. ======================================== NAME ---- gtags - create tag files for global. SYNOPSIS -------- gtags [-iIqvw][-f file][-n number][dbpath] DESCRIPTION ----------- Gtags recursively collect the source files under the current directory, pickup symbols and write the cross-reference data into tag files (`GTAGS', `GRTAGS', `GSYMS' and `GPATH'). You should execute this command at the root of the source tree. C, C++, yacc, java, PHP and Assembly source files are supported. Files whose names end in `.c' or `.h' are assumed to be C source files and are searched for C style routine and macro definitions. Files whose names end in `.c++' `.cc' `.cpp' `.cxx' `.hxx' `.hpp' `.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 `.java' are assumed to be Java source files. Files whose names end in `.php' `.php3' `.phtml' are assumed to be PHP source files. Files whose names end in `.s' or `.S' are assumed to be Assembler source files. Other files are searched for C style definitions. OPTIONS ------- The following options are available: `--config'[=name] Show the value of config variable name. If name is not specified then show whole of config entry. `-f', `--file' file Read from file a list of file names which should be considered as the candidate of source files. By default, all files under the current directory are considered as the candidate. If file is `-', read from standard input. File names must be separated by newline. `--gtagsconf' file Load user's configuration from file. `--gtagslabel' label label is used as the label of configuration file. The default is `default'. `-i', `--incremental' Update tag files incrementally. You had better use global(1) with the -u option. `-I', `--idutils' Make index files for idutils(1). `-n', `--max-args' number Maximum number of arguments for gtags-parser(1). By default, gtags invokes the parser with arguments as a lot as possible to decrease the frequency of invoking. `-q', `--quiet' Quiet mode. `-v', `--verbose' Verbose mode. `-w', `--warning' Print warning messages. dbpath The directory in which tag files are generated. The default is the current directory. It is useful when your source directory is on a read only device like CDROM. EXAMPLES -------- $ ls -F Makefile src/ lib/ $ gtags -v $ global -x main main 10 src/main.c main (argc, argv) { FILES ----- `GTAGS' Tag file for function definitions. `GRTAGS' Tag file for function references. `GSYMS' Tag file for other symbols. `GPATH' Tag file for path of source files. `/etc/gtags.conf', `$HOME/.globalrc' Configuration file. ENVIRONMENT ----------- The following environment variables affect the execution of gtags: GTAGSCONF If this variable is set, its value is used as the configuration file. The default is `$HOME/.globalrc'. GTAGSLABEL If this variable is set, its value is used as the label of configuration file. The default is `default'. GTAGSCACHE If this variable is set, its value is used as the size of btree cache. The default is 500000 (bytes). CONFIGURATION ------------- The following configuration variables affect the execution of gtags. You can see the default value for each variable with the `--config' option. `GTAGS'(string) If this variable is set, its value is used as the command line of parser for GTAGS. The default is `gtags-parser -dt %s'. `GRTAGS'(string) If this variable is set, its value is used as the command line of parser for GRTAGS. The default is `gtags-parser -dtr %s'. `GSYMS'(string) If this variable is set, its value is used as the command line of parser for GSYMS. The default is `gtags-parser -dts %s'. `skip'(comma separated list) Gtags skips files which listed in this list. As a special exception, gtags collect values from multiple `skip' variables. If the value ends with '/', it assumed as a directory and gtags skips all files under it. If the value start with '/', it assumed relative path from the root of source directory. `suffixes'(comma separated list) Suffixes of target source file. As a special exception, gtags collect values from multiple `suffixes' variables. This variable is obsoleted. If the langmap variable is defined gtags no longer refers this. `icase_path'(boolean) Ignore case distinctions in the path. Suffixes check are affected by this capability. `langmap'(comma separated list) Language mapping. Each comma-separated map consists of the language name, a colon, and a list of file extensions. Default mapping is 'c:.c.h,yacc:.y,asm:.s.S,java:.java,cpp:.c++.cc.cpp.cxx.hxx.hpp.C.H,php:.php.php3.phtml'. DIAGNOSTICS ----------- Gtags exits with a non 0 value if an error occurred, 0 otherwise. MESSAGE FORMAT -------------- Verbose message has important level. The most important level is 0, the second is 1 and so on. All the message has level numbers leading blanks. SEE ALSO -------- gtags-parser(1), global(1), htags(1). GNU GLOBAL source code tag system (http://www.gnu.org/software/global/). BUG --- `GTAGS', `GRTAGS' and `GSYMS' are very large. In advance of using this command, check the space of your disk. Assembler support is far from complete. It extracts only ENTRY() and ALTENTRY() from source file. Probably valid only for FreeBSD and Linux kernel source. There is no concurrency control about tag files. Symbols in Assembly source files are not extracted for `GSYMS'. AUTHOR ------ Tama Communications Corporation. HISTORY ------- The gtags command appeared in FreeBSD 2.2.2.  File: global.info, Node: htags, Next: gtags-parser, Prev: gtags, Up: Reference 5.3 htags - generate hypertext from source code. ================================================ NAME ---- htags - generate hypertext from source code. SYNOPSIS -------- htags [-acDfFghInosTvwx][-d dbpath][-m name][-S cgidir][-t title][dir] DESCRIPTION ----------- Htags makes hypertext of C, C++, Yacc, Java, PHP and Assembly source code. In advance of using this command, you must execute gtags(1) from the root directory of the source tree. Then you can execute htags from the same place. Htags makes an directory named `HTML' and generates hypertext in it. You can start browsing from `HTML/index.html'. Since htags generates static hypertext as long as the `-D' or `-f' option is not specified, you can move it anywhere and browse it with any browser without web server. You must use same parser for both gtags(1) and htags. If you use the default parser, it is not necessary to consider for it. OPTIONS ------- The following options are available: `-a', `--alphabet' Make an alphabetical function index which is suitable for a large project. `--caution' Include caution message to prohibit downloading. `-c', `--compact' Compress html files by gzip(1). You need to set up a web server so that gzip(1) is invoked for each compressed file. See `HTML/.htaccess' that is generated by htags. `--cvsweb' url Include cvsweb URL. url is used as base of URL. When directory `CVS' exists in the root directory of source project, content of `CVS/Repository' is used as relative path from the base. `--cvsweb-cvsroot' cvsroot Specifies cvsroot in cvsweb URL. `-D', `--dynamic' Generate object lists dynamically using CGI program. By default, object lists are generated statically. Though this option decrease both the size and the generation time of the hypertext, you need to set up a web server, and you cannot move the hypertext from the source directroy. `-d', `--dbpath' dbpath Specifies the directory in which `GTAGS' and `GRTAGS' exist. The default is the current directory. `-f', `--form' Support search form using CGI program. You need to set up a web server, and you cannot move the hypertext from the source directroy. `-F', `--frame' Use frame for each part of the contents. `--full-path' List file names with full path in file index. By default, list just the last component of a path. `-g', `--gtags' Execute gtags(1) before creating hypertext. The `-v', `-w' and dbpath are passed to gtags. `-h', `--func-header'[=position] Insert function header for each function. By default, htags doesn't generates it. You can specify the position using position argument, which allows one of `before', `right' and `after'. The default position is `after'. `-I', `--icon' Use icons instead of text for some links. `--disable-grep' Disable grep in search form(-f,-form). `--gtagsconf' file Load user's configuration from file. `--gtagslabel' label label is used for the label of configuration file. The default is `default'. `--insert-header' file Insert custom header derived from file after tag. `--insert-footer' file Insert custom footer derived from file before tag. `--item-order' spec Specify order of items in the top page. The spec is a string consists of item signs in order. Each sign means as follows: c: caution, s: search form, m: mains, d: definition, f: files. The default is csmdf. `-m', `--main-func' name Specify the main function name. The default is `main'. `-n', `--line-number'[=columns] Print line numbers. By default, doesn't print them. The default value of columns is 4. `--no-map-file' Doesn't generate `MAP' and `FILEMAP' file. By default, htags generates them. `-o', `--other' Pick up not only source files but also other files except for binary files. `--statistics' Print statistics information. `-s', `--symbol' Make anchors not only for functions but also other symbols. `GSYMS' tag file needed. `-S', `--secure-cgi' cgidir Write CGI programs into the cgidir to realize a centralised CGI program. Script alias is `/cgi-bin' by default. You can overwrite this value using config variable `script_alias' in `gtags.conf'. `-t', `--title' title The title of this hypertext. The default is the last component of the current directory. `-T', `--table-flist'[=fields] Generate file list using tag. The fields is used for field number in a line. The default is 5. `--table-list' List tags using
tag. `--tabs number' Tab stop. The default is 8. `-v', `--verbose' Verbose mode. `-w', `--warning' Print warning messages. `-x', `--xhtml'[=version] Generate XHTML hypertext instead of HTML. If the `--frame' option is specified then generate XHTML-1.0 Frameset for index.html and generate XHTML-1.0 Transitional for other files, else if version is `1.1' or config variable `xhtml_version' is set to `1.1' then generate XHTML-1.1 else XHTML 1.0 Transitional. dir The directory in which hypertext is generated. The default is the current directory. EXAMPLES -------- $ gtags -v $ htags -sanohITvt 'Welcom to XXX source tour!' $ firefox HTML/index.html FILES ----- `GTAGS' Tag file for function definitions. `GRTAGS' Tag file for function references. `GSYMS' Tag file for other symbols. `GPATH' Tag file for path of source files. `/etc/gtags.conf', `$HOME/.globalrc' Configuration file. `HTML/index.html' Index file for hypertext. `HTML/MAP' Mapping file for converting tag into path of hypertext. External system utilize this file. `HTML/FILEMAP' Mapping file for converting file name into path of hypertext. External system utilize this file. `HTML/style.css' Style sheet file. This file is generated when the `--xhtml' option is specified. ENVIRONMENT ----------- The following environment variables affect the execution of htags: TMPDIR If this variable is set, its value is used as the directory to make temporary files. The default is `/tmp'. GTAGSCONF If this variable is set, its value is used as the configuration file. The default is `$HOME/.globalrc'. GTAGSLABEL If this variable is set, its value is used as the label of configuration file. The default is `default'. GTAGSCACHE If this variable is set, its value is used as the size of btree cache. The default is 500000 (bytes). CONFIGURATION ------------- The following configuration variables affect the execution of htags: If the `--xhtml' option is specified then all definitions of HTML tag are ignored. Instead, you can customize the appearance using style sheet file (`style.css'). `datadir'(string) Shared data directory. The default is '/usr/local/share' but you can change the value using configure script. Htags lookup template files in the 'gtags' directory in this data directory. `htags_options'(string) Default options for htags. This value is inserted into the head of arguments. `xhtml_version'(1.0|1.1) XHTML version. 1.0 and 1.1 are acceptable. The default is 1.0. `body_begin'(string) Begin tag for body. The default is ''. `body_end'(string) End tag for body. The default is ''. `table_begin'(string) Begin tag for table. The default is '
'. `table_end'(string) End tag for table. The default is '
'. `title_begin'(string) Begin tag for Title. The default is '

'. `title_end'(string) End tag for Title. The default is '

'. `comment_begin'(string) Begin tag for comments. The default is ''. `comment_end'(string) End tag for comments. The default is ''. `dynamic'(boolean) Generate object list dynamically. `sharp_begin'(string) Begin tag for 'define'. The default is ''. `sharp_end'(string) End tag for 'define'. The default is ''. `brace_begin'(string) Begin tag for brace. The default is ''. `brace_end'(string) End tag for brace. The default is ''. `reserved_begin'(string) Begin tag for reserved word. The default is ''. `reserved_end'(string) End tag for reserved word. The default is ''. `position_begin'(string) Begin tag for posiotion mark. The default is ''. `position_end'(string) End tag for posiotion mark. The default is ''. `colorize_warned_line'(boolean) Colorize warned line using `warned_line_begin' and `warned_line_end'. The default is false. `warned_line_begin'(string) Begin tag for line which htags warned. The default is ''. `warned_line_end'(string) End tag for line which htags warned. The default is ''. `hr'(string) Horizontal rules. The default is '
'. `ncol'(number) Columns of line number. The default is 4. `tabs'(number) Tab stop. The default is 8. `flist_fields'(number) Field number of file index. The default is 5. `full_path'(boolean) List file names with full path in file index. By default, list just the last component of a path. `table_list'(boolean) List tags using tag. The default is false. `table_flist'(boolean) Use
tag for file index. The default is false. `normal_suffix'(string) Suffix for normal html file. The default is 'html'. `no_map_file'(boolean) Doesn't generate `MAP' file. The default is false. `gzipped_suffix'(string) Suffix for compressed html file. The default is 'ghtml'. `script_alias'(string) Script alias for safe cgi script (`-S'). `show_position'(boolean) Show position per function definition. The default is false. `definition_header'(no|before|right|after) Position of function header. The default is 'no'. `other_files'(boolean) File index includes not only source files but also other files. The default is false. `disable_grep'(boolean) Disable grep in search form(-f,-form). The default is false. `enable_idutils'(boolean) Enable idutils in search form(-f,-form). The default is false. `include_file_suffixes'(comma separated list) Suffixes of include file. The default is 'h,hxx,hpp,H,inc.php'. `langmap'(comma separated list) Language mapping. Each comma-separated map consists of the language name, a colon, and a list of file extensions. Default mapping is 'c:.c.h,yacc:.y,asm:.s.S,java:.java,cpp:.c++.cc.cpp.cxx.hxx.hpp.C.H,php:.php.php3.phtml'. `copy_files'(boolean) Copy files instead of linking. When the `-f' option is used, htags make links of tag files in `cgi-bin' directory by default. DIAGNOSTICS ----------- Htags exits with a non 0 value if an error occurred, 0 otherwise. MESSAGE FORMAT -------------- Verbose message has important level. The most important level is 0, the second it 1 and so on. All the message has level numbers leading blanks. SEE ALSO -------- gtags-parser(1), global(1), gtags(1). GNU GLOBAL source code tag system (http://www.gnu.org/software/global/). BUG --- Generated hypertext is VERY LARGE. In advance, check the space of your disk. PHP supprt is far from complete. AUTHOR ------ Tama Communications Corporation. HISTORY ------- The htags command appeared in FreeBSD 2.2.2.  File: global.info, Node: gtags-parser, Next: gozilla, Prev: htags, Up: Reference 5.4 gtags-parser - print cross reference list for gtags. ======================================================== NAME ---- gtags-parser - print cross reference list for gtags. SYNOPSIS -------- gtags-parser [-bdenqrstvw] file ... DESCRIPTION ----------- Gtags-parser print cross reference list for gtags(1) from the specified C, C++, yacc, java, PHP and Assembly source to standard output. Each line of output contains the object name, the line number which it appears, the file in which it is defined, and a line image separated by white-space. It's same with the output of ctags(1) with `-x' option. Depending upon the options provided to gtags-parser, objects will consist of function definitions, function references and other symbols. Files whose names end in `.c' or `.h' are assumed to be C source files and are searched for C style routine and macro definitions. Files whose names end in `.c++' `.cc' `.cpp' `.cxx' `.hxx' `.hpp' `.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 `.java' are assumed to be Java source files. Files whose names end in `.php' `.php3' `.phtml' are assumed to be PHP source files. Files whose names end in `.s' or `.S' are assumed to be Assembler source files. Other files are searched for C style definitions. Yacc files each have a special tag. yyparse is the start of the second section of the yacc file. This command is the default parser of GLOBAL source code tag system. OPTIONS ------- The following options are available: `-b', `--begin-block' Force level 1 block to begin when reach a left brace at the first column. (C only) `-d', `--define' Pick up not only function but also macro without argument as a definition. `-e', `--end-block' Force level 1 block to end when reach a right brace at the first column. (C only) `-n', `--no-tags' Suppress output of tags. It is useful to use with `-w' option. `-q', `--quiet' Quiet mode. `-r', `--reference' Locate function references instead of function definitions. `GTAGS' is needed at the current directory. (C, C++ and Java source only) By default, locate function definitions. `-s', `--symbol' Collect symbols other than functions. By default, locate function definitions. `-t', `--typedef' Pick up not only function but also typedef name and enum member as a definition. `-v', `--verbose' Verbose mode. `-w', `--warning' Print warning message. `--langmap'=map Language mapping. Each comma-separated map consists of the language name, a colon, and a list of file extensions. Default mapping is 'c:.c.h,yacc:.y,asm:.s.S,java:.java,cpp:.c++.cc.cpp.cxx.hxx.hpp.C.H,php:.php.php3.phtml'. The `-r' and `-s' options override each other; the last one specified determines the method used. DIAGNOSTICS ----------- Gtags-parser exits with a non 0 value if an error occurred, 0 otherwise. Duplicate objects are not considered errors. SEE ALSO -------- global(1), gtags(1), htags(1). GNU GLOBAL source code tag system (http://www.gnu.org/software/global/). BUG --- Gtags-parser relies on the input being well formed, and any syntactical errors will completely confuse it. Assembler support is far from complete. Probably valid only for FreeBSD and Linux kernel source. AUTHOR ------ Tama Communications Corporation. HISTORY ------- The gtags-parser(gctags) command appeared in FreeBSD 2.2.2.  File: global.info, Node: gozilla, Next: gtags-cscope, Prev: gtags-parser, Up: Reference 5.5 gozilla - force mozilla to display specified source file. ============================================================= NAME ---- gozilla - force mozilla to display specified source file. SYNOPSIS -------- gozilla [-b browser][-p][+no] file gozilla [-b browser][-p] -d name DESCRIPTION ----------- Gozilla force mozilla to display specified source file as a hypertext. Gozilla can be used with other browsers like firefox and epiphany. In advance of using this command, you must execute gtags(1) and htags(1) at the root directory of the source tree to make tag files. Then you can execute gozilla at anywhere in the source tree. First form: You can specify source file and the line number optionally. Second form: You can specify definition name directly. Definition name must exist in `GTAGS' tag file. Some browsers require you to load it before executing gozilla. Whether or not gozilla waits for exiting of browser depends on browser. OPTIONS ------- The following options are available: `+no' line number. It must be a line on which function definition or function reference is exist. If you execute htags(1) with `-l' option, you can specify any line. `-b' browser browser to use. By default, it is assumed mozilla. `-p' just print generated target URL. file path of source file or alias name. `-d' name print function. `-q', `--quiet' Quiet mode. `-v', `--verbose' Verbose mode. `--version' Show version number. `--help' Show help. FILES ----- `HTML/' hypertext of source tree. `GTAGS/' tags file for function definitions. `$HOME/.gozillarc' alias file. Please read source code for the detail. ENVIRONMENT ----------- GTAGSROOT The directory which is the root of source tree. GTAGSDBPATH The directory on which gtags database exist. This value is ignored when GTAGSROOT is not defined. BROWSER browser to use. By default, it is assumed mozilla. EXAMPLES -------- $ gtags $ htags $ global -x main main 82 ctags.c main(argc, argv) $ mozilla & $ gozilla +82 ctags.c $ firefox & $ gozilla -b firefox +82 ctags.c $ setenv BROWSER 'epiphany --new-tab' $ epiphany & $ gozilla +82 ctags.c DIAGNOSTICS ----------- Gozilla exits with a non 0 value if an error occurred, 0 otherwise. SEE ALSO -------- global(1), gtags(1), htags(1), firefox(1), epiphany(1), mozilla(1). GNU GLOBAL source code tag system (http://www.gnu.org/software/global/). NOTES ----- Gozilla means 'Global for mozilla'. BUGS ---- Gozilla can treat not only source file but also normal file, directory, HTML file and even URL, because it is omnivorous. AUTHORS ------- Tama Communications Corporation. HISTORY ------- The gozilla command appeared in FreeBSD 2.2.2 but did not installed by default.  File: global.info, Node: gtags-cscope, Prev: gozilla, Up: Reference 5.6 gtags-cscope - pseudo cscope which implements the line-oriented interface ============================================================================= NAME ---- gtags-cscope - pseudo cscope which implements the line-oriented interface SYNOPSIS -------- gtags-cscope [-Cqv] DESCRIPTION ----------- Gtags-cscope is a pseudo cscope which implements the line-oriented interface. You can use this command for various clients instead of true cscope. Since gtags-cscope is intended to make GLOBAL available through cscope interface, the output is not necessarily the same as cscope. OPTIONS ------- The following options are available: `-C', `--ignore-case' Ignore letter case when searching. `-q', `--quiet' Quiet mode. `-v', `--verbose' Verbose mode. EXAMPLES -------- $ gtags-cscope >> help 0: Find this C symbol 1: Find this definition 2: Find functions called by this function (Not implemented yet.) 3: Find functions calling this function 4: Find this text string 6: Find this egrep pattern 7: Find this file 8: Find files #including this file c: Toggle ignore/use letter case r: Rebuild the database q: Quit the session h: Show help >> 1main cscope: 9 lines global/global.c main 158 main(int argc, char **argv) gozilla/gozilla.c main 155 main(int argc, char **argv) gtags-parser/gctags.c main 158 main(int argc, char **argv) gtags-cscope/gtags-cscope.c main 115 main(int argc, char **argv) gtags/gtags.c main 150 main(int argc, char **argv) htags-refkit/htags_path2url.c main 281 main(int argc, char **argv) htags/htags.c main 1400 main(int argc, char **argv) libglibc/getopt.c main 704 main (argc, argv) libglibc/getopt1.c main 93 main (argc, argv) >> q $ _ DIAGNOSTICS ----------- Gtags-cscope exits with a non 0 value if an error occurred, 0 otherwise. SEE ALSO -------- cscope(1), gtags-parser(1), gtags(1), global(1), htags(1). GNU GLOBAL source code tag system (http://www.gnu.org/software/global/). BUG --- The second field of the output is almost since GLOBAL doesn't recognize it. Command 2 (Find functions called by this function) is not implemented. AUTHOR ------ Tama Communications Corporation. HISTORY ------- The gtags-cscope command appeared in 2006.  File: global.info, Node: Copying This Manual, Next: Business Model, Prev: Reference, Up: Top Appendix A Copying This Manual ****************************** * Menu: * GNU Free Documentation License:: License for copying this manual.  File: global.info, Node: GNU Free Documentation License, Up: Copying This Manual A.1 GNU Free Documentation License ================================== Version 1.2, November 2002 Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 0. PREAMBLE The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. 1. APPLICABILITY AND DEFINITIONS This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law. A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque". Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text. A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition. The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License. 2. VERBATIM COPYING You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3. You may also lend copies, under the same conditions stated above, and you may publicly display copies. 3. COPYING IN QUANTITY If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects. If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages. If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public. It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document. 4. MODIFICATIONS You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version: A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission. B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement. C. State on the Title page the name of the publisher of the Modified Version, as the publisher. D. Preserve all the copyright notices of the Document. E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below. G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice. H. Include an unaltered copy of this License. I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission. K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein. L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles. M. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version. N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section. O. Preserve any Warranty Disclaimers. If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles. You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard. You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one. The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version. 5. COMBINING DOCUMENTS You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers. The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements." 6. COLLECTIONS OF DOCUMENTS You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document. 7. AGGREGATION WITH INDEPENDENT WORKS A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate. 8. TRANSLATION Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail. If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title. 9. TERMINATION You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 10. FUTURE REVISIONS OF THIS LICENSE The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See `http://www.gnu.org/copyleft/'. Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. A.1.1 ADDENDUM: How to use this License for your documents ---------------------------------------------------------- To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: Copyright (C) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''. If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with...Texts." line with this: with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation. If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.  File: global.info, Node: Business Model, Next: Index, Prev: Copying This Manual, Up: Top Appendix B Business Model ************************* * Menu: * The BOKIN Model Definition:: Business Model for Free Software. * Frequently Asked Questions:: BOKIN Model Frequently Asked Questions.  File: global.info, Node: The BOKIN Model Definition, Next: Frequently Asked Questions, Up: Business Model B.1 The BOKIN Model Definition ============================== Version 1.0, December 17, 2005 Copyright (C) 2005 Tama Communications Corporation Everyone is permitted to copy and distribute verbatim copies of this document, but changing it is not allowed. Introduction ------------ "BOKIN Model" is a business model to obtain proceeds by widely collecting donations while developing and distributing free software. This model is constructed not to take away consumer's freedom of software. The business which comply with the following criteria can be called "a business based on BOKIN Model". Criteria -------- 1. CORPORATION The person who start a business based on BOKIN Model must be a business corporation registered in the home country. (Herein after called "the corporation") 2. FREE SOFTWARE The corporation develops free software. (Herein after called "the BOKINware") 3. LICENSE The corporation distributes the BOKINware under GNU GPL (GNU General Public License) and GNU FDL (GNU Free Documentation License). Exceptionally, external packages which the BOKINware uses, small supporting files, short manuals and rough documentation can use simple all-permissive license, compatible with GNU GPL. 4. COPYRIGHT MANAGEMENT The corporation manages copyright on the BOKINware for consumers to keep on using it at ease. * Every file in the BOKINware should have a legally valid copyright notice and a license notice. * To include program which is assigned from another developer, the corporation receives a disclaimer paper or assignment paper signed by the author. * To include program which is not assigned, the corporation confirms its license is GNU GPL or compatible with GNU GPL, lists the files and authors in a file named `AUTHORS', and lists the license in a file named `LICENSE'. The BOKINware should contain these two files. 5. MAILING LIST The corporation maintains mailing lists for consumers to cooperate one another. The list members, including the corporation, don't owe any duty. The mailing lists should include the following two at least. * Bug mailing list This list distributes, to the active maintainers of the BOKINware, bug reports and fixes for, and suggestions for improvements in the BOKINware. This list is also for user discussion. * Help mailing list This list is the place for authors, users and installers of the BOKINware to ask for help. The mailing lists can be replaced with a similar communication tool. The corporation can decide the operation policy of the list, but must not obstruct the list members to cooperate one another. 6. COLLECTING DONATIONS The corporation collects donations widely as its proceeds. The corporation must not offer the donor an individual supply of profit. 7. DONOR LIST The corporation open the donor list to the public. The donor list includes the following information. * Date of donation (The date when the corporation received the donation) * Amount of donation (Amount which the corporation received) * Donor's name * Donor's nationality When donor's name and nationality are unknown or the donor prefers to remain anonymous, they are treated as "anonymous". The BOKINware should contain the donor list as a file named `DONORS'. It is preferable that the list is open to the public even on the Internet. 8. BOKIN MODEL DEFINITION The BOKINware should contain the present definition as a file named `BOKIN_MODEL'. Renewal ------- The author may publish revised and/or new versions of the BOKIN Model Definition from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.  File: global.info, Node: Frequently Asked Questions, Prev: The BOKIN Model Definition, Up: Business Model B.2 Frequently Asked Questions ============================== Version 1.0, December 17, 2005 Copyright (C) 2005 Tama Communications Corporation Everyone is permitted to copy and distribute verbatim copies of this document, but changing it is not allowed. BOKIN Model Frequently Asked Questions -------------------------------------- 1. What does "BOKIN" mean? "BOKIN" means collecting donations in Japanese. ("BO"=collect, "KIN"=money) 2. What is the purpose to require the person who start a BOKIN model business being a registered corporation? The purpose is to prevent people from donating to the person who does not exist actually. 3. Is annoying copyright management necessary? Yes, it is. Copyright management is absolutely necessary for consumers to keep on using the BOKINware at ease. It is dangerous to use the software whose copyright is not neatly managed. If you use such software, you might suddenly be prohibited to use it, or be claimed a license fee of high priced. These are not imaginary fears but troubles of reality. 4. Why is program license limited to GNU GPL? Because GNU GPL defends consumers in two points. * Copyleft License Since GNU GPL is copyleft license, it makes a program free, and requiring all modified and extended versions of the program to be free as well. As a result, consumer can keep on using the BOKINware at ease in the future. * Widely Known Since GNU GPL is widely known, and is explained frequently, it does not become the load to consumer. It is troublesome for consumer to understand new licenses. 5. What is the purpose of the donor list? There are two purposes. * To defend freedom of donation. The consumer can decide whether to donate after understanding the situation of the donation. If nothing being informed, freedom does not exist there. In BOKIN model, consumers are not isolated existence. * To praise donation. To praise donation brings new donors. Since BOKIN model owes all to people's free wills, we cannot praise the donation too much. 6. Is donation spent on the BOKINware? It depends on the management of the corporation. Since donations become the proceeds of the corporation, the corporation itself decides the usage under its freedom. 7. Is the donor list kept true? It is very difficult to mix lies in the public information, because it is checked by various methods. * Donors can confirm whether they are listed. * People can ask whether to have donated to the donors in the list. * The tax office can examine the contradiction between the content of the list and the content of the declaration of the corporation's taxation business. 8. Why is the corporation prohibited from doing an individual supply of profit for the donors? When individual supply of profit becomes ordinary, donation fall into the payment for the profit. We cannot call it donation. BOKIN Model business should be supported only by people's free will.  File: global.info, Node: Index, Prev: Business Model, Up: Top Option Index ************ [index] * Menu: * -a: Basic usage. (line 75) * -c: Applied usage. (line 94) * -f <1>: Basic usage(vim). (line 54) * -f <2>: Applied usage(elvis). (line 12) * -f <3>: Basic usage(elvis). (line 43) * -f: Basic usage. (line 110) * -g <1>: Basic usage(vim). (line 50) * -g <2>: Applied usage(vim). (line 6) * -g <3>: Basic usage(elvis). (line 23) * -g <4>: Basic usage. (line 89) * -g: Applied usage(elvis). (line 6) * -P <1>: Basic usage. (line 96) * -P <2>: Applied usage(vim). (line 18) * -P: Applied usage(elvis). (line 16) * -r <1>: Basic usage. (line 51) * -r <2>: Plugin. (line 26) * -r <3>: Basic usage(vim). (line 40) * -r: Basic usage(elvis). (line 13) * -s <1>: Basic usage(elvis). (line 19) * -s <2>: Basic usage(vim). (line 46) * -s <3>: Plugin. (line 26) * -s: Basic usage. (line 82) * -t: Preparation(elvis). (line 9) * -u: Incremental updating. (line 7) * -x: Basic usage. (line 66) * FDL, GNU Free Documentation License: GNU Free Documentation License. (line 6)  Tag Table: Node: Top747 Node: Introduction1439 Node: Global3533 Node: Preparation3955 Node: Basic usage5055 Node: Applied usage8748 Node: Applications14423 Node: GloBash15133 Node: Features(globash)15473 Node: Preparation(globash)15828 Node: Basic usage(globash)16749 Node: Applied usage(globash)20102 Node: Less viewer21967 Node: Features(less)22401 Node: Preparation(less)22638 Node: Basic usage(less)22996 Node: Applied usage(less)23999 Node: Nvi-1.79 editor25596 Node: Features(nvi-1.79)26053 Node: Preparation(nvi-1.79)26438 Node: Basic usage(nvi-1.79)27254 Node: Applied usage(nvi-1.79)28898 Node: Nvi-1.81.5 editor30525 Node: Features(nvi-1.81.5)30915 Node: Preparation(nvi-1.81.5)31170 Node: Basic usage(nvi-1.81.5)31923 Node: Elvis editor33778 Node: Features(elvis)34281 Node: Preparation(elvis)34541 Node: Basic usage(elvis)34955 Node: Applied usage(elvis)36940 Node: Vim editor38431 Node: Features(vim)38848 Node: Preparation(vim)39163 Node: Basic usage(vim)39522 Node: Applied usage(vim)41082 Node: Emacs editor43006 Node: Features(emacs)43444 Node: Preparation(emacs)43789 Node: Basic usage(emacs)45239 Node: Applied usage(emacs)47530 Node: Web browser49114 Node: Features(browser)49492 Node: Preparation(browser)49978 Node: Usage(browser)51099 Node: Doxygen documentation system51844 Node: Other topics52562 Node: Configuration52874 Node: Plugin53580 Node: Incremental updating56109 Node: Reference57517 Node: global58099 Node: gtags64979 Node: htags71008 Node: gtags-parser82808 Node: gozilla86442 Node: gtags-cscope89459 Node: Copying This Manual91979 Node: GNU Free Documentation License92225 Node: Business Model114635 Node: The BOKIN Model Definition114930 Node: Frequently Asked Questions119128 Node: Index122541  End Tag Table