mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-23 19:23:23 +01:00
cb51100751
Follow-up to r371983. Referring to "this program" in the description of the --version option in the documentation isn't exactly correct, because the docs are not part of the program, and so "this program" doesn't really refer to anything. This patch brings the other users of this terminology into line with the new updates to llvm-size and llvm-strings. Reviewed by: alexshap, MaskRay Differential Revision: https://reviews.llvm.org/D67618 llvm-svn: 372107
172 lines
4.6 KiB
ReStructuredText
172 lines
4.6 KiB
ReStructuredText
llvm-strip - object stripping tool
|
|
==================================
|
|
|
|
.. program:: llvm-strip
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
:program:`llvm-strip` [*options*] *inputs...*
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
:program:`llvm-strip` is a tool to strip sections and symbols from object files.
|
|
If no other stripping or remove options are specified, :option:`--strip-all`
|
|
will be enabled by default.
|
|
|
|
The input files are modified in-place. If "-" is specified for the input file,
|
|
the input is read from the program's standard input stream.
|
|
|
|
If the input is an archive, any requested operations will be applied to each
|
|
archive member individually.
|
|
|
|
The tool is still in active development, but in most scenarios it works as a
|
|
drop-in replacement for GNU's :program:`strip`.
|
|
|
|
GENERIC AND CROSS-PLATFORM OPTIONS
|
|
----------------------------------
|
|
|
|
The following options are either agnostic of the file format, or apply to
|
|
multiple file formats.
|
|
|
|
.. option:: --disable-deterministic-archives, -U
|
|
|
|
Use real values for UIDs, GIDs and timestamps when updating archive member
|
|
headers.
|
|
|
|
.. option:: --discard-all, -x
|
|
|
|
Remove most local symbols from the output. Different file formats may limit
|
|
this to a subset of the local symbols. For example, file and section symbols in
|
|
ELF objects will not be discarded.
|
|
|
|
.. option:: --enable-deterministic-archives, -D
|
|
|
|
Enable deterministic mode when stripping archives, i.e. use 0 for archive member
|
|
header UIDs, GIDs and timestamp fields. On by default.
|
|
|
|
.. option:: --help, -h
|
|
|
|
Print a summary of command line options.
|
|
|
|
.. option:: --no-strip-all
|
|
|
|
Disable --strip-all.
|
|
|
|
.. option:: -o <file>
|
|
|
|
Write output to <file>. Multiple input files cannot be used in combination
|
|
with -o.
|
|
|
|
.. option:: --regex
|
|
|
|
If specified, symbol and section names specified by other switches are treated
|
|
as extended POSIX regular expression patterns.
|
|
|
|
.. option:: --remove-section <section>, -R
|
|
|
|
Remove the specified section from the output. Can be specified multiple times
|
|
to remove multiple sections simultaneously.
|
|
|
|
.. option:: --strip-all-gnu
|
|
|
|
Remove all symbols, debug sections and relocations from the output. This option
|
|
is equivalent to GNU :program:`strip`'s ``--strip-all`` switch.
|
|
|
|
.. option:: --strip-all, -S
|
|
|
|
For ELF objects, remove from the output all symbols and non-alloc sections not
|
|
within segments, except for .gnu.warning sections and the section name table.
|
|
|
|
For COFF objects, remove all symbols, debug sections, and relocations from the
|
|
output.
|
|
|
|
.. option:: --strip-debug, -g
|
|
|
|
Remove all debug sections.
|
|
|
|
.. option:: --strip-sections
|
|
|
|
Remove all section headers and all sections not in segments.
|
|
|
|
.. option:: --strip-symbol <symbol>, -N
|
|
|
|
Remove all symbols named ``<symbol>`` from the output. Can be specified
|
|
multiple times to remove multiple symbols.
|
|
|
|
.. option:: --strip-unneeded
|
|
|
|
Remove from the output all local or undefined symbols that are not required by
|
|
relocations. Also remove all debug sections.
|
|
|
|
.. option:: --version, -V
|
|
|
|
Display the version of the :program:`llvm-strip` executable.
|
|
|
|
.. option:: @<FILE>
|
|
|
|
Read command-line options and commands from response file `<FILE>`.
|
|
|
|
COFF-SPECIFIC OPTIONS
|
|
---------------------
|
|
|
|
The following options are implemented only for COFF objects. If used with other
|
|
objects, :program:`llvm-strip` will either emit an error or silently ignore
|
|
them.
|
|
|
|
.. option:: --only-keep-debug
|
|
|
|
Remove the contents of non-debug sections from the output, but keep the section
|
|
headers.
|
|
|
|
ELF-SPECIFIC OPTIONS
|
|
--------------------
|
|
|
|
The following options are implemented only for ELF objects. If used with other
|
|
objects, :program:`llvm-strip` will either emit an error or silently ignore
|
|
them.
|
|
|
|
.. option:: --allow-broken-links
|
|
|
|
Allow llvm-strip to remove sections even if it would leave invalid section
|
|
references. Any invalid sh_link fields will be set to zero.
|
|
|
|
.. option:: --discard-locals, -X
|
|
|
|
Remove local symbols starting with ".L" from the output.
|
|
|
|
.. option:: --keep-file-symbols
|
|
|
|
Keep symbols of type `STT_FILE`, even if they would otherwise be stripped.
|
|
|
|
.. option:: --keep-section <section>
|
|
|
|
When removing sections from the output, do not remove sections named
|
|
``<section>``. Can be specified multiple times to keep multiple sections.
|
|
|
|
.. option:: --keep-symbol <symbol>, -K
|
|
|
|
Do not remove symbols named ``<symbol>``. Can be specified multiple times to
|
|
keep multiple symbols.
|
|
|
|
.. option:: --preserve-dates, -p
|
|
|
|
Preserve access and modification timestamps.
|
|
|
|
EXIT STATUS
|
|
-----------
|
|
|
|
:program:`llvm-strip` exits with a non-zero exit code if there is an error.
|
|
Otherwise, it exits with code 0.
|
|
|
|
BUGS
|
|
----
|
|
|
|
To report bugs, please visit <http://llvm.org/bugs/>.
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
:manpage:`llvm-objcopy(1)`
|