aboutsummaryrefslogtreecommitdiffstats
path: root/docs/CommandGuide/llvm-ranlib.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/llvm-ranlib.rst
parentf647c1b7776f34125441f6edeb449be63b470dd7 (diff)
downloadexternal_llvm-3b709d5f5532bacb6c351def8c9bc7efef36fa33.zip
external_llvm-3b709d5f5532bacb6c351def8c9bc7efef36fa33.tar.gz
external_llvm-3b709d5f5532bacb6c351def8c9bc7efef36fa33.tar.bz2
[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/llvm-ranlib.rst')
-rw-r--r--docs/CommandGuide/llvm-ranlib.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/CommandGuide/llvm-ranlib.rst b/docs/CommandGuide/llvm-ranlib.rst
new file mode 100644
index 0000000..6658818
--- /dev/null
+++ b/docs/CommandGuide/llvm-ranlib.rst
@@ -0,0 +1,61 @@
+llvm-ranlib - Generate index for LLVM archive
+=============================================
+
+
+SYNOPSIS
+--------
+
+
+**llvm-ranlib** [--version] [-help] <archive-file>
+
+
+DESCRIPTION
+-----------
+
+
+The **llvm-ranlib** command is similar to the common Unix utility, ``ranlib``. It
+adds or updates the symbol table in an LLVM archive file. Note that using the
+**llvm-ar** modifier *s* is usually more efficient than running **llvm-ranlib**
+which is only provided only for completness and compatibility. Unlike other
+implementations of ``ranlib``, **llvm-ranlib** indexes LLVM bitcode files, not
+native object modules. You can list the contents of the symbol table with the
+``llvm-nm -s`` command.
+
+
+OPTIONS
+-------
+
+
+
+*archive-file*
+
+ Specifies the archive-file to which the symbol table is added or updated.
+
+
+
+*--version*
+
+ Print the version of **llvm-ranlib** and exit without building a symbol table.
+
+
+
+*-help*
+
+ Print usage help for **llvm-ranlib** and exit without building a symbol table.
+
+
+
+
+EXIT STATUS
+-----------
+
+
+If **llvm-ranlib** succeeds, it will exit with 0. If an error occurs, a non-zero
+exit code will be returned.
+
+
+SEE ALSO
+--------
+
+
+llvm-ar|llvm-ar, ranlib(1)