docs/CommandGuide/llvm-readobj.rst

   1 llvm-readobj - LLVM Object Reader
   2 =================================
   3
   4 SYNOPSIS
   5 --------
   6
   7 :program:`llvm-readobj` [*options*] [*input...*]
   8
   9 DESCRIPTION
  10 -----------
  11
  12 The :program:`llvm-readobj` tool displays low-level format-specific information
  13 about one or more object files. The tool and its output is primarily designed
  14 for use in FileCheck-based tests.
  15
  16 OPTIONS
  17 -------
  18
  19 If ``input`` is "``-``" or omitted, :program:`llvm-readobj` reads from standard
  20 input. Otherwise, it will read from the specified ``filenames``.
  21
  22 .. option:: -help
  23
  24  Print a summary of command line options.
  25
  26 .. option:: -version
  27
  28  Display the version of this program
  29
  30 .. option:: -file-headers, -h
  31
  32  Display file headers.
  33
  34 .. option:: -sections, -s
  35
  36  Display all sections.
  37
  38 .. option:: -section-data, -sd
  39
  40  When used with ``-sections``, display section data for each section shown.
  41
  42 .. option:: -section-relocations, -sr
  43
  44  When used with ``-sections``, display relocations for each section shown.
  45
  46 .. option:: -section-symbols, -st
  47
  48  When used with ``-sections``, display symbols for each section shown.
  49
  50 .. option:: -relocations, -r
  51
  52  Display the relocation entries in the file.
  53
  54 .. option:: -symbols, -t
  55
  56  Display the symbol table.
  57
  58 .. option:: -dyn-symbols
  59
  60  Display the dynamic symbol table (only for ELF object files).
  61
  62 .. option:: -unwind, -u
  63
  64  Display unwind information.
  65
  66 .. option:: -expand-relocs
  67
  68  When used with ``-relocations``, display each relocation in an expanded
  69  multi-line format.
  70
  71 .. option:: -dynamic-table
  72
  73  Display the ELF .dynamic section table (only for ELF object files).
  74
  75 .. option:: -needed-libs
  76
  77  Display the needed libraries (only for ELF object files).
  78
  79 .. option:: -program-headers
  80
  81  Display the ELF program headers (only for ELF object files).
  82
  83 .. option:: -elf-section-groups, -g
  84
  85  Display section groups (only for ELF object files).
  86
  87 EXIT STATUS
  88 -----------
  89
  90 :program:`llvm-readobj` returns 0.