From 1f72cab137911908c0077f7abad4ca9a57e608b0 Mon Sep 17 00:00:00 2001 From: David MacKenzie Date: Thu, 29 Apr 1993 18:15:00 +0000 Subject: [PATCH] Document missing options. Use -- instead of + for long options. --- binutils/ar.1 | 9 +++++-- binutils/nm.1 | 42 ++++++++++++++++---------------- binutils/objdump.1 | 30 +++++++++++------------ binutils/size.1 | 40 +++++++++++++++---------------- binutils/strip.1 | 60 +++++++++++++++++++++++++++++++++++++++++----- 5 files changed, 117 insertions(+), 64 deletions(-) diff --git a/binutils/ar.1 b/binutils/ar.1 index 1e19390846b..3d03690f7eb 100644 --- a/binutils/ar.1 +++ b/binutils/ar.1 @@ -14,7 +14,7 @@ ar\(em\&create, modify, and extract from archives. .hy 0 .na .BR ar " [\|" "-" "\|]"\c -.I pmod \c +.I {dmpqrtx}[abcilosuvV] \c [\|\c .I membername\c \&\|] \c @@ -79,7 +79,7 @@ their placement in the archive. You may use `\|\c .B nm \-s\c \|' or `\|\c -.B nm +print-armap\c +.B nm \-\-print\-armap\c \|' to list this index table. If an archive lacks the table, another form of \c .B ar\c @@ -435,6 +435,11 @@ when the modifier `\|\c .B v\c \|' is appended. +.TP +.B V +This modifier shows the version number of +.BR ar . + .PP .SH "SEE ALSO" diff --git a/binutils/nm.1 b/binutils/nm.1 index 3bdea9bb6f6..26ed5a0f900 100644 --- a/binutils/nm.1 +++ b/binutils/nm.1 @@ -15,19 +15,19 @@ nm\(em\&list symbols from object files. .na .TP .B nm -.RB "[\|" \-a | +debug-syms "\|]" -.RB "[\|" \-g | +extern-only "\|]" -.RB "[\|" \-s | +print-armap "\|]" -.RB "[\|" \-o | +print-file-name "\|]" -.RB "[\|" \-n | +numeric-sort "\|]" -.RB "[\|" \-p | +no-sort "\|]" -.RB "[\|" \-r | +reverse-sort "\|]" -.RB "[\|" \-u | +undefined-only "\|]" -.RB "[\|" "+target\ "\c +.RB "[\|" \-a | \-\-debug\-syms "\|]" +.RB "[\|" \-g | \-\-extern\-only "\|]" +.RB "[\|" \-s | \-\-print\-armap "\|]" +.RB "[\|" \-o | \-\-print\-file\-name "\|]" +.RB "[\|" \-n | \-\-numeric\-sort "\|]" +.RB "[\|" \-p | \-\-no\-sort "\|]" +.RB "[\|" \-r | \-\-reverse\-sort "\|]" +.RB "[\|" \-u | \-\-undefined\-only "\|]" +.RB "[\|" "\-\-target="\c .I bfdname\c \&\|] .RB "[\|" \c -.I objfiles\c +.I objfile\c \&.\|.\|.\|] .ad b .hy 1 @@ -35,7 +35,7 @@ nm\(em\&list symbols from object files. GNU \c .B nm\c \& will list the symbols from object files \c -.I objfiles\c +.I objfile\c \&. .SH OPTIONS @@ -43,7 +43,7 @@ The long and short forms of options, shown here as alternatives, are equivalent. .TP -.IR "objfiles" .\|.\|. +.IR "objfile" .\|.\|. Object files whose symbols are to be listed. If no object files are listed as arguments, \c .B nm\c @@ -54,33 +54,33 @@ listed as arguments, \c .TP .B \-a .TP -.B +debug-syms +.B \-\-debug\-syms Display debugger-only symbols; normally these are not listed. .TP .B \-g .TP -.B +extern-only +.B \-\-extern\-only Display only external symbols. .TP .B \-p .TP -.B +no-sort +.B \-\-no\-sort Don't bother to sort the symbols in any order; just print them in the order encountered. .TP .B \-n .TP -.B +numeric-sort +.B \-\-numeric\-sort Sort symbols numerically by their addresses, not alphabetically by their names. .TP .B \-s .TP -.B +print-armap +.B \-\-print\-armap When listing symbols from archive members, include the index: a mapping (stored in the archive by \c .B ar\c @@ -92,7 +92,7 @@ contain definitions for what names. .TP .B \-o .TP -.B +print-file-name +.B \-\-print\-file\-name Precede each symbol by the name of the input file where it was found, rather than identifying the input file once only before all of its symbols. @@ -100,12 +100,12 @@ symbols. .TP .B \-r .TP -.B +reverse-sort +.B \-\-reverse\-sort Reverse the sense of the sort (whether numeric or alphabetic); let the last come first. .TP -.BI "+target " "bfdname"\c +.BI "\-\-target " "bfdname"\c \& Specify an object code format other than your system's default format. See @@ -115,7 +115,7 @@ for information on listing available formats. .TP .B \-u .TP -.B +undefined-only +.B \-\-undefined\-only Display only undefined symbols (those external to each object file). .PP diff --git a/binutils/objdump.1 b/binutils/objdump.1 index b26fb7cb027..c7c4f0a6fd6 100644 --- a/binutils/objdump.1 +++ b/binutils/objdump.1 @@ -21,7 +21,7 @@ objdump\(em\&display information from object files. \&\|] .RB "[\|" \-d "\|]" .RB "[\|" \-f "\|]" -.RB "[\|" \-h | --header "\|]" +.RB "[\|" \-h | \-\-header "\|]" .RB "[\|" \-i "\|]" .RB "[\|" "\-j\ "\c .I section\c @@ -30,12 +30,12 @@ objdump\(em\&display information from object files. .RB "[\|" "\-m\ "\c .I machine\c \&\|] -.RB "[\|" \-r | --reloc "\|]" +.RB "[\|" \-r | \-\-reloc "\|]" .RB "[\|" \-s "\|]" -.RB "[\|" \--stabs "\|]" -.RB "[\|" \-t | --syms "\|]" +.RB "[\|" \-\-stabs "\|]" +.RB "[\|" \-t | \-\-syms "\|]" .RB "[\|" \-x "\|]" -.I objfiles\c +.I objfile\c \&.\|.\|. .ad b .hy 1 @@ -52,7 +52,7 @@ Where long and short forms of an option are shown together, they are equivalent. .TP -.IR "objfiles" .\|.\|. +.IR "objfile" .\|.\|. The object files to be examined. When you specify archives, \c .B objdump\c @@ -61,7 +61,7 @@ The object files to be examined. When you specify archives, .TP .B \-a If any files from \c -.I objfiles\c +.I objfile\c \& are archives, display the archive header information (in a format similar to `\|\c .B ls \-l\c @@ -106,20 +106,20 @@ formats available with the `\|\c .B \-d Disassemble. Display the assembler mnemonics for the machine instructions from \c -.I objfiles\c +.I objfile\c \&. .TP .B \-f File header. Display summary information from the overall header of each file in \c -.I objfiles\c +.I objfile\c \&. .TP .B \-h .TP -.B --header +.B \-\-header Header. Display summary information from the section headers of the object file. @@ -148,7 +148,7 @@ and line numbers corresponding to the object code shown. .BI "-m " "machine"\c \& Specify the object files \c -.I objfiles\c +.I objfile\c \& are for architecture \c .I machine\c @@ -160,7 +160,7 @@ option. .TP .B \-r .TP -.B --reloc +.B \-\-reloc Relocation. Print the relocation entries of the file. .TP @@ -168,18 +168,18 @@ Relocation. Print the relocation entries of the file. Display the full contents of any sections requested. .TP -.B \--stabs +.B \-\-stabs Display the contents of the .stab, .stab.index, and .stab.excl sections from an ELF file. This is only useful on systems (such as Solaris 2.0) in which .stab debugging symbol-table entries are carried in an ELF section. In most other file formats, debugging symbol-table entries are interleaved with linkage symbols, and are visible in the ---syms output. +\-\-syms output. .TP .B \-t .TP -.B --syms +.B \-\-syms Symbol Table. Print the symbol table entries of the file. This is similar to the information provided by the `\|\c .B nm\c diff --git a/binutils/size.1 b/binutils/size.1 index 43f2091c22c..13351a4b329 100644 --- a/binutils/size.1 +++ b/binutils/size.1 @@ -16,18 +16,18 @@ size\(em\&list section sizes and total size. .TP .B size .RB "[\|" \-A \||\| \-B \||\| \c -.BI "+format\ " compatibility\c +.BI "\-\-format=" compatibility\c \&\|] -.RB "[\|" +help "\|]" +.RB "[\|" \-\-help "\|]" .RB "[\|" \-d \||\| \-o \||\| \-x\c \||\|\c -.BI "+radix\ " number\c +.BI "\-\-radix=" number\c \&\|] .RB "[\|" \c -.BI "+target\ " bfdname\c +.BI "\-\-target=" bfdname\c \&\|] -.RB "[\|" \-V \||\| +version "\|]" -.I objfiles\c +.RB "[\|" \-V \||\| \-\-version "\|]" +.I objfile\c \&.\|.\|. .ad b .hy 1 @@ -36,14 +36,14 @@ The GNU \c .B size\c \& utility lists the section sizes\(em\&and the total size\(em\&for each of the object files \c -.I objfiles\c +.I objfile\c \& in its argument list. By default, one line of output is generated for each object file or each module in an archive. .SH OPTIONS .TP -.IR "objfiles" .\|.\|. +.IR "objfile" .\|.\|. The object files to be examined. .TP @@ -51,7 +51,7 @@ The object files to be examined. .TP .B \-B .TP -.BI "+format " "compatibility"\c +.BI "\-\-format " "compatibility"\c \& Using one of these options, you can choose whether the output from GNU \c @@ -62,19 +62,19 @@ Using one of these options, you can choose whether the output from GNU .B \-A\c \|', or `\|\c -.B +format sysv\c +.B \-\-format sysv\c \|'), or Berkeley \c .B size\c \& (using `\|\c .B \-B\c \|', or `\|\c -.B +format berkeley\c +.B \-\-format berkeley\c \|'). The default is the one-line format similar to Berkeley's. .TP -.B +help +.B \-\-help Show a summary of acceptable arguments and options. .TP @@ -84,25 +84,25 @@ Show a summary of acceptable arguments and options. .TP .B \-x .TP -.BI "+radix " "number"\c +.BI "\-\-radix " "number"\c \& Using one of these options, you can control whether the size of each section is given in decimal (`\|\c .B \-d\c \|', or `\|\c -.B +radix 10\c +.B \-\-radix 10\c \|'); octal (`\|\c .B \-o\c \|', or `\|\c -.B +radix 8\c +.B \-\-radix 8\c \|'); or hexadecimal (`\|\c .B \-x\c \|', or `\|\c -.B +radix 16\c +.B \-\-radix 16\c \|'). In `\|\c -.B +radix \c +.B \-\-radix \c .I number\c \&\c \|', only the three @@ -117,10 +117,10 @@ octal and hexadecimal if you're using `\|\c \|'. .TP -.BI "+target " "bfdname"\c +.BI "\-\-target " "bfdname"\c \& You can specify a particular object-code format for \c -.I objfiles\c +.I objfile\c \& as \c .I bfdname\c @@ -135,7 +135,7 @@ on listing available formats. .TP .B \-V .TP -.B +version +.B \-\-version Display version number information on \c .B size\c \& itself. diff --git a/binutils/strip.1 b/binutils/strip.1 index 26f4a3cd914..be302bee34e 100644 --- a/binutils/strip.1 +++ b/binutils/strip.1 @@ -11,24 +11,31 @@ strip\(em\&Discard symbols from object files. .SH SYNOPSIS -.B strip\c -.RB " [\|" \-v "\|] "\c -.I objfiles\c +.B strip +.RB "[\|" "\-F \fIformat\fP" | \-\-format=\fIformat\fP | \-\-target=\fIformat\fP "\|]" +.RB "[\|" "\-I \fIformat\fP" | \-\-input\-format=\fIformat\fP "\|]" +.RB "[\|" "\-O \fIformat\fP" | \-\-output\-format=\fIformat\fP "\|]" +.RB "[\|" \-s | \-\-strip\-all "\|]" +.RB "[\|" \-S | -g | \-\-strip\-debug "\|]" +.RB "[\|" \-x | \-\-discard\-all "\|]" +.RB "[\|" \-X | \-\-discard\-locals "\|]" +.RB "[\|" \-v | \-\-verbose "\|]" +.RB "[\|" \-V | \-\-version "\|]" +.I objfile\c \&.\|.\|. .SH DESCRIPTION GNU \c .B strip\c -\& will discard all symbols from object files +\& discards all symbols from the object files \c -.I objfiles\c +.I objfile\c \&. The list of object files may include archives. \c .B strip\c \& will not execute unless at least one object file is listed. -.I WARNING:\c \& \c .B strip\c \& modifies the files named in its argument, @@ -41,6 +48,47 @@ Verbose operation: list all object files modified. In the case of archives, `\|\c .B strip \-v\c \&\|' will list all members of the archive. + +.TP +.B "\-F \fIformat\fP \-\-format=\fIformat\fP \-\-target=\fIformat\fP" +Treat the original \fIobjfile\fP as a file with the object +code format \fIformat\fP, and rewrite it in the same format. + +.TP +.B "\-I \fIformat\fP \-\-input\-format=\fIformat\fP" +Treat the original \fIobjfile\fP as a file with the object +code format \fIformat\fP. + +.TP +.B "\-O \fIformat\fP \-\-output\-format=\fIformat\fP" +Replace \fIobjfile\fP with a file in the output format \fIformat\fP. + +.TP +.B "\-s \-\-strip\-all" +Remove all symbols. + +.TP +.B "\-S -g \-\-strip\-debug" +Remove debugging symbols only. + +.TP +.B "\-x \-\-discard\-all" +Remove non-global symbols. + +.TP +.B "\-X \-\-discard\-locals" +Remove compiler-generated local symbols. +(These usually start with ``L'' or ``.''.) + +.TP +.B "\-v \-\-verbose" +Verbose output: list all object files modified. In the case of +archives, ``strip -V'' lists all members of the archive. + +.TP +.B "\-V \-\-version +Show the version number for \fBstrip\fP. + .PP .SH "SEE ALSO" -- 2.30.2