[llvm-nm] Update documentation to cover object file support and arguments.
[oota-llvm.git] / docs / CommandGuide / index.rst
1 .. _commands:
2
3 LLVM Command Guide
4 ------------------
5
6 The following documents are command descriptions for all of the LLVM tools.
7 These pages describe how to use the LLVM commands and what their options are.
8 Note that these pages do not describe all of the options available for all
9 tools. To get a complete listing, pass the ``--help`` (general options) or
10 ``--help-hidden`` (general and debugging options) arguments to the tool you are
11 interested in.
12
13 Basic Commands
14 ~~~~~~~~~~~~~~
15
16 .. toctree::
17    :maxdepth: 1
18
19    llvm-as
20    llvm-dis
21    opt
22    llc
23    lli
24    llvm-link
25    llvm-ar
26    llvm-ranlib
27    llvm-nm
28    llvm-prof
29    llvm-config
30    llvm-diff
31    llvm-cov
32    llvm-stress
33
34 Debugging Tools
35 ~~~~~~~~~~~~~~~
36
37 .. toctree::
38    :maxdepth: 1
39
40    bugpoint
41    llvm-extract
42    llvm-bcanalyzer
43
44 Developer Tools
45 ~~~~~~~~~~~~~~~
46
47 .. toctree::
48    :maxdepth: 1
49
50    FileCheck
51    tblgen
52    lit
53    llvm-build