docs/CommandGuide/llvm-ranlib.rst

   1 llvm-ranlib - Generate index for LLVM archive
   2 =============================================
   3
   4
   5 SYNOPSIS
   6 --------
   7
   8
   9 **llvm-ranlib** [--version] [-help] <archive-file>
  10
  11
  12 DESCRIPTION
  13 -----------
  14
  15
  16 The **llvm-ranlib** command is similar to the common Unix utility, ``ranlib``. It
  17 adds or updates the symbol table in an LLVM archive file. Note that using the
  18 **llvm-ar** modifier *s* is usually more efficient than running **llvm-ranlib**
  19 which is only provided only for completness and compatibility. Unlike other
  20 implementations of ``ranlib``, **llvm-ranlib** indexes LLVM bitcode files, not
  21 native object modules. You can list the contents of the symbol table with the
  22 ``llvm-nm -s`` command.
  23
  24
  25 OPTIONS
  26 -------
  27
  28
  29
  30 *archive-file*
  31
  32  Specifies the archive-file to which the symbol table is added or updated.
  33
  34
  35
  36 *--version*
  37
  38  Print the version of **llvm-ranlib** and exit without building a symbol table.
  39
  40
  41
  42 *-help*
  43
  44  Print usage help for **llvm-ranlib** and exit without building a symbol table.
  45
  46
  47
  48
  49 EXIT STATUS
  50 -----------
  51
  52
  53 If **llvm-ranlib** succeeds, it will exit with 0.  If an error occurs, a non-zero
  54 exit code will be returned.
  55
  56
  57 SEE ALSO
  58 --------
  59
  60
  61 llvm-ar|llvm-ar, ranlib(1)