Blame doc/elfclassify.1

Packit Service 97d2fb
.\" Copyright 2019 Red Hat Inc.
Packit Service 97d2fb
.\" Tue 2019-Aug 20 Ben Woodard <woodard@redhat.com>
Packit Service 97d2fb
.\"                 Florian Wiemer <fwiemer@redhat.com>
Packit Service 97d2fb
.\"                 Mark Wielaard <mjw@redhat.com>
Packit Service 97d2fb
.\" Contact elfutils-devel@sourceware.org to correct errors or typos.
Packit Service 97d2fb
.TH EU-ELFCLASSIFY 1 "2019-Aug-20" "elfutils" 
Packit Service 97d2fb
.SH "NAME"
Packit Service 97d2fb
eu-elfclassify \- Determine the type of an ELF file.
Packit Service 97d2fb
.SH "SYNOPSIS"
Packit Service 97d2fb
.IX Header "SYNOPSIS"
Packit Service 97d2fb
eu-elfclassify [\fB\-\-core\fR]
Packit Service 97d2fb
        [\fB\-\-debug-only\fR]
Packit Service 97d2fb
        [\fB\-\-elf\fR]
Packit Service 97d2fb
        [\fB\-\-elf\-archive\fR]
Packit Service 97d2fb
        [\fB\-\-elf\-file\fR]
Packit Service 97d2fb
        [\fB\-\-executable\fR]
Packit Service 97d2fb
        [\fB\-\-library\fR]
Packit Service 97d2fb
        [\fB\-\-linux\-kernel\-module\fR]
Packit Service 97d2fb
        [\fB\-\-loadable\fR]
Packit Service 97d2fb
        [\fB\-\-program\fR]
Packit Service 97d2fb
        [\fB\-\-shared\fR]
Packit Service 97d2fb
        [\fB\-\-unstripped\fR]
Packit Service 97d2fb
        [\fB\-f\fR|\fB \-\-file\fR]
Packit Service 97d2fb
        [\fB\-\-no\-stdin\fR]
Packit Service 97d2fb
        [\fB\-\-stdin\fR]
Packit Service 97d2fb
        [\fB\-\-stdin0\fR]
Packit Service 97d2fb
        [\fB\-z\fR|\fB \-\-compressed\fR]
Packit Service 97d2fb
        [\fB\-\-matching\fR]
Packit Service 97d2fb
        [\fB\-\-no\-print\fR]
Packit Service 97d2fb
        [\fB\-\-not\-matching\fR]
Packit Service 97d2fb
        [\fB\-\-print\fR]
Packit Service 97d2fb
        [\fB\-\-print0\fR]
Packit Service 97d2fb
        [\fB\-q\fR|\fB \-\-quiet\fR]
Packit Service 97d2fb
        [\fB\-v\fR|\fB \-\-verbose\fR]
Packit Service 97d2fb
        [\fB\-?\fR|\fB \-\-help\fR]
Packit Service 97d2fb
        [\fB\-\-usage\fR]
Packit Service 97d2fb
        [\fB\-V\fR|\fB \-\-version\fR]
Packit Service 97d2fb
	\fIelffile\fR...
Packit Service 97d2fb
.SH "DESCRIPTION"
Packit Service 97d2fb
.IX Header "DESCRIPTION"
Packit Service 97d2fb
\&\fBeu-elfclassify\fR identifies the primary purpose of a particular kind of
Packit Service 97d2fb
 \s-1ELF\s0 file or files
