Getting Help

On a Unix system, we can access the man pages as follows:

 
$ ​erl -man erl
 
NAME
 
erl - The Erlang Emulator
 
 
DESCRIPTION
 
The erl program starts the Erlang runtime system.
 
The exact details (e.g. whether erl is a script
 
or a program and which other programs it calls) are system-dependent.
 
...

We can also get help about individual modules as follows:

 
$ ​erl -man lists
 
MODULE
 
lists - List Processing Functions
 
 
DESCRIPTION
 
This module contains functions for list processing.
 
The functions are organized in two groups:
 
...

Note: On a Unix system, the manual pages are not installed by default. If the command erl -man ... does not work, then you need to install the manual pages. All the manual pages are in a single compressed ...

Get Programming Erlang, 2nd Edition now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.