summaryrefslogtreecommitdiff
path: root/docs/CommandGuide/index.rst
diff options
context:
space:
mode:
authorDaniel Dunbar <daniel@zuster.org>2012-05-08 16:50:35 +0000
committerDaniel Dunbar <daniel@zuster.org>2012-05-08 16:50:35 +0000
commit3b709d5f5532bacb6c351def8c9bc7efef36fa33 (patch)
treeb102b42b9ae1e20ad6553249b348619b34f11669 /docs/CommandGuide/index.rst
parentf647c1b7776f34125441f6edeb449be63b470dd7 (diff)
downloadllvm-3b709d5f5532bacb6c351def8c9bc7efef36fa33.tar.gz
llvm-3b709d5f5532bacb6c351def8c9bc7efef36fa33.tar.bz2
llvm-3b709d5f5532bacb6c351def8c9bc7efef36fa33.tar.xz
[docs] Add ReST version of all the man pages.
- The POD versions are slated for execution, but are still around until llvm.org machinery is in place. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@156384 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandGuide/index.rst')
-rw-r--r--docs/CommandGuide/index.rst53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/CommandGuide/index.rst b/docs/CommandGuide/index.rst
new file mode 100644
index 0000000000..73a4835dd7
--- /dev/null
+++ b/docs/CommandGuide/index.rst
@@ -0,0 +1,53 @@
+.. _commands:
+
+LLVM Command Guide
+------------------
+
+The following documents are command descriptions for all of the LLVM tools.
+These pages describe how to use the LLVM commands and what their options are.
+Note that these pages do not describe all of the options available for all
+tools. To get a complete listing, pass the ``--help`` (general options) or
+``--help-hidden`` (general and debugging options) arguments to the tool you are
+interested in.
+
+Basic Commands
+~~~~~~~~~~~~~~
+
+.. toctree::
+ :maxdepth: 1
+
+ llvm-as
+ llvm-dis
+ opt
+ llc
+ lli
+ llvm-link
+ llvm-ar
+ llvm-ranlib
+ llvm-nm
+ llvm-prof
+ llvm-config
+ llvm-diff
+ llvm-cov
+ llvm-stress
+
+Debugging Tools
+~~~~~~~~~~~~~~~
+
+.. toctree::
+ :maxdepth: 1
+
+ bugpoint
+ llvm-extract
+ llvm-bcanalyzer
+
+Developer Tools
+~~~~~~~~~~~~~~~
+
+.. toctree::
+ :maxdepth: 1
+
+ FileCheck
+ tblgen
+ lit
+ llvm-build