Mercurial > hg > octave-avbm
changeset 4333:c17f6d87da97
[project @ 2003-02-19 04:55:26 by jwe]
author | jwe |
---|---|
date | Wed, 19 Feb 2003 04:58:02 +0000 |
parents | e41906608e0f |
children | 764229f9a5c8 |
files | emacs/Makefile.in emacs/otags.1 |
diffstat | 2 files changed, 47 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/emacs/Makefile.in +++ b/emacs/Makefile.in @@ -23,7 +23,7 @@ SOURCES = $(EL_FILES) otags -DISTFILES = Makefile.in $(EL_FILES) otags NEWS TODO README +DISTFILES = Makefile.in $(EL_FILES) otags otags.1 NEWS TODO README BINDISTFILES = $(addprefix $(srcdir)/, $(EL_FILES) otags NEWS TODO README)
new file mode 100644 --- /dev/null +++ b/emacs/otags.1 @@ -0,0 +1,46 @@ +.\" Man page contributed by Dirk Eddelbuettel <edd@debian.org> +.\" and released under the GNU GPL +.TH OTAGS 1 "31 October 2001" "GNU Octave" +.SH NAME +OTAGS - Generate Emacs tags file from GNU Octave code +.SH SYNOPSIS +.BR otags\ [--include\ dir] +\fIfile\fP .\|.\|. +.SH DESCRIPTION +.PP +.B otags +program is used to create a tag table file, in a format understood by +.BR emacs (1) +and +.BR xemacs (1). +.B otags +reads the files specified on the command line, and write a tag table +(defaults: `TAGS') in the current working directory. Files specified with +relative file names will be recorded in the tag table with file names +relative to the directory where the tag table resides. Files specified with +absolute file names will be recorded with absolute file names. + +The +.I --include +option can be used to specify another directoy with Octave files for which +tags shall be generated. + +Tags are generated for function names and for global variables. For +global variables it doesn't work for more than one line global +variables. + +Tags are also created for lines of the form '###key foobar' so that +you can jump to this specific place just by typing `M-. foobar'. +Note that tags are not generated for scripts so that you have to add +a line by yourself of the form `###key <script-name>' if you want to +jump to it. + +.SH SEE ALSO +.BR etags (1). + +.SH AUTHORS +Mario Storti <mstorti@minerva.unl.edu.ar> + +This manual page was contributed by Dirk Eddelbuettel +<edd@debian.org> for the Debian GNU/Linux distribution but +may be used by others.