1typer(3)                   Erlang Module Definition                   typer(3)
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
15       description  of  the  options.  The same information can be obtained by
16       writing 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]
24             [-Ddefine]* [-I include_dir]* [-pa dir]* [-pz dir]*
25             [-T application]* [-r] file*
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.
35
36         --show:
37           Print type specifications for all functions on stdout. (This is the
38           default behaviour; this option is not really needed.)
39
40         --show-exported (or show_exported):
41           Same  as  --show,  but  print specifications for exported functions
42           only. Specs are displayed sorted alphabetically on  the  function's
43           name.
44
45         --annotate:
46           Annotate the specified files with type specifications.
47
48         --annotate-inc-files:
49           Same  as  --annotate  but annotates all -include() files as well as
50           all .erl files. (Use this option with caution -  it  has  not  been
51           tested much).
52
53         --edoc:
54           Print type information as Edoc @spec comments, not as type specs.
55
56         --plt:
57           Use the specified dialyzer PLT file rather than the default one.
58
59         -T file*:
60           The specified file(s) already contain type specifications and these
61           are to be trusted in order to print  specs  for  the  rest  of  the
62           files.  (Multiple files or dirs, separated by spaces, can be speci‐
63           fied.)
64
65         -Dname (or -Dname=value):
66           Pass the defined name(s) to TypEr. (**)
67
68         -I:
69           Pass the include_dir to TypEr. (**)
70
71         -pa dir:
72           Include dir in the path for Erlang. This is useful  when  analyzing
73           files that have -include_lib() directives or use parse transforms.
74
75         -pz dir:
76           Include  dir  in the path for Erlang. This is useful when analyzing
77           files that have -include_lib() directives or use parse transforms.
78
79         --version (or -v):
80           Print the TypEr version and some more information and exit.
81
82   Note:
83       ** options -D and -I work both from the command line and in  the  TypEr
84       GUI;  the  syntax  of  defines and includes is the same as that used by
85       erlc(1).
86
87
88
89Ericsson AB                      dialyzer 4.1                         typer(3)