Mon Dec 21 12:40:10 1992 Ian Lance Taylor (ian@cygnus.com)
[binutils-gdb.git] / binutils / binutils.texi
index 027f4c9ebd0ffb2d56e8de3925d567f66341514e..9a086d35832297169866cb93d1f47e5dd4c55f4d 100644 (file)
@@ -4,11 +4,8 @@
 @ifinfo
 @format
 START-INFO-DIR-ENTRY
-
-* Binutils: (binutils).        
-               The GNU binary utilities "ar", "ld", "objdump", "nm",
-               "size", "strip", and "ranlib".
-
+* Binutils: (binutils).                The GNU binary utilities "ar", "ld", "copy",
+                               "objdump", "nm", "size", "strip", and "ranlib".
 END-INFO-DIR-ENTRY
 @end format
 @end ifinfo
@@ -39,8 +36,8 @@ into another language, under the above conditions for modified versions.
 
 @synindex ky cp
 @c
-@c This file documents the GNU binary utilities "ar", "ld", "objdump", "nm", 
-@c "size", "strip", and "ranlib".
+@c This file documents the GNU binary utilities "ar", "ld", "copy", "objdump",
+@c  "nm", "size", "strip", and "ranlib".
 @c
 @c Copyright (C) 1991 Free Software Foundation, Inc.
 @c 
@@ -50,10 +47,10 @@ into another language, under the above conditions for modified versions.
 
 @setchapternewpage odd
 @settitle GNU Binary Utilities
-@titlepage
-@finalout
 @c @smallbook
 @c @cropmarks
+@titlepage
+@finalout
 @title The GNU Binary Utilities
 @subtitle Version 1.97
 @sp 1
@@ -97,6 +94,9 @@ utilities (collectively version 1.97):
 @item ar
 Create, modify, and extract from archives
 
+@item copy
+Copy and translate object files
+
 @item nm
 List symbols from object files
 
@@ -116,6 +116,7 @@ Discard symbols
 
 @menu
 * ar::                          Create, modify, and extract from archives
+* copy::                       Copy and translate object files
 * ld:(ld)Overview.              Combine object and archive files
 * nm::                          List symbols from object files
 * objdump::                     Display information from object files
@@ -125,7 +126,7 @@ Discard symbols
 * Index::                       
 @end menu
 
-@node ar, nm, Top, Top
+@node ar, copy, Top, Top
 @chapter ar
 
 @kindex ar
@@ -159,7 +160,7 @@ are most often used as @dfn{libraries} holding commonly needed
 subroutines.
 
 @cindex symbol index
-@code{ar} will create an index to the symbols defined in relocatable
+@code{ar} creates an index to the symbols defined in relocatable
 object modules in the archive when you specify the modifier @samp{s}.
 Once created, this index is updated in the archive whenever @code{ar}
 makes a change to its contents (save for the @samp{q} update operation).
@@ -167,7 +168,7 @@ 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.
 
-You may use @samp{nm -s} or @samp{nm +print-armap} to list this index
+You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
 table.  If an archive lacks the table, another form of @code{ar} called
 @code{ranlib} can be used to add just the table.
 
@@ -219,7 +220,7 @@ any of the following, but you must specify only one of them:
 be deleted as @var{files}; the archive is untouched if you
 specify no files to delete.
 
-If you specify the @samp{v} modifier, @code{ar} will list each module
+If you specify the @samp{v} modifier, @code{ar} lists each module
 as it is deleted.
 
 @item m
@@ -290,7 +291,7 @@ are listed.
 @cindex repeated names in archive
 @cindex name duplication in archive
 If there is more than one file with the same name (say, @samp{fie}) in
-an archive (say @samp{b.a}), @samp{ar t b.a fie} will list only the
+an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
 first instance; to see them all, you must ask for a complete
 listing---in our example, @samp{ar t b.a}.
 @c WRS only; per Gumby, this is implementation-dependent, and in a more
@@ -346,7 +347,7 @@ This modifier is accepted but not used.
 @cindex dates in archive
 Preserve the @emph{original} dates of members when extracting them.  If
 you do not specify this modifier, files extracted from the archive
-will be stamped with the time of extraction.
+are stamped with the time of extraction.
 
 @item s
 @cindex writing archive index
@@ -382,11 +383,11 @@ ar -M [ <@var{script} ]
 @cindex scripts, @code{ar}
 If you use the single command-line option @samp{-M} with @code{ar}, you
 can control its operation with a rudimentary command language.  This
-form of @code{ar} will operate interactively if standard input is coming
+form of @code{ar} operates interactively if standard input is coming
 directly from a terminal.  During interactive use, @code{ar} prompts for
 input (the prompt is @samp{AR >}), and continues executing even after
 errors.  If you redirect standard input to a script file, no prompts are
-issued, and @code{ar} will abandon execution (with a nonzero exit code)
+issued, and @code{ar} abandons execution (with a nonzero exit code)
 on any error.
 
 The @code{ar} command language is @emph{not} designed to be equivalent
