X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FREADME.txt;h=3d634292980832537c98cae7115b038c2ccd1de2;hb=e23e5700bb14e7bfc3b00e0a958b067b1a1f719c;hp=fcc1badaf6964368738df5611594d609f934200b;hpb=ccb8019fba57020198f829ce8183878e6e0dcfc8;p=oota-llvm.git

diff --git a/docs/README.txt b/docs/README.txt
index fcc1badaf69..3d634292980 100644
--- a/docs/README.txt
+++ b/docs/README.txt
@@ -4,9 +4,9 @@ LLVM Documentation
 LLVM's documentation is written in reStructuredText, a lightweight
 plaintext markup language (file extension `.rst`). While the
 reStructuredText documentation should be quite readable in source form, it
-is meant to be processed by the Sphinx documentation generation system to
-create HTML pages which are hosted on <http://llvm.org/docs/> and updated
-after every commit.
+is mostly meant to be processed by the Sphinx documentation generation
+system to create HTML pages which are hosted on <http://llvm.org/docs/> and
+updated after every commit. Manpage output is also supported, see below.
 
 If you instead would like to generate and view the HTML locally, install
 Sphinx <http://sphinx-doc.org/> and then do:
@@ -22,3 +22,30 @@ If you are interested in writing new documentation, you will want to read
 `SphinxQuickstartTemplate.rst` which will get you writing documentation
 very fast and includes examples of the most important reStructuredText
 markup syntax.
+
+Manpage Output
+===============
+
+Building the manpages is similar to building the HTML documentation. The
+primary difference is to use the `man` makefile target, instead of the
+default (which is `html`). Sphinx then produces the man pages in the
+directory `_build/man/`.
+
+    cd docs/
+    make -f Makefile.sphinx man
+    man -l _build/man/FileCheck.1
+
+The correspondence between .rst files and man pages is
+`docs/CommandGuide/Foo.rst` <-> `_build/man/Foo.1`.
+These .rst files are also included during HTML generation so they are also
+viewable online (as noted above) at e.g.
+`http://llvm.org/docs/CommandGuide/Foo.html`.
+
+Checking links
+==============
+
+The reachibility of external links in the documentation can be checked by
+running:
+
+    cd docs/
+    make -f Makefile.sphinx linkcheck