Mercurial > octave-nkf

annotate emacs/octave-tags.1 @ 6658:db6d908e8a03 ss-2-9-12

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2007-05-23 04:38:07 by jwe]
author jwe
date Wed, 23 May 2007 04:38:08 +0000
parents 950d8cb39617
children 4270ded9ddc6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6071
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
1 .\" Man page contributed by Dirk Eddelbuettel <edd@debian.org>
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
2 .\" and released under the GNU GPL
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
3 .TH OCTAVE-TAGS 1 "31 October 2001" "GNU Octave"
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
4 .SH NAME
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
5 OCTAVE-TAGS - Generate Emacs tags file from GNU Octave code
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
6 .SH SYNOPSIS
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
7 .BR octave-tags\ [--include\ dir]
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
8 \fIfile\fP .\|.\|.
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
9 .SH DESCRIPTION
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
10 .PP
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
11 .B octave-tags
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
12 program is used to create a tag table file, in a format understood by
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
13 .BR emacs (1)
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
14 and
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
15 .BR xemacs (1).
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
16 .B octave-tags
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
17 reads the files specified on the command line, and write a tag table
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
18 (defaults: `TAGS') in the current working directory. Files specified with
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
19 relative file names will be recorded in the tag table with file names
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
20 relative to the directory where the tag table resides. Files specified with
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
21 absolute file names will be recorded with absolute file names.
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
22
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
23 The
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
24 .I --include
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
25 option can be used to specify another directoy with Octave files for which
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
26 tags shall be generated.
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
27
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
28 Tags are generated for function names and for global variables. For
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
29 global variables it doesn't work for more than one line global
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
30 variables.
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
31
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
32 Tags are also created for lines of the form '###key foobar' so that
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
33 you can jump to this specific place just by typing `M-. foobar'.
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
34 Note that tags are not generated for scripts so that you have to add
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
35 a line by yourself of the form `###key <script-name>' if you want to
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
36 jump to it.
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
37
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
38 .SH SEE ALSO
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
39 .BR etags (1).
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
40
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
41 .SH AUTHORS
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
42 Mario Storti <mstorti@minerva.unl.edu.ar>
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
43
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
44 This manual page was contributed by Dirk Eddelbuettel
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
45 <edd@debian.org> for the Debian GNU/Linux distribution but
950d8cb39617 [project @ 2006-10-23 19:30:28 by jwe]
jwe
parents:
diff changeset
46 may be used by others.