Differential D18309 Diff 51005 usr.bin/clang/llvm-objdump/llvm-objdump.1

Changeset View

Standalone View

usr.bin/clang/llvm-objdump/llvm-objdump.1

This file was added.

				.\" This file is distributed under the University of Illinois Open Source
				.\" License. See LICENSE.TXT for details.
				.\"
				.Dd November 23, 2018
				.Dt LLVM-OBJDUMP 1
				.Os
				.Sh NAME
				.Nm llvm-objdump
				.Nd LLVM object file dumper
				.Sh SYNOPSIS
				.Nm llvm-objdump
				yuripvUnsubmitted Not Done Inline Actions Just IMO: listing all the long options in the synopsis section makes it unreadable (see diff(1), for example); if there are no short ones, just say `llvm-objdump [OPTIONS] objfile ...` like some of gnu utilities do (yeah, I know...), e.g., gnugrep(1). yuripv: Just IMO: listing all the long options in the synopsis section makes it unreadable (see diff(1)…
				emasteAuthorUnsubmitted Done Inline Actions There are a mix of long and short options, some short ones not documented. I had this discussion with Ingo Schwarze about the ld.lld.1 man page as well; he does not like eliminating the options in the synopsis, but also does not like long options at all. I think you're right that the giant collection of long options is not that helpful, although note that GNU objdump does list all of its options in the synopsis. emaste: There are a mix of long and short options, some short ones not documented. I had this…
				.Op Fl -aarch64-neon-syntax Ns = Ns Ar value
				.Op Fl -arch Ns = Ns Ar value
				.Op Fl -archive-headers
				.Op Fl -archive-member-offsets
				.Op Fl -bind
				.Op Fl -color
				.Op Fl -data-in-code
				.Op Fl -dis-symname Ns = Ns Ar symbol
				.Op Fl -disassemble
				.Op Fl -disassemble-all
				.Op Fl -dsym Ns = Ns Ar file
				.Op Fl -dwarf Ns = Ns Ar sections
				.Op Fl -dylib-id
				.Op Fl -dylibs-used
				.Op Fl -exports-trie
				.Op Fl -fault-map-section
				.Op Fl -filter-print-funcs Ns = Ns Ar functions
				.Op Fl -full-leading-addr
				.Op Fl g
				.Op Fl h , -headers , -section-headers
				.Op Fl -help
				.Op Fl -indirect-symbols
				.Op Fl -info-plist
				.Op Fl -lazy-bind
				.Op Fl -line-numbers
				.Op Fl -link-opt-hints
				.Op Fl -macho
				.Op Fl -mattr Ns = Ns Ar attribute ...
				.Op Fl -mcpu Ns = Ns Ar CPU
				.Op Fl -no-leading-addr
				.Op Fl -no-leading-headers
				.Op Fl -no-show-raw-insn
				.Op Fl -no-symbolic-operands
				.Op Fl -non-verbose
				.Op Fl -objc-meta-data
				.Op Fl -print-after-all
				.Op Fl -print-before-all
				.Op Fl -print-imm-hex
				.Op Fl -private-header
				.Op Fl -private-headers
				.Op Fl r
				.Op Fl -raw-clang-ast
				.Op Fl -rebase
				.Op Fl -reverse-iterate
				.Op Fl -rng-seed Ns = Ns Ar seed
				.Op Fl s
				.Op Fl -section Ns = Ns Ar section
				.Op Fl -source
				.Op Fl -start-address Ns = Ns Ar address
				.Op Fl -stats
				.Op Fl -stats-json
				.Op Fl -stop-address Ns = Ns Ar address
				.Op Fl t
				.Op Fl -time-passes
				.Op Fl -triple Ns = Ns Ar triple
				.Op Fl -universal-headers
				.Op Fl -unwind-info
				.Op Fl -verify-debug-info
				.Op Fl -verify-dom-info
				.Op Fl -version
				.Op Fl -weak-bind
				.Op Fl -x86-asm-syntax Ns = Ns Ar syntax
				.Ar objfile ...
				.Sh DESCRIPTION
				.Nm
				prints the contents of object files and final linked images named on the
				command line.
				If no file name is specified,
				.Nm
				will attempt to read from
				.Pa a.out .
				If
				.Pa -
				is used as a file name,
				.Nm
				will process a file on its standard input stream.
				.Nm
				accepts many of the same command line arguments as GNU objdump.
				.Sh OPTIONS
				.Bl -tag -width indent
				.It Fl -aarch64-neon-syntax Ns = Ns Ar value
				Choose style of NEON code to emit from AArch64 backend.
				.Ar value
				may be one of:
				.Bl -tag -width indent
				.It generic
				Generic NEON assembly
				.It apple
				Apple-style NEON assembly
				.El
				.It Fl -arch Ns = Ns Ar value
				Choose architecture(s) from a Mach-O file to dump
				.It Fl -arch-name Ns = Ns ar arch
				Target arch to disassemble for.
				See
				.Fl -version
				for available targets.
				.It Fl -archive-headers
				Print archive headers for Mach-O archives.
				Requires
				.Fl -macho .
				.It Fl -archive-member-offsets
				Print the offset to each archive member for Mach-O archives.
				Requires
				.Fl -macho
				and
				.Fl -archive-headers.
				.It Fl -bind
				Display mach-o binding info.
				.It Fl -color
				Use colored syntax highlighting.
				Default autodetect.
				.It Fl -data-in-code
				Print the data in code table for Mach-O objects.
				Requires
				.Fl -macho .
				.It Fl -dis-symname Ns = Ns Ar symbol
				Disassemble just
				.Ar symbol 's
				instructions.
				Requires
				.Fl -macho .
				.It Fl -disassemble
				Display assembler mnemonics for machine instructions.
				.It Fl -disassemble-all
				Display assembler mnemonics for the machine instruction in all sections.
				.It Fl -dsym Ns = Ns Ar file
				Use
				.Ar file
				for debug info.
				.It Fl -dwarf Ns = Ns Ar sections
				Dump of dwarf debug sections.
				.Bl -tag -width indent
				.It frames
				.Dv .debug_frame
				.El
				.It Fl -dylib-id
				Print the shared library's id for the dylib Mach-O file.
				Requires
				.Fl -macho .
				bcrUnsubmitted Not Done Inline Actions Line break after the sentence stop. bcr: Line break after the sentence stop.
				.It Fl -dylibs-used
				Print the shared libraries used for linked Mach-O files.
				Requires
				.Fl -macho .
				.It Fl -exports-trie
				Display mach-o exported symbols.
				.It Fl -fault-map-section
				Display contents of faultmap section.
				.It Fl -filter-print-funcs Ns = Ns Ar functions
				Only print IR for functions whose name match
				.Ar functions
				for all print-[before\|after][-all] options.
				.It Fl -full-leading-addr
				Print full leading address.
				.It Fl g
				Print line information from debug info if available.
				.It Fl h , -headers , -section-headers
				Display summaries of the headers for each section.
				.It Fl -help
				Display available options.
				Use
				.Fl -help-hidden
				for more.
				.It Fl -indirect-symbols
				Print indirect symbol table for Mach-O objects.
				Requires
				.Fl -macho .
				.It Fl -info-plist
				Print the info plist section as strings for Mach-O objects.
				Requires
				.Fl -macho .
				.It Fl -lazy-bind
				Display mach-o lazy binding info.
				.It Fl -line-numbers
				Display source line numbers with disassembly. Implies disassemble object.
				.It Fl -link-opt-hints
				Print the linker optimization hints for Mach-O objects.
				Requires
				.Fl -macho .
				.It Fl -macho
				Use MachO specific object file parser.
				.It Fl -mattr Ns = Ns Ar attribute ...
				Target specific attributes.
				.It Fl -mcpu Ns = Ns Ar CPU
				Target a specific cpu type.
				Use
				.Fl mcpu Ns = Ns help
				for details.
				.It Fl -no-leading-addr
				Print no leading address.
				.It Fl -no-leading-headers
				Print no leading headers.
				.It Fl -no-show-raw-insn
				When disassembling instructions, do not print the instruction bytes.
				.It Fl -no-symbolic-operands
				do not symbolic operands when disassembling.
				Requires
				.Fl -macho .
				.It Fl -non-verbose
				Print the info for Mach-O objects in non-verbose or numeric form.
				Requires
				.Fl -macho .
				.It Fl -objc-meta-data
				Print the Objective-C runtime meta data for Mach-O files.
				Requires
				.Fl -macho .
				.It Fl -print-after-all
				Print IR after each pass.
				.It Fl -print-before-all
				Print IR before each pass.
				.It Fl -print-imm-hex
				Use hex format for immediate values.
				.It Fl -private-header
				Display only the first format specific file header.
				.It Fl -private-headers
				Display format specific file headers.
				.It Fl r
				Display the relocation entries in the file.
				.It Fl -raw-clang-ast
				Dump the raw binary contents of the clang AST section.
				.It Fl -rebase
				Display mach-o rebasing info.
				.It Fl -reverse-iterate
				Reverse iterate.
				.It Fl -rng-seed Ns = Ns Ar seed
				Seed for the random number generator.
				.It Fl s
				Display the content of each section.
				.It Fl -section Ns = Ns Ar section
				Operate on the specified sections only.
				With
				.Fl -macho
				dump segment,section.
				.It Fl -source
				Display source inline with disassembly.
				Implies disassmble object.
				.It Fl -start-address Ns = Ns Ar address
				Disassemble beginning at
				.Ar address .
				.It Fl -stats
				Enable statistics output from program.
				Available with Asserts builds.
				.It Fl -stats-json
				Display statistics as json data.
				.It Fl -stop-address Ns = Ns Ar address
				Stop disassembly at
				.Ar address .
				.It Fl t
				Display the symbol table.
				.It Fl -time-passes
				Time each pass, printing elapsed time for each on exit
				.It Fl -triple Ns = Ns Ar triple
				Target triple to disassemble for.
				See
				.Fl -version
				for available targets.
				.It Fl -universal-headers
				Print Mach-O universal headers.
				Requires
				.Fl -macho .
				.It Fl -unwind-info
				Display unwind information.
				.It Fl -verify-debug-info
				Verify debug info.
				.It Fl -verify-dom-info
				Verify dominator info (time consuming).
				.It Fl -version
				Display the version of this program.
				.It Fl -weak-bind
				Display mach-o weak binding info.
				.It Fl -x86-asm-syntax Ns = Ns Ar syntax
				Choose style of code to emit from X86 backend.
				.Bl -tag -width indent
				.It att
				Emit AT&T-style assembly.
				.It intel
				Emit Intel-style assembly.
				.El
				.El