Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
121 lines (75 sloc) 3.11 KB

NAME

annot -- lookup OCaml annotations

SYNOPSIS

annot [-n] [-r] -type line column [file.annot]

annot -dump [file.annot]

annot -help

annot -version

DESCRIPTION

Annot looks up annotations for identifiers in an OCaml source file. Such annotations are produced by ocaml(1) and stored in *.annot files, which is either read from standard input, or from file.annot. Currently, only the lookup of type annotations is supported. For lookup of an annotation, the identifier's source code position as line and column is passed to annot. It is typically invoked from an editor to lookup the type of an identifier under the cursor.

OPTIONS

-type line column

Lookup the type annotation for position line and column and emit it to standard output.

-dump

Dump the annotations read to stdout. This is mostly used for debugging.

-n

Don't print a newline after emitting an annotation to standard output. This is sometimes useful when showing the output inside an editor.

-r

When emitting an annotation include the source-code range for which the annotation is intended. This could be used to highlight it in an editor.

-h

Emit short help message to stdout and exit with code 0.

-version

Emit the version of annot to stdout and exit with code 0.

AUTHOR

Please send feedback, bug reports, and experience reports to the author: Christian Lindig <lindig@cs.uni-sb.de> http://www.st.cs.uni-sb.de/~lindig/

COPYRIGHT

Copyright (c) 2006 Christian Lindig <lindig@cs.uni-sb.de>. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. The names of the contributors may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

VERSION

$Id$

SEE ALSO

ocaml(1), ocamlc(1)