llvm/docs/CommandGuide/llvm-readelf.md
Jordan Rupprecht 69f0756aa5 [docs] Add "GNU binutils Replacements" section to command guide
Summary:
This splits out a section in the command guide for llvm tools that can be used as replacements for GNU tools. For pages that didn't exist, I added stub pages that can be individually filled in by followup patches.

Tested by running `ninja docs-llvm-html` and inspecting locally.

Reviewers: jhenderson, MaskRay, grimar, alexshap

Reviewed By: jhenderson, MaskRay, grimar

Subscribers: smeenai, arphaman, llvm-commits

Tags: #llvm

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

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@363100 91177308-0d34-0410-b5e6-96231b3b80d8
2019-06-11 21:13:01 +00:00

29 lines
824 B
Markdown

# llvm-readelf - a drop-in replacement for readelf
## SYNOPSIS
**llvm-readelf** [*options*]
## DESCRIPTION
**llvm-readelf** is an alias for the [llvm-readobj](llvm-readobj.html) tool with
a command-line interface and output style more closely resembling GNU
**readelf**.
Here are some of those differences:
* Uses `--elf-output-style=GNU` by default.
* Allows single-letter grouped flags (e.g. `llvm-readelf -SW` is the same as
`llvm-readelf -S -W`).
* Allows use of `-s` as an alias for `--symbols` (versus `--section-headers` in
**llvm-readobj**) for GNU **readelf** compatibility.
* Prevents use of `-sr`, `-sd`, `-st` and `-dt` **llvm-readobj** aliases, to
avoid conflicting with standard GNU **readelf** grouped flags.
## SEE ALSO
Refer to [llvm-readobj](llvm-readobj.html) for additional information.