]> code.delx.au - gnu-emacs-elpa/blobdiff - packages/ggtags/README
Various bug fixes and enhancements
[gnu-emacs-elpa] / packages / ggtags / README
index 67ab79d46ad74f7e4bbe4a439895c9c1c7835776..04347c0eef639c9aca106119ef5fd8c399354693 100644 (file)
@@ -1,19 +1,19 @@
-A package for working with GNU Global source tagging system inside
-Emacs.
-
-Usage:
 Type `M-x ggtags-mode' to enable the minor mode, or as usual enable it
-in your desired major mode hooks. When the mode is on, the symbol at
+in your desired major mode hooks. When the mode is on the symbol at
 point is underlined if it is a valid tag.
 
-`M-.' finds definitions/declarations and `C-u M-.' finds references.
+`M-.' finds definitions or references according to the tag at point,
+i.e. if point is at a definition tag find references and vice versa.
+`C-u M-.' is verbose and will ask you the name - with completion - and
+the type of tag to search.
 
-If multiple matches are found, navigation mode is enabled. In this
-mode, `M-n' and `M-p' moves to next and previous match, and M-} and
-M-{ to next and previous file, respectively. `M-o' toggles between
+If multiple matches are found, navigation mode is entered. In this
+mode, `M-n' and `M-p' moves to next and previous match, `M-}' and
+`M-{' to next and previous file respectively. `M-o' toggles between
 full and abbreviated displays of file names in the auxiliary popup
-window. When you have found the right match, press RET to finish,
-which can be resumed with `C-c M-n'. `M-*' aborts the search.
+window. When you locate the right match, press RET to finish which
+hides the auxiliary window and exits navigation mode. You can resume
+the search using `M-,'. To abort the search press `M-*'.
 
 Normally after a few searches a dozen buffers are created visiting
 files tracked by GNU Global. `C-c M-k' helps clean them up.