llvm-mirror/docs/CommandGuide/llvm-readobj.rst
James Henderson 33503da181 [binutils] Add response file option to help and docs
Many LLVM-based tools already support response files (i.e. files
containing a list of options, specified with '@'). This change simply
updates the documentation and help text for some of these tools to
include it. I haven't attempted to fix all tools, just a selection that
I am interested in.

I've taken the opportunity to add some tests for --help behaviour, where
they were missing. We could expand these tests, but I don't think that's
within scope of this patch.

This fixes https://bugs.llvm.org/show_bug.cgi?id=42233 and
https://bugs.llvm.org/show_bug.cgi?id=42236.

Reviewed by: grimar, MaskRay, jkorous

Differential Revision: https://reviews.llvm.org/D63597

llvm-svn: 364036
2019-06-21 11:49:20 +00:00

99 lines
2.0 KiB
ReStructuredText

llvm-readobj - LLVM Object Reader
=================================
SYNOPSIS
--------
:program:`llvm-readobj` [*options*] [*input...*]
DESCRIPTION
-----------
The :program:`llvm-readobj` tool displays low-level format-specific information
about one or more object files. The tool and its output is primarily designed
for use in FileCheck-based tests.
OPTIONS
-------
If ``input`` is "``-``" or omitted, :program:`llvm-readobj` reads from standard
input. Otherwise, it will read from the specified ``filenames``.
.. option:: -help
Print a summary of command line options.
.. option:: -version
Display the version of this program
.. option:: -file-headers, -h
Display file headers.
.. option:: -sections, -s
Display all sections.
.. option:: -section-data, -sd
When used with ``-sections``, display section data for each section shown.
.. option:: -section-relocations, -sr
When used with ``-sections``, display relocations for each section shown.
.. option:: -section-symbols, -st
When used with ``-sections``, display symbols for each section shown.
.. option:: -relocations, -r
Display the relocation entries in the file.
.. option:: -symbols, -t
Display the symbol table.
.. option:: -dyn-symbols
Display the dynamic symbol table (only for ELF object files).
.. option:: -unwind, -u
Display unwind information.
.. option:: -expand-relocs
When used with ``-relocations``, display each relocation in an expanded
multi-line format.
.. option:: -dynamic-table
Display the ELF .dynamic section table (only for ELF object files).
.. option:: -needed-libs
Display the needed libraries (only for ELF object files).
.. option:: -program-headers
Display the ELF program headers (only for ELF object files).
.. option:: -elf-section-groups, -g
Display section groups (only for ELF object files).
.. option:: -demangle, -C
Print demangled symbol names in the output.
.. option:: @<FILE>
Read command-line options from response file `<FILE>`.
EXIT STATUS
-----------
:program:`llvm-readobj` returns 0.