|
7019
|
1 .\" Copyright (C) 2003, 2006, 2007 Dirk Eddelbuettel |
|
|
2 .\" |
|
|
3 .\" This file is part of Octave. |
|
|
4 .\" |
|
|
5 .\" Octave is free software; you can redistribute it and/or modify it |
|
|
6 .\" under the terms of the GNU General Public License as published by the |
|
|
7 .\" Free Software Foundation; either version 3 of the License, or (at |
|
|
8 .\" your option) any later version. |
|
|
9 .\" |
|
|
10 .\" Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
13 .\" for more details. |
|
|
14 .\" |
|
|
15 .\" You should have received a copy of the GNU General Public License |
|
|
16 .\" along with Octave; see the file COPYING. If not, see |
|
|
17 .\" <http://www.gnu.org/licenses/>. |
|
|
18 .\" |
|
|
19 .\" This page was contributed by Dirk Eddelbuettel <edd@debian.org> |
|
|
20 .\" |
|
6071
|
21 .TH OCTAVE-TAGS 1 "31 October 2001" "GNU Octave" |
|
|
22 .SH NAME |
|
|
23 OCTAVE-TAGS - Generate Emacs tags file from GNU Octave code |
|
|
24 .SH SYNOPSIS |
|
|
25 .BR octave-tags\ [--include\ dir] |
|
|
26 \fIfile\fP .\|.\|. |
|
|
27 .SH DESCRIPTION |
|
|
28 .PP |
|
|
29 .B octave-tags |
|
|
30 program is used to create a tag table file, in a format understood by |
|
|
31 .BR emacs (1) |
|
|
32 and |
|
|
33 .BR xemacs (1). |
|
|
34 .B octave-tags |
|
|
35 reads the files specified on the command line, and write a tag table |
|
|
36 (defaults: `TAGS') in the current working directory. Files specified with |
|
|
37 relative file names will be recorded in the tag table with file names |
|
|
38 relative to the directory where the tag table resides. Files specified with |
|
|
39 absolute file names will be recorded with absolute file names. |
|
|
40 |
|
|
41 The |
|
|
42 .I --include |
|
|
43 option can be used to specify another directoy with Octave files for which |
|
|
44 tags shall be generated. |
|
|
45 |
|
|
46 Tags are generated for function names and for global variables. For |
|
|
47 global variables it doesn't work for more than one line global |
|
|
48 variables. |
|
|
49 |
|
|
50 Tags are also created for lines of the form '###key foobar' so that |
|
|
51 you can jump to this specific place just by typing `M-. foobar'. |
|
|
52 Note that tags are not generated for scripts so that you have to add |
|
|
53 a line by yourself of the form `###key <script-name>' if you want to |
|
|
54 jump to it. |
|
|
55 |
|
|
56 .SH SEE ALSO |
|
|
57 .BR etags (1). |
|
|
58 |
|
|
59 .SH AUTHORS |
|
|
60 Mario Storti <mstorti@minerva.unl.edu.ar> |
|
|
61 |
|
|
62 This manual page was contributed by Dirk Eddelbuettel |
|
|
63 <edd@debian.org> for the Debian GNU/Linux distribution but |
|
|
64 may be used by others. |