@@ -534,6 +535,82 @@ Requires prior use of @code{OPEN} or @code{CREATE}.
 
 @end table
 
+@node copy, nm, ar, Top
+@chapter copy
+
+@smallexample
+copy [ -F @var{format} | --format=@var{format} ]
+     [ -I @var{format} | --input-format=@var{format} ]
+     [ -O @var{format} | --output-format=@var{format} ]
+     [ -S | --strip-all ]  [ -g | --strip-debug ]
+     [ -x | --discard-all ]  [ -X | --discard-locals ]
+     [ -v | --verbose ]  [ -V | --version ]
+     @var{infile} [@var{outfile}]
+@end smallexample
+
+The GNU @code{copy} utility copies the contents of an object file to
+another.  @code{copy} uses the GNU BFD Library to read and write the
+object files.  It can write the destination object file in a format
+different from that of the source object file.  The exact behavior of
+@code{copy} is controlled by command-line options.
+
+@code{copy} creates temporary files to do its translations and
+deletes them afterward.  @code{copy} uses BFD to do all its
+translation work; it knows about all the formats BFD knows about, and
+thus is able to recognize most formats without being told explicitly.
+@xref{BFD,,BFD,ld.info,Using LD, the GNU linker}.
+
+@table @code
+@item @var{infile}
+@itemx @var{outfile}
+The source and output files respectively.
+If you do not specify @var{outfile}, @code{copy} creates a
+temporary file and destructively renames the result with
+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
+attempting to deduce it.
+
+@item -O @var{format}
+@itemx --output-format=@var{format}
+Write the output file using the specified object format.
+
+@item -F @var{format}
+@itemx --format=@var{format}
+Use @var{format} as the object format for both the input and the output
+file; i.e. simply transfer data from source to destination with no
+translation.
+
+@item -S
+@itemx --strip-all
+Do not copy relocation and symbol information from the source file.
+
+@item -g
+@itemx --strip-debug
+Do not copy debugging symbols from the source file.
+
+@item -x
+@itemx --discard-all
+Do not copy non-global symbols from the source file.
+@c FIXME any reason to prefer "non-global" to "local" here?
+
+@item -X
+@itemx --discard-locals
+Do not copy compiler-generated local symbols.
+(These usually start with @samp{L} or @samp{.}.)
+
+@item -V
+@itemx --version
+Show version number.
+
+@item -v
+@itemx --verbose
+Verbose output: list all object files modified.  In the case of
+archives, @samp{copy -V} lists all members of the archive.
+@end table
+
 @iftex
 @node ld
 @chapter ld
@@ -543,21 +620,21 @@ The GNU linker @code{ld} is now described in a separate manual.
 @xref{Top,, Overview,, Using LD: the GNU linker}.
 @end iftex
 
-@node nm, objdump, ar, Top
+@node nm, objdump, copy, Top
 @chapter nm
 @cindex symbols
 @kindex nm
 
 @smallexample
-  nm [ -a | +debug-syms ]  [ -g | +extern-only ]
-      [ -s | +print-armap ]  [ -o | +print-file-name ]  
-      [ -n | +numeric-sort ]  [ -p | +no-sort ]
-      [ -r | +reverse-sort ]  [ -u | +undefined-only ]  
-      [ +target @var{bfdname} ]
+  nm [ -a | --debug-syms ]  [ -g | --extern-only ]
+      [ -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{} ]
 @end smallexample
 
-GNU @code{nm} will list the symbols from object files @var{objfiles}.
+GNU @code{nm} lists the symbols from object files @var{objfiles}.
 
 The long and short forms of options, shown here as alternatives, are
 equivalent.
@@ -569,35 +646,35 @@ Object files whose symbols are to be listed.  If no object files are
 listed as arguments, @code{nm} assumes @samp{a.out}.
 
 @item -a
-@itemx +debug-syms 
+@itemx --debug-syms 
 @cindex debugging symbols
 Display debugger-only symbols; normally these are not listed.
 
 @item -g
-@itemx +extern-only 
+@itemx --extern-only 
 @cindex external symbols
 Display only external symbols.
 
 @item -p
-@itemx +no-sort 
+@itemx --no-sort 
 @cindex sorting symbols
 Don't bother to sort the symbols in any order; just print them in the
 order encountered.
 
 @item -n
-@itemx +numeric-sort 
+@itemx --numeric-sort 
 Sort symbols numerically by their addresses, not alphabetically by their
 names. 
 
 @item -s
-@itemx +print-armap
+@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.
 
 @item -o
-@itemx +print-file-name 
+@itemx --print-file-name 
 @cindex input file name
 @cindex file name
 @cindex source file name
@@ -606,19 +683,19 @@ rather than identifying the input file once only before all of its
 symbols. 
 
 @item -r
-@itemx +reverse-sort 
+@itemx --reverse-sort 
 Reverse the sense of the sort (whether numeric or alphabetic); let the
 last come first.
 
