diff options
Diffstat (limited to 'contrib/global/README')
| -rw-r--r-- | contrib/global/README | 95 |
1 files changed, 79 insertions, 16 deletions
diff --git a/contrib/global/README b/contrib/global/README index bb1f9e7..f4699f2 100644 --- a/contrib/global/README +++ b/contrib/global/README @@ -3,19 +3,30 @@ @= @= @= @= @= @= @@@@@= @@@@@@= @@= @= - @= F o r a l l h a c h e r s. version 2.0 + @= F o r a l l h a c k e r s. version 2.21 @= @@@@@@=@= @= @= @@@@@= @= @= @= @= @= @= @= @= @= @= @@@@@= @= @= @= @= @= @= @= @=@= @= @= @@@@@@@@= @@@@= @@@@@= @@@@@@=@@@= @@@@= @@@@@@= - Shigio Yamaguchi 7-Jul-97 + Shigio Yamaguchi 11-Dec-97 Copyright 1996, 1997 Shigio Yamaguchi All right resereved. + ---------------------------------------------------------- + Note: + This version of GLOBAL makes 'GSYMS' tag file for + searching symbols other than functions. + (Try global(1) with -s option.) + But the tag file is very large. If you hope not to + make the file, please use gtags with -o (old) option. + Htags(1) doesn't use 'GSYMS'. + ---------------------------------------------------------- + GLOBAL is a browsing system for C and Yacc source code. It brings benefits to all hackers. Enjoy! + Contents -------------------------------- 0. Introduction @@ -40,6 +51,7 @@ It brings benefits to all hackers. Enjoy! 3.2. Preparation 3.3. Usage 3.4. To make hypertext of kernel + 3.5. Gozilla 4. Extended emacs using global @@ -64,7 +76,7 @@ It supports following environments. o emacs editor(see '4. Emacs using global') GLOBAL is consist of global(1), gtags(1), btreeop(1), gctags(1), htags(1), -extended vi(1) and gtags.el. +extended vi(1), gtags.el and gozilla(1). * 'extended' means being entended for GLOBAL. @@ -85,7 +97,7 @@ All the functions for GLOBAL are enabled only in 'gtagsmode'. o Global allows duplicate entries. o Global can treat a source tree containing subdirectories and you can get relative path of objects from anywhere within the tree. - o Global can understand perl's regular expression. + o Global can understand POSIX 1003.2 regular expression (extension). o Global can search in not only a source tree but also library paths. o Global can treat yacc source file. @@ -109,9 +121,6 @@ All the functions for GLOBAL are enabled only in 'gtagsmode'. GTAGS - database for function definition GRTAGS - database for function reference - If you cannot find functions that should exist, please try -e option. - - % gtags -e 1.3. Basic usage @@ -162,7 +171,7 @@ All the functions for GLOBAL are enabled only in 'gtagsmode'. % global -r func2 ../DIR1/fileA.c <- func2() is referred from fileA.c - You can use perl's regular expression. + You can use POSIX regular expression (extension). % cd ROOT % global 'func[1-3]' @@ -182,6 +191,11 @@ All the functions for GLOBAL are enabled only in 'gtagsmode'. % global -a func1 /home/user/ROOT/DIR1/fileB.c + -s option locates any symbols other than function. + + % global -xs X + X 1 DIR2/fileC.c #ifdef X + You can edit files including specified function directly like this. % vi `global func1` <- edit fileB.c @@ -319,8 +333,8 @@ All the functions for GLOBAL are enabled only in 'gtagsmode'. o Tag function of extended vi can locate not only function definitions but also function references. o Extended vi allows duplicate tag entries. - o Extended vi can understand perl's regular expression as a tag name - for search. + o Extended vi can understand POSIX regular expression (extension) + as a tag name for search. o Extended vi is completely upper compatible with original one. Above functions are available only in 'gtags mode'. @@ -488,15 +502,20 @@ All the functions for GLOBAL are enabled only in 'gtagsmode'. disk space. For example, the source code of FreeBSD kernel needs the following disk space. - source code(/usr/src/sys) 14MB - tag database(GTAGS,GRTAGS) 9MB(!) - hypertext(HTML/*) 45MB(!!!) + source code(/usr/src/sys) 14.0MB + + GTAGS 1.5MB + GRTAGS 8.0MB + GSYMS 12.0MB + HTML/ 55MB(!!!) + ------------------------------------------------- + total 77MB Please do the followings. (at your source directory) - % gtags <- make tag database - % htags <- make hypertext + % gtags <- make tag database(GTAGS,GRTAGS,GSYMS) + % htags <- make hypertext(HTML/) Then you will find 'HTML' directory in the current directory. @@ -535,6 +554,41 @@ All the functions for GLOBAL are enabled only in 'gtagsmode'. Of course, you can use above functions without systags. Please see gtags(1), htags(1). +3.5. Gozilla + + If you use Netscape Navigator, you can control the browser from command + line by gozilla(1). + + % gtags + % htags + % global -x fork + fork 60 kern/kern_fork.c fork(p, uap, retval) + % gozilla +60 kern/kern_fork.c + % + + Then you can see the hypertext about fork function directly on Netscape + Navigator. If the browser has not been loaded, gozilla loads it. + + If you use another browser like lynx, try this. + + % gozilla -b lynx +60 kern/kern_fork.c + + or + + % setenv BROWSER lynx + % gozilla +60 kern/kern_fork.c + + You can send remote command to Netscape Navigator too. Try this. + + % gozilla -C pagedown + % gozilla -C pageup + + The remote commands are undocumented, but you can see the hint in the + resource file. (Netscape.ad file) + + NOTES: + Netscape Navigator is a registered trademark of Netscape Communications + Corporation in the United States and other countries. 4. Extended emacs using global @@ -646,9 +700,18 @@ All the functions for GLOBAL are enabled only in 'gtagsmode'. ":rtag <current token>[RETURN]", otherwise ":tag <current token>[RETURN]". (GLOBAL decides this intelligentlly, but may sometimes misunderstand.) + o To go to any symbols other than function, try 'ESC-s'. + + Find symbol: lbolt + ~~~~~ + o To go to any strings other than symbol, try 'ESC-g'. + + Find pattern: Copyright + ~~~~~~~~~ + 4.4. Applied usage - o You can use perl's regular expression. + o You can use POSIX regular expression (extension). :tag ^put_ # locate tags start with 'put_'. |
