1typer(1)                         User Commands                        typer(1)
2
3
4

NAME

6       typer - Typer, a Type annotator for ERlang programs.
7
8

DESCRIPTION

10       TypEr  shows type information for Erlang modules to the user. Addition‐
11       ally, it can annotate the code of files with such type information.
12

USING TYPER FROM THE COMMAND LINE

14       TypEr is used from the command-line. This section provides a brief  de‐
15       scription of the options. The same information can be obtained by writ‐
16       ing the following in a shell:
17
18       typer --help
19
20       Usage:
21
22       typer [--help] [--version] [--plt PLT] [--edoc]
23             [--show | --show-exported | --annotate | --annotate-inc-files | --annotate-in-place]
24             [-Ddefine]* [-I include_dir]* [-pa dir]* [-pz dir]*
25             [-T application]* file* [-r directory*]
26
27   Note:
28       * denotes that multiple occurrences of the option are possible.
29
30
31       Options:
32
33         -r:
34           Search directories recursively for .erl files below them. If a list
35           of files is given, this must be after them.
36
37         --show:
38           Print type specifications for all functions on stdout. (This is the
39           default behaviour; this option is not really needed.)
40
41         --show-exported (or show_exported):
42           Same as --show, but print  specifications  for  exported  functions
43           only.  Specs  are displayed sorted alphabetically on the function's
44           name.
45
46         --annotate:
47           Annotate the specified files with type specifications.
48
49         --annotate-inc-files:
50           Same as --annotate but annotates all -include() files  as  well  as
51           all  .erl  files.  (Use  this option with caution - it has not been
52           tested much).
53
54         --annotate-in-place:
55           Annotate directly on the source code files, instead of dumping  the
56           annotated files in a different directory (use this option with cau‐
57           tion - has not been tested much)
58
59         --edoc:
60           Print type information as Edoc @spec comments, not as type specs.
61
62         --plt:
63           Use the specified dialyzer PLT file rather than the default one.
64
65         -T file*:
66           The specified file(s) already contain type specifications and these
67           are  to  be  trusted  in  order  to print specs for the rest of the
68           files. (Multiple files or dirs, separated by spaces, can be  speci‐
69           fied.)
70
71         -Dname (or -Dname=value):
72           Pass the defined name(s) to TypEr. (**)
73
74         -I:
75           Pass the include_dir to TypEr. (**)
76
77         -pa dir:
78           Include  dir  in the path for Erlang. This is useful when analyzing
79           files that have -include_lib() directives or use parse transforms.
80
81         -pz dir:
82           Include dir in the path for Erlang. This is useful  when  analyzing
83           files that have -include_lib() directives or use parse transforms.
84
85         --version (or -v):
86           Print the TypEr version and some more information and exit.
87
88   Note:
89       **  options  -D and -I work both from the command line and in the TypEr
90       GUI; the syntax of defines and includes is the same  as  that  used  by
91       erlc(1).
92
93
94
95Ericsson AB                     dialyzer 5.0.4                        typer(1)
Impressum