aboutsummaryrefslogtreecommitdiff
path: root/binutils/binutils.texi
diff options
context:
space:
mode:
authorDavid MacKenzie <djm@cygnus>1993-04-29 03:39:02 +0000
committerDavid MacKenzie <djm@cygnus>1993-04-29 03:39:02 +0000
commitec40bbb87fc1d450353d0a258c1f69fd5d50fc17 (patch)
treeb09ac1377234f053c6033cc164746fa4ceb66671 /binutils/binutils.texi
parent31b567269ab22929c741c82610a1baa92dbd2bfe (diff)
downloadgdb-ec40bbb87fc1d450353d0a258c1f69fd5d50fc17.zip
gdb-ec40bbb87fc1d450353d0a258c1f69fd5d50fc17.tar.gz
gdb-ec40bbb87fc1d450353d0a258c1f69fd5d50fc17.tar.bz2
Clean up English and Texinfo usage.
Diffstat (limited to 'binutils/binutils.texi')
-rw-r--r--binutils/binutils.texi172
1 files changed, 87 insertions, 85 deletions
diff --git a/binutils/binutils.texi b/binutils/binutils.texi
index 9a086d3..6d18ebf 100644
--- a/binutils/binutils.texi
+++ b/binutils/binutils.texi
@@ -87,7 +87,7 @@ into another language, under the above conditions for modified versions.
@cindex version
This brief manual contains preliminary documentation for the GNU binary
-utilities (collectively version 1.97):
+utilities (collectively version 2.1):
@iftex
@table @code
@@ -133,7 +133,7 @@ Discard symbols
@cindex archives
@cindex collections of files
@smallexample
- ar [-]@var{p}@var{mod} [ @var{membername} ] @var{archive} @var{files}@dots{}
+ ar [-]@var{p}@var{mod} [ @var{membername} ] @var{archive} @var{file@dots{}}
ar -M [ <mri-script ]
@end smallexample
@@ -143,14 +143,14 @@ other files in a structure that makes it possible to retrieve
the original individual files (called @dfn{members} of the archive).
The original files' contents, mode (permissions), timestamp, owner, and
-group are preserved in the archive, and may be reconstituted on
+group are preserved in the archive, and can be restored on
extraction.
@cindex name length
GNU @code{ar} can maintain archives whose members have names of any
length; however, depending on how @code{ar} is configured on your
-system, a limit on member-name length may be imposed (for compatibility
-with archive formats maintained with other tools). If it exists, the
+system, a limit on member-name length may be imposed for compatibility
+with archive formats maintained with other tools. If it exists, the
limit is often 15 characters (typical of formats related to a.out) or 16
characters (typical of formats related to coff).
@@ -191,7 +191,7 @@ program.
@section Controlling @code{ar} on the command line
@smallexample
- ar [-]@var{p}@var{mod} [ @var{membername} ] @var{archive} @var{files}@dots{}
+ ar [-]@var{p}@var{mod} [ @var{membername} ] @var{archive} @var{file@dots{}}
@end smallexample
@cindex Unix compatibility, @code{ar}
@@ -200,7 +200,7 @@ arguments to execute: one keyletter specifying the @emph{operation}
(optionally accompanied by other keyletters specifying
@emph{modifiers}), and the archive name to act on.
-Most operations can also accept further @var{files} arguments,
+Most operations can also accept further @var{file} arguments,
specifying particular files to operate on.
GNU @code{ar} allows you to mix the operation code @var{p} and modifier
@@ -217,7 +217,7 @@ any of the following, but you must specify only one of them:
@item d
@cindex deleting from archive
@emph{Delete} modules from the archive. Specify the names of modules to
-be deleted as @var{files}; the archive is untouched if you
+be deleted as @var{file@dots{}}; the archive is untouched if you
specify no files to delete.
If you specify the @samp{v} modifier, @code{ar} lists each module
@@ -232,7 +232,7 @@ programs are linked using the library, if a symbol is defined in more
than one member.
If no modifiers are used with @code{m}, any members you name in the
-@var{files} arguments are moved to the @emph{end} of the archive;
+@var{file} arguments are moved to the @emph{end} of the archive;
you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
specified place instead.
@@ -242,12 +242,13 @@ specified place instead.
output file. If the @samp{v} modifier is specified, show the member
name before copying its contents to standard output.
-If you specify no @var{files}, all the files in the archive are printed.
+If you specify no @var{file} arguments, all the files in the archive are
+printed.
@item q
@cindex quick append to archive
-@emph{Quick append}; add @var{files} to the end of @var{archive},
-without checking for replacement.
+@emph{Quick append}; add the files @var{file@dots{}} to the end of
+@var{archive}, without checking for replacement.
The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
operation; new members are always placed at the end of the archive.
@@ -260,11 +261,12 @@ index is not updated, even if it already existed; you can use @samp{ar s} or
@item r
@cindex replacement in archive
-Insert @var{files} into @var{archive} (with @emph{replacement}). This
-operation differs from @samp{q} in that any previously existing members
-are deleted if their names match those being added.
+Insert the files @var{file@dots{}} into @var{archive} (with
+@emph{replacement}). This operation differs from @samp{q} in that any
+previously existing members are deleted if their names match those being
+added.
-If one of the files named in @var{files} doesn't exist, @code{ar}
+If one of the files named in @var{file@dots{}} doesn't exist, @code{ar}
displays an error message, and leaves undisturbed any existing members
of the archive matching that name.
@@ -280,12 +282,12 @@ deleted) or replaced.
@item t
@cindex contents of archive
Display a @emph{table} listing the contents of @var{archive}, or those
-of the files listed in @var{files} that are present in the
+of the files listed in @var{file@dots{}} that are present in the
archive. Normally only the member name is shown; if you also want to
see the modes (permissions), timestamp, owner, group, and size, you can
request that by also specifying the @samp{v} modifier.
-If you do not specify any @var{files}, all files in the archive
+If you do not specify a @var{file}, all files in the archive
are listed.
@cindex repeated names in archive
@@ -299,11 +301,11 @@ listing---in our example, @samp{ar t b.a}.
@item x
@cindex extract from archive
-@emph{Extract} members (named @var{files}) from the archive. You can
+@emph{Extract} members (named @var{file}) from the archive. You can
use the @samp{v} modifier with this operation, to request that
@code{ar} list each name as it extracts it.
-If you do not specify any @var{files}, all files in the archive
+If you do not specify a @var{file}, all files in the archive
are extracted.
@end table
@@ -315,13 +317,13 @@ keyletter, to specify variations on an operation's behavior:
@item a
@cindex relative placement in archive
Add new files @emph{after} an existing member of the
-archive. If you use the modifier @code{a}, the name of an existing archive
+archive. If you use the modifier @samp{a}, the name of an existing archive
member must be present as the @var{membername} argument, before the
@var{archive} specification.
@item b
Add new files @emph{before} an existing member of the
-archive. If you use the modifier @code{b}, the name of an existing archive
+archive. If you use the modifier @samp{b}, the name of an existing archive
member must be present as the @var{membername} argument, before the
@var{archive} specification. (same as @samp{i}).
@@ -334,7 +336,7 @@ using this modifier.
@item i
Insert new files @emph{before} an existing member of the
-archive. If you use the modifier @code{i}, the name of an existing archive
+archive. If you use the modifier @samp{i}, the name of an existing archive
member must be present as the @var{membername} argument, before the
@var{archive} specification. (same as @samp{b}).
@@ -358,7 +360,7 @@ archive is equivalent to running @samp{ranlib} on it.
@item u
@cindex updating an archive
-Normally, @code{ar r}@dots{} inserts all files
+Normally, @samp{ar r@dots{}} inserts all files
listed into the archive. If you would like to insert @emph{only} those
of the files you list that are newer than existing members of the same
names, use this modifier. The @samp{u} modifier is allowed only for the
@@ -473,8 +475,8 @@ Requires prior use of @code{OPEN} or @code{CREATE}.
List each named @var{module} present in @var{archive}. The separate
command @code{VERBOSE} specifies the form of the output: when verbose
output is off, output is like that of @samp{ar -t @var{archive}
-@var{module}@dots{}}. When verbose output is on, the listing is like
-@samp{ar -tv @var{archive} @var{module}@dots{}}.
+@var{module@dots{}}}. When verbose output is on, the listing is like
+@samp{ar -tv @var{archive} @var{module@dots{}}}.
Output normally goes to the standard output stream; however, if you
specify @var{outputfile} as a final argument, @code{ar} directs the
@@ -489,7 +491,7 @@ changes are lost.
@item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
Extract each named @var{module} from the current archive, writing them
into the current directory as separate files. Equivalent to @samp{ar -x
-@var{archive} @var{module}@dots{}}.
+@var{archive} @var{module@dots{}}}.
Requires prior use of @code{OPEN} or @code{CREATE}.
@@ -570,12 +572,12 @@ the name of the input file.
@item -I @var{format}
@itemx --input-format=@var{format}
-Treat the source file's object format as specified, rather than
+Consider the source file's object format to be @var{format}, rather than
attempting to deduce it.
@item -O @var{format}
@itemx --output-format=@var{format}
-Write the output file using the specified object format.
+Write the output file using the object format @var{format}.
@item -F @var{format}
@itemx --format=@var{format}
@@ -630,17 +632,17 @@ The GNU linker @code{ld} is now described in a separate manual.
[ -s | --print-armap ] [ -o | --print-file-name ]
[ -n | --numeric-sort ] [ -p | --no-sort ]
[ -r | --reverse-sort ] [ -u | --undefined-only ]
- [ --target @var{bfdname} ]
- [ @var{objfiles}@dots{} ]
+ [ --target=@var{bfdname} ]
+ [ @var{objfile@dots{}} ]
@end smallexample
-GNU @code{nm} lists the symbols from object files @var{objfiles}.
+GNU @code{nm} lists the symbols from object files @var{objfile@dots{}}.
The long and short forms of options, shown here as alternatives, are
equivalent.
@table @code
-@item @var{objfiles}@dots{}
+@item @var{objfile@dots{}}
@kindex a.out
Object files whose symbols are to be listed. If no object files are
listed as arguments, @code{nm} assumes @samp{a.out}.
@@ -663,15 +665,15 @@ order encountered.
@item -n
@itemx --numeric-sort
-Sort symbols numerically by their addresses, not alphabetically by their
-names.
+Sort symbols numerically by their addresses, rather than alphabetically
+by their names.
@item -s
@itemx --print-armap
@cindex symbol index, listing
When listing symbols from archive members, include the index: a mapping
-(stored in the archive by @code{ar} or @code{ranlib}) of what modules
-contain definitions for what names.
+(stored in the archive by @code{ar} or @code{ranlib}) of which modules
+contain definitions for which names.
@item -o
@itemx --print-file-name
@@ -684,10 +686,10 @@ symbols.
@item -r
@itemx --reverse-sort
-Reverse the sense of the sort (whether numeric or alphabetic); let the
+Reverse the order of the sort (whether numeric or alphabetic); let the
last come first.
-@item --target @var{bfdname}
+@item --target=@var{bfdname}
@c @item --target
@cindex object code format
Specify an object code format other than your system's default format.
@@ -713,7 +715,7 @@ Display only undefined symbols (those external to each object file).
[ -h | --header ] [ -i ] [ -j @var{section} ] [ -l ]
[ -m @var{machine} ] [ -r | --reloc ] [ -s ]
[ --stabs ] [ -t | --syms ] [ -x ]
- @var{objfiles}@dots{}
+ @var{objfile@dots{}}
@end smallexample
@code{objdump} displays information about one or more object files.
@@ -726,14 +728,14 @@ The long and short forms of options, shown here as alternatives, are
equivalent.
@table @code
-@item @var{objfiles}@dots{}
+@item @var{objfile@dots{}}
The object files to be examined. When you specify archives,
@code{objdump} shows information on each of the member object files.
@item -a
@c print_arelt_descr
@cindex archive headers
-If any files from @var{objfiles} are archives, display the archive
+If any of the @var{objfile} files are archives, display the archive
header information (in a format similar to @samp{ls -l}). Besides the
information you could list with @samp{ar tv}, @samp{objdump -a} shows
the object file format of each archive member.
@@ -741,15 +743,17 @@ the object file format of each archive member.
@c suggest longname --target or --format or --bfd
@item -b @var{bfdname}
@cindex object code format
-You can specify a particular object-code format for your object files as
-@var{bfdname}. This may not be necessary; @var{objdump} can
-automatically recognize many formats. For example,
+Specify that the object-code format for the object files is
+@var{bfdname}. This option may not be necessary; @var{objdump} can
+automatically recognize many formats.
+
+For example,
@example
objdump -b oasys -m vax -h fu.o
@end example
@noindent
-Displays summary information from the section headers (@samp{-h}) of
-@file{fu.o}, which is explicitly identified (@samp{-m}) as a Vax object
+displays summary information from the section headers (@samp{-h}) of
+@file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
file in the format produced by Oasys compilers. You can list the
formats available with the @samp{-i} option.
@@ -757,12 +761,12 @@ formats available with the @samp{-i} option.
@cindex disassembling object code
@cindex machine instructions
Disassemble. Display the assembler mnemonics for the machine
-instructions from @var{objfiles}.
+instructions from @var{objfile}.
@item -f
@cindex object file header
File header. Display summary information from the overall header of
-each file in @var{objfiles}.
+each of the @var{objfile} files.
@item -h
@itemx --header
@@ -774,12 +778,12 @@ object file.
@cindex architectures available
@cindex object formats available
Display a list showing all architectures and object formats available
-for specification with @code{-b} or @code{-m}.
+for specification with @samp{-b} or @samp{-m}.
@c suggest longname --section
@item -j @var{name}
@cindex section information
-Display information only for section @var{name}
+Display information only for section @var{name}.
@c suggest longname --label or --linespec
@item -l
@@ -790,7 +794,7 @@ and line numbers corresponding to the object code shown.
@c suggest longname --architecture
@item -m @var{machine}
@cindex architecture
-Specify the object files @var{objfiles} are for architecture
+Specify that the object files @var{objfile} are for architecture
@var{machine}. You can list available architectures using the @samp{-i}
option.
@@ -843,13 +847,13 @@ relocation entries. Using @samp{-x} is equivalent to specifying all of
ranlib @var{archive}
@end smallexample
-@code{ranlib} generates an index to the contents of an archive, and
+@code{ranlib} generates an index to the contents of an archive and
stores it in the archive. The index lists each symbol defined by a
member of an archive that is a relocatable object file.
You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
-An archive with such an index speeds up linking to the library, and
+An archive with such an index speeds up linking to the library and
allows routines in the library to call each other without regard to
their placement in the archive.
@@ -864,30 +868,30 @@ The GNU @code{ranlib} program is another form of GNU @code{ar}; running
@cindex section sizes
@smallexample
- size [ -A | -B | --format @var{compatibility} ]
- [ --help ] [ -d | -o | -x | --radix @var{number} ]
- [ --target @var{bfdname} ] [ -V | --version ]
- @var{objfiles}@dots{}
+ size [ -A | -B | --format=@var{compatibility} ]
+ [ --help ] [ -d | -o | -x | --radix=@var{number} ]
+ [ --target=@var{bfdname} ] [ -V | --version ]
+ @var{objfile@dots{}}
@end smallexample
The GNU @code{size} utility lists the section sizes---and the total
-size---for each of the object files @var{objfiles} in its argument list.
-By default, one line of output is generated for each object file or each
-module in an archive.
+size---for each of the object or archive files @var{objfile} in its
+argument list. By default, one line of output is generated for each
+object file or each module in an archive.
The command line options have the following meanings:
@table @code
-@item @var{objfiles}@dots{}
+@item @var{objfile@dots{}}
The object files to be examined.
@item -A
@itemx -B
-@itemx --format @var{compatibility}
+@itemx --format=@var{compatibility}
@cindex size display format
Using one of these options, you can choose whether the output from GNU
@code{size} resembles output from System V @code{size} (using @samp{-A},
-or @samp{--format sysv}), or Berkeley @code{size} (using @samp{-B}, or
-@samp{--format berkeley}). The default is the one-line format similar to
+or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
+@samp{--format=berkeley}). The default is the one-line format similar to
Berkeley's.
@c Bonus for doc-source readers: you can also say --format=strange (or
@c anything else that starts with 's') for sysv, and --format=boring (or
@@ -929,27 +933,27 @@ Show a summary of acceptable arguments and options.
@item -d
@itemx -o
@itemx -x
-@itemx --radix @var{number}
+@itemx --radix=@var{number}
@cindex size number format
@cindex radix for section sizes
Using one of these options, you can control whether the size of each
-section is given in decimal (@samp{-d}, or @samp{--radix 10}); octal
-(@samp{-o}, or @samp{--radix 8}); or hexadecimal (@samp{-x}, or
-@samp{--radix 16}). In @samp{--radix @var{number}}, only the three
+section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
+(@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
+@samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
values (8, 10, 16) are supported. The total size is always given in two
radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
octal and hexadecimal if you're using @samp{-o}.
-@item --target @var{bfdname}
+@item --target=@var{bfdname}
@cindex object code format
-You can specify a particular object-code format for @var{objfiles} as
-@var{bfdname}. This may not be necessary; @var{size} can
+Specify that the object-code format for @var{objfile} is
+@var{bfdname}. This option may not be necessary; @code{size} can
automatically recognize many formats. @xref{objdump}, for information
on listing available formats.
@item -V
@itemx --version
-Display version number information on @code{size} itself.
+Display version number information for @code{size} itself.
@end table
@@ -966,33 +970,31 @@ strip [-F @var{format} | --format=@var{format} ]
[-I @var{format} | --input-format=@var{format} ]
[-O @var{format} | --output-format=@var{format} ]
[ -v | --verbose ] [ -V | --version ]
- @var{objfiles}@dots{}
+ @var{objfile@dots{}}
@end smallexample
GNU @code{strip} discards all symbols from object files
-@var{objfiles}. The list of object files may include archives.
+@var{objfile}. The list of object files may include archives.
@code{strip} will not execute unless at least one object file is listed.
-@quotation
-@emph{WARNING:} @code{strip} modifies the files named in its argument,
+@code{strip} modifies the files named in its argument,
rather than writing modified copies under different names.
-@end quotation
@table @code
@item -I @var{format}
@itemx --input-format=@var{format}
-Treat the original @var{objfiles} as files with the specified object
-code format.
+Treat the original @var{objfile} as a file with the object
+code format @var{format}.
@item -O @var{format}
@itemx --output-format=@var{format}
-Replace @var{objfiles} with files in the output format specified.
+Replace @var{objfile} with a file in the output format @var{format}.
@item -F @var{format}
@itemx --format=@var{format}
-Treat the original @var{objfiles} as files with the specified object
-code format, and rewrite them in the same format.
+Treat the original @var{objfile} as a file with the object
+code format @var{format}, and rewrite it in the same format.
@item -g
@itemx -S
@@ -1006,11 +1008,11 @@ Remove non-global symbols.
@item -X
@itemx --discard-locals
Remove compiler-generated local symbols.
-(These usually start with @code{L} or @code{.}.)
+(These usually start with @samp{L} or @samp{.}.)
@item -V
@itemx --version
-Show version number.
+Show the version number for @code{strip}.
@item -v
@itemx --verbose