-@item +target @var{bfdname}
-@c @item +target
+@item --target @var{bfdname}
+@c @item --target
 @cindex object code format
 Specify an object code format other than your system's default format.
 @xref{objdump}, for information on listing available formats.
-@c FIXME what *does* +target/no arg do?
+@c FIXME what *does* --target/no arg do?
 
 @item -u
-@itemx +undefined-only 
+@itemx --undefined-only 
 @cindex external symbols
 @cindex undefined symbols
 Display only undefined symbols (those external to each object file).
@@ -770,7 +847,7 @@ relocation entries.  Using @samp{-x} is equivalent to specifying all of
 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.
+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
 allows routines in the library to call each other without regard to
@@ -787,9 +864,9 @@ 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 ]  
+  size [ -A | -B | --format @var{compatibility} ]
+       [ --help ]  [ -d | -o | -x | --radix @var{number} ]
+       [ --target @var{bfdname} ]  [ -V | --version ]  
        @var{objfiles}@dots{}
 @end smallexample
 
@@ -805,21 +882,21 @@ 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
+@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
 @c anything else that starts with 'b') for Berkeley.
 
 Here is an example of the Berkeley (default) format of output from
 @code{size}: 
 @smallexample
- eg$  size +format Berkeley ranlib size
+ eg$  size --format Berkeley ranlib size
 text    data    bss     dec     hex     filename
 294880  81920   11592   388392  5ed28   ranlib
 294880  81920   11888   388688  5ee50   size
@@ -829,7 +906,7 @@ text    data    bss     dec     hex     filename
 This is the same data, but displayed closer to System V conventions:
 
 @smallexample
- eg$  size +format SysV ranlib size
+ eg$  size --format SysV ranlib size
 ranlib  :
 section         size         addr
 .text         294880         8192       
@@ -846,24 +923,24 @@ section         size         addr
 Total         388688    
 @end smallexample
 
-@item +help
+@item --help
 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
@@ -871,7 +948,7 @@ automatically recognize many formats.  @xref{objdump}, for information
 on listing available formats.
 
 @item -V
-@itemx +version
+@itemx --version
 Display version number information on @code{size} itself.
 
 @end table
@@ -882,17 +959,18 @@ Display version number information on @code{size} itself.
 @kindex strip
 @cindex removing symbols
 @cindex discarding symbols
+@cindex symbols, discarding
 
 @smallexample
-  strip [ -s | +strip-all ]  [ -g | -S | +strip-debug ]
-         [ -x | +discard-all ]  [ -X | +discard-locals ]
-         [ -T @var{bfdname} ]
-         @var{objfiles}@dots{}
+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{}
 @end smallexample
 
-GNU @code{strip} will discard all symbols from object files
-@var{objfiles}, if no options are specified; or only certain symbols,
-depending on its command-line options.
+GNU @code{strip} discards all symbols from object files
+@var{objfiles}.  The list of object files may include archives.
 
 @code{strip} will not execute unless at least one object file is listed.
 
@@ -901,40 +979,43 @@ depending on its command-line options.
 rather than writing modified copies under different names.
 @end quotation
 
-The long and short forms of options, shown here as alternatives, are
-equivalent.
-
 @table @code
-@item -s
-@itemx +strip-all 
-@cindex all symbols, discarding
-This is the default case: strip all symbol entries from @var{objfiles}.
+@item -I @var{format}  
+@itemx --input-format=@var{format}
+Treat the original @var{objfiles} as files with the specified object
+code format.
+
+@item -O @var{format}
+@itemx --output-format=@var{format}
+Replace @var{objfiles} with files in the output format specified.
+
+@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.
 
 @item -g
 @itemx -S
-@itemx +strip-debug 
-@cindex debugging symbols, discarding
-Discard only debugging symbol information from @var{objfiles}.
+@itemx --strip-debug
+Remove debugging symbols only.
 
 @item -x
-@itemx +discard-all 
-@cindex local symbols, discarding
-Discard all symbols local to each file in @var{objfiles}.
-@emph{WARNING:} Note that @code{+discard-all} discards only @emph{local}
-symbols, in spite of its name.
+@itemx --discard-all
+Remove non-global symbols.
 
 @item -X
-@itemx +discard-locals 
-Discard local symbols starting with @samp{L} from each file in
-@var{objfiles}.  (Some compilers produce internally-used symbols that
-begin with @samp{L}.)
+@itemx --discard-locals
+Remove compiler-generated local symbols.
+(These usually start with @code{L} or @code{.}.)
 
-@item -T @var{bfdname}
-@cindex object code format
-You can specify a particular object-code format @var{bfdname} for
-@var{objfiles}.  This may not be necessary; @var{strip} can automatically
-recognize many formats.  @xref{objdump}, for information on listing
-available formats.
+@item -V
+@itemx --version
+Show version number.
+
+@item -v
+@itemx --verbose
+Verbose output: list all object files modified.  In the case of
+archives, @samp{strip -V} lists all members of the archive.
 @end table
 
 @node Index,  , strip, Top