1Commandline tools
2=================
3
4The package can be used as a script using "python -mmodulegraph".
5
6This script calculates the module graph for the scripts passed
7on the commandline and by default prints a list of modules
8in the objectgraph, and their type and location.
9
10The script has a number of options to change the output:
11
12* ``-d``: Increase the debug level
13
14* ``-q``: Clear the debug level (emit minimal output)
15
16* ``-m``: The arguments are module names instead of script files
17
18* ``-x name``: Add ``name`` to the list of excludes
19
20* ``-p path``: Add ``path`` to the module search path
21
22* ``-g``: Emit a ``.dot`` file instead of a list of modules
23
24* ``-h``: Emit a ``.html`` file instead of a list of modules
25
26Deprecation warning
27-------------------
28
29The package also installs a command-line tool named "modulegraph",
30this command-line tool is deprecated and will be removed in a
31future version.
32