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