Packit Service 97d2fb
.SH "OPTIONS"
Packit Service 97d2fb
.IX Header "OPTIONS"
Packit Service 97d2fb
The long and short forms of options, shown here as alternatives, are
Packit Service 97d2fb
equivalent. All of the classification options must apply at the same time to a
Packit Service 97d2fb
particular file.  Classification options can be negated using a
Packit Service 97d2fb
\fB\-\-not\-\fR  prefix.
Packit Service 97d2fb
.SS "Classification Options"
Packit Service 97d2fb
.IX Subsection "Classification Options"
Packit Service 97d2fb
.IP "\fB\-\-core\fR" 4
Packit Service 97d2fb
.IX Item "--core"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File is an ELF core dump file.
Packit Service 97d2fb
.IP "\FB\-\-debug\-only\fR" 4
Packit Service 97d2fb
.IX Item "--debug-only"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File is a debug only ELF file (separate .debug, .dwo or dwz multi-file).
Packit Service 97d2fb
.IP "\fB\-\-elf\fR" 4
Packit Service 97d2fb
.IX Item "--elf"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File looks like an ELF object or archive/static library (default).
Packit Service 97d2fb
.IP "\fB\-\-elf\-archive\fR" 4
Packit Service 97d2fb
.IX Item "--elf-archive"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File is an ELF archive or static library.
Packit Service 97d2fb
.IP "\fB\-\-elf\-file\fR" 4
Packit Service 97d2fb
.IX Item "--elf-file"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File is an regular ELF object (not an archive/static library).
Packit Service 97d2fb
.IP "\fB\-\-executable\fR" 4
Packit Service 97d2fb
.IX Item "--executable"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File is (primarily) an ELF program executable (not primarily a DS.O)
Packit Service 97d2fb
.IP "\fB\-\-library\fR" 4
Packit Service 97d2fb
.IX Item "--library"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File is an ELF shared object (DSO) (might also be an executable).
Packit Service 97d2fb
.IP "\fB\-\-linux\-kernel\-module\fR" 4
Packit Service 97d2fb
.IX Item "--linux-kernel-module"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File is a linux kernel module.
Packit Service 97d2fb
.IP "\fB\-\-loadable\fR" 4
Packit Service 97d2fb
.IX Item "--loadable"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File is a loadable ELF object (program or shared object).
Packit Service 97d2fb
.IP "\fB\--program\fR" 4
Packit Service 97d2fb
.IX Item "--program"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File is an ELF program executable (might also be a DSO).
Packit Service 97d2fb
.IP "\fB\-\-shared\fR" 4
Packit Service 97d2fb
.IX Item "--shared"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File is (primarily) an ELF shared object (DSO) (not primarily an executable).
Packit Service 97d2fb
.IP "\fB\-\-unstripped\fR" 4
Packit Service 97d2fb
.IX Item "--unstripped"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
File is an ELF file with symbol table or .debug_* sections and can be stripped
Packit Service 97d2fb
further.
Packit Service 97d2fb
.SS "Input flags"
Packit Service 97d2fb
.IX Subsection "Input flags"
Packit Service 97d2fb
.IP "\fB\-f\fR" 4
Packit Service 97d2fb
.IX Item "-f"
Packit Service 97d2fb
.PD 0
Packit Service 97d2fb
.IP "\fB\-\-file\fR" 4
Packit Service 97d2fb
.IX Item "--file"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Only classify regular (not symlink nor special device) files.
Packit Service 97d2fb
.IP "\fB\-\-no\-stdin\fR" 4
Packit Service 97d2fb
.IX Item "--no-stdin"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Do not read files from standard input (default).
Packit Service 97d2fb
.IP "\fB\-\-stdin\fR" 4
Packit Service 97d2fb
.IX Item "--stdin"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Also read file names to process from standard input, separated by newlines.
Packit Service 97d2fb
.IP "\fB\-\-stdin0\fR" 4
Packit Service 97d2fb
.IX Item "--stdin0"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Also read file names to process from standard input, separated by ASCII NUL
Packit Service 97d2fb
bytes.
Packit Service 97d2fb
.IP "\fB\-z\fR" 4
Packit Service 97d2fb
.IX Item "-z"
Packit Service 97d2fb
.PD 0
Packit Service 97d2fb
.IP "\fB\-\-compressed\fR" 4
Packit Service 97d2fb
.IX Item "--compressed"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Try to open compressed files or embedded (kernel) ELF images.
Packit Service 97d2fb
.SS "Output flags"
Packit Service 97d2fb
.IX Subsection "Output flags"
Packit Service 97d2fb
.IP "\fB\-\-matching\fR" 4
Packit Service 97d2fb
.IX Item "--matching"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
If printing file names, print matching files (default).
Packit Service 97d2fb
.IP "\fB\-\-no\-print\fR" 4
Packit Service 97d2fb
.IX Item "--no-print"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Do not output file names.
Packit Service 97d2fb
.IP "\fB\-\-not\-matching\fR" 4
Packit Service 97d2fb
.IX Item "--not-matching"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
If printing file names, print files that do not match.
Packit Service 97d2fb
.IP "\fB\-\-print\fR" 4
Packit Service 97d2fb
.IX Item "--print"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Output names of files, separated by newline.
Packit Service 97d2fb
.IP "\fB\-\-print0\fR" 4
Packit Service 97d2fb
.IX Item "--print0"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Output names of files, separated by ASCII NUL.
Packit Service 97d2fb
.SS " Additional flags"
Packit Service 97d2fb
.IX Subsection " Additional flags"
Packit Service 97d2fb
.IP "\fB\-q\fR" 4
Packit Service 97d2fb
.IX Item "-q,"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
.IP "\fB\-\-quiet\fR" 4
Packit Service 97d2fb
.IX Item "--quiet"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Suppress some error output (counterpart to --verbose).
Packit Service 97d2fb
.IP "\fB\-v\fR" 4
Packit Service 97d2fb
.IX Item "-v"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
.IP "\fB\-\-verbose\fR" 4
Packit Service 97d2fb
.IX Item "--verbose"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Output additional information (can be specified multiple times).
Packit Service 97d2fb
.IP "\fB\-?\fR" 4
Packit Service 97d2fb
.IX Item "-?"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
.IP "\fB\-\-help\fR" 4
Packit Service 97d2fb
.IX Item "--help"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Give this help list.
Packit Service 97d2fb
.IP "\fB\-\-usage\fR" 4
Packit Service 97d2fb
.IX Item "--usage"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Give a short usage message.
Packit Service 97d2fb
.IP "\fB\-V\fR" 4
Packit Service 97d2fb
.IX Item "-V"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
.IP "\fB\-\-version\fR" 4
Packit Service 97d2fb
.IX Item "--version"
Packit Service 97d2fb
.PD
Packit Service 97d2fb
Print program version.
Packit Service 97d2fb
Packit Service 97d2fb
.SH "AUTHOR"
Packit Service 97d2fb
.IX Header "AUTHOR"
Packit Service 97d2fb
Written by Florian Wiemer.
Packit Service 97d2fb
.SH "REPORTING BUGS"
Packit Service 97d2fb
.IX Header "REPORTING BUGS"
Packit Service 97d2fb
Please reports bugs at https://sourceware.org/bugzilla/
Packit Service 97d2fb
.SH "COPYRIGHT"
Packit Service 97d2fb
.IX Header "COPYRIGHT"
Packit Service 97d2fb
Copyright © 2019 Red Hat Inc.  License GPLv3+: GNU GPL version 3 or
Packit Service 97d2fb
later <https://gnu.org/licenses/gpl.html>.  This is free software: you
Packit Service 97d2fb
are free to change and redistribute it.  There is NO WARRANTY, to the
Packit Service 97d2fb
extent permitted by law.