diff options
| -rw-r--r-- | binutils/ChangeLog | 11 | ||||
| -rw-r--r-- | binutils/Makefile.am | 130 | ||||
| -rw-r--r-- | binutils/Makefile.in | 168 | ||||
| -rw-r--r-- | binutils/addr2line.1 | 762 | ||||
| -rw-r--r-- | binutils/ar.1 | 1239 | ||||
| -rw-r--r-- | binutils/binutils.texi | 279 | ||||
| -rw-r--r-- | binutils/cxxfilt.man | 421 | ||||
| -rw-r--r-- | binutils/dlltool.1 | 509 | ||||
| -rw-r--r-- | binutils/nlmconv.1 | 745 | ||||
| -rw-r--r-- | binutils/nm.1 | 823 | ||||
| -rw-r--r-- | binutils/objcopy.1 | 1260 | ||||
| -rw-r--r-- | binutils/objdump.1 | 1264 | ||||
| -rw-r--r-- | binutils/ranlib.1 | 644 | ||||
| -rw-r--r-- | binutils/readelf.1 | 389 | ||||
| -rw-r--r-- | binutils/size.1 | 795 | ||||
| -rw-r--r-- | binutils/strings.1 | 756 | ||||
| -rw-r--r-- | binutils/strip.1 | 870 | ||||
| -rw-r--r-- | binutils/windres.1 | 377 | ||||
| -rw-r--r-- | etc/ChangeLog | 4 | ||||
| -rw-r--r-- | gas/ChangeLog | 9 | ||||
| -rw-r--r-- | gas/config/tc-arm.c | 33 | ||||
| -rw-r--r-- | gas/doc/Makefile.am | 21 | ||||
| -rw-r--r-- | gas/doc/Makefile.in | 50 | ||||
| -rw-r--r-- | gas/doc/as.1 | 1511 | ||||
| -rw-r--r-- | gas/doc/as.texinfo | 119 | ||||
| -rw-r--r-- | gas/testsuite/gas/mips/mips.exp | 2 | ||||
| -rw-r--r-- | ld/ChangeLog | 9 | ||||
| -rw-r--r-- | ld/Makefile.am | 18 | ||||
| -rw-r--r-- | ld/Makefile.in | 249 | ||||
| -rw-r--r-- | ld/ld.1 | 3070 | ||||
| -rw-r--r-- | ld/ld.texinfo | 103 |
31 files changed, 8442 insertions, 8198 deletions
diff --git a/binutils/ChangeLog b/binutils/ChangeLog index 6914410..6c9f311 100644 --- a/binutils/ChangeLog +++ b/binutils/ChangeLog @@ -1,3 +1,14 @@ +2001-03-25 Stephane Carrez <Stephane.Carrez@worldnet.fr> + + * binutils.texi: Put @c man begin and @c man end indications + to generate man pages using texi2pod and pod2man. Put @c man title + to identify each man. Add SEEALSO entries. + * Makefile.am (MANCONF, TEXI2POD, POD2MAN): New variable. + (man_MANS): Add dlltool.1, nlmconv.1, readelf.1, windres.1, + sort the list. + (*.1): Build the man pages from binutils.texi. + * Makefile.in: Regenerate. + 2001-03-13 Eric Kohl <ekohl@rz-online.de> * defparse.y (opt_equal_name): allow "." in name. diff --git a/binutils/Makefile.am b/binutils/Makefile.am index 4489ca3..7d680dd 100644 --- a/binutils/Makefile.am +++ b/binutils/Makefile.am @@ -52,8 +52,28 @@ DLLWRAP_PROG=dllwrap SRCONV_PROG=srconv$(EXEEXT) sysdump$(EXEEXT) coffdump$(EXEEXT) -man_MANS = ar.1 nm.1 objdump.1 ranlib.1 size.1 strings.1 strip.1 objcopy.1 \ - addr2line.1 nlmconv.1 $(DEMANGLER_NAME).1 +MANCONF = -Dman + +TEXI2POD = perl $(srcdir)/../etc/texi2pod.pl + +POD2MAN = pod2man --center="GNU" --release="binutils-$(VERSION)" --section=1 + +# List of man pages generated from binutils.texi +man_MANS = \ + addr2line.1 \ + ar.1 \ + dlltool.1 \ + nlmconv.1 \ + nm.1 \ + objcopy.1 \ + objdump.1 \ + ranlib.1 \ + readelf.1 \ + size.1 \ + strings.1 \ + strip.1 \ + windres.1 \ + $(DEMANGLER_NAME).1 PROGS = $(SIZE_PROG) $(OBJDUMP_PROG) $(NM_PROG) $(AR_PROG) $(STRINGS_PROG) $(STRIP_PROG) $(RANLIB_PROG) $(DEMANGLER_PROG) $(OBJCOPY_PROG) @BUILD_NLMCONV@ @BUILD_SRCONV@ @BUILD_DLLTOOL@ @BUILD_WINDRES@ $(ADDR2LINE_PROG) $(READELF_PROG) @BUILD_DLLWRAP@ @BUILD_MISC@ @@ -339,6 +359,112 @@ binutils.dvi: $(srcdir)/binutils.texi config.texi binutils.info: $(srcdir)/binutils.texi config.texi +# Man page generation from texinfo +$(srcdir)/addr2line.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Daddr2line < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/ar.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dar < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/dlltool.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Ddlltool < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/dlltool.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Ddlltool < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/nlmconv.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dnlmconv < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/nm.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dnm < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/objcopy.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dobjcopy < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/objdump.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dobjdump < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/ranlib.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dranlib < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/readelf.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dreadelf < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/size.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dsize < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/strings.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dstrings < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/strip.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dstrip < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/windres.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dwindres < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/cxxfilt.man: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dcxxfilt < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + MAINTAINERCLEANFILES = config.texi $(DEMANGLER_NAME).1: cxxfilt.man Makefile diff --git a/binutils/Makefile.in b/binutils/Makefile.in index 2e77c07..ed66c36 100644 --- a/binutils/Makefile.in +++ b/binutils/Makefile.in @@ -161,8 +161,14 @@ DLLWRAP_PROG = dllwrap SRCONV_PROG = srconv$(EXEEXT) sysdump$(EXEEXT) coffdump$(EXEEXT) -man_MANS = ar.1 nm.1 objdump.1 ranlib.1 size.1 strings.1 strip.1 objcopy.1 \ - addr2line.1 nlmconv.1 $(DEMANGLER_NAME).1 +MANCONF = -Dman + +TEXI2POD = perl $(srcdir)/../etc/texi2pod.pl + +POD2MAN = pod2man --center="GNU" --release="binutils-$(VERSION)" --section=1 + +# List of man pages generated from binutils.texi +man_MANS = addr2line.1 ar.1 dlltool.1 nlmconv.1 nm.1 objcopy.1 objdump.1 ranlib.1 readelf.1 size.1 strings.1 strip.1 windres.1 $(DEMANGLER_NAME).1 PROGS = $(SIZE_PROG) $(OBJDUMP_PROG) $(NM_PROG) $(AR_PROG) $(STRINGS_PROG) $(STRIP_PROG) $(RANLIB_PROG) $(DEMANGLER_PROG) $(OBJCOPY_PROG) @BUILD_NLMCONV@ @BUILD_SRCONV@ @BUILD_DLLTOOL@ @BUILD_WINDRES@ $(ADDR2LINE_PROG) $(READELF_PROG) @BUILD_DLLWRAP@ @BUILD_MISC@ @@ -184,24 +190,15 @@ MKDEP = gcc -MM INCLUDES = -D_GNU_SOURCE -I. -I$(srcdir) -I../bfd -I$(BFDDIR) -I$(INCDIR) @HDEFINES@ -I$(srcdir)/../intl -I../intl -DLOCALEDIR="\"$(prefix)/share/locale\"" -HFILES = arsup.h bucomm.h budbg.h coffgrok.h debug.h nlmconv.h dlltool.h \ - windres.h winduni.h +HFILES = arsup.h bucomm.h budbg.h coffgrok.h debug.h nlmconv.h dlltool.h windres.h winduni.h GENERATED_HFILES = arparse.h sysroff.h sysinfo.h defparse.h rcparse.h -CFILES = addr2line.c ar.c arsup.c bucomm.c coffdump.c coffgrok.c debug.c \ - dlltool.c filemode.c ieee.c is-ranlib.c is-strip.c maybe-ranlib.c \ - maybe-strip.c nlmconv.c nm.c not-ranlib.c not-strip.c \ - objcopy.c objdump.c prdbg.c rdcoff.c rddbg.c size.c srconv.c \ - stabs.c strings.c sysdump.c version.c wrstabs.c \ - windres.c resrc.c rescoff.c resbin.c winduni.c readelf.c \ - resres.c dllwrap.c rename.c +CFILES = addr2line.c ar.c arsup.c bucomm.c coffdump.c coffgrok.c debug.c dlltool.c filemode.c ieee.c is-ranlib.c is-strip.c maybe-ranlib.c maybe-strip.c nlmconv.c nm.c not-ranlib.c not-strip.c objcopy.c objdump.c prdbg.c rdcoff.c rddbg.c size.c srconv.c stabs.c strings.c sysdump.c version.c wrstabs.c windres.c resrc.c rescoff.c resbin.c winduni.c readelf.c resres.c dllwrap.c rename.c -GENERATED_CFILES = \ - underscore.c arparse.c arlex.c sysroff.c sysinfo.c syslex.c \ - defparse.c deflex.c nlmheader.c rcparse.c rclex.c +GENERATED_CFILES = underscore.c arparse.c arlex.c sysroff.c sysinfo.c syslex.c defparse.c deflex.c nlmheader.c rcparse.c rclex.c DEBUG_SRCS = rddbg.c debug.c stabs.c ieee.c rdcoff.c @@ -218,29 +215,12 @@ LIBIBERTY = ../libiberty/libiberty.a POTFILES = $(CFILES) $(DEBUG_SRCS) $(HFILES) -EXPECT = `if [ -f $$r/../expect/expect ] ; then \ - echo $$r/../expect/expect ; \ - else echo expect ; fi` +EXPECT = `if [ -f $$r/../expect/expect ] ; then echo $$r/../expect/expect ; else echo expect ; fi` -RUNTEST = `if [ -f ${srcdir}/../dejagnu/runtest ] ; then \ - echo ${srcdir}/../dejagnu/runtest ; \ - else echo runtest ; fi` +RUNTEST = `if [ -f ${srcdir}/../dejagnu/runtest ] ; then echo ${srcdir}/../dejagnu/runtest ; else echo runtest ; fi` -CC_FOR_TARGET = ` \ - if [ -f $$r/../gcc/xgcc ] ; then \ - if [ -f $$r/../newlib/Makefile ] ; then \ - echo $$r/../gcc/xgcc -B$$r/../gcc/ -idirafter $$r/../newlib/targ-include -idirafter $${srcroot}/../newlib/libc/include -nostdinc; \ - else \ - echo $$r/../gcc/xgcc -B$$r/../gcc/; \ - fi; \ - else \ - if [ "@host@" = "@target@" ] ; then \ - echo $(CC); \ - else \ - echo gcc | sed '$(transform)'; \ - fi; \ - fi` +CC_FOR_TARGET = ` if [ -f $$r/../gcc/xgcc ] ; then if [ -f $$r/../newlib/Makefile ] ; then echo $$r/../gcc/xgcc -B$$r/../gcc/ -idirafter $$r/../newlib/targ-include -idirafter $${srcroot}/../newlib/libc/include -nostdinc; else echo $$r/../gcc/xgcc -B$$r/../gcc/; fi; else if [ "@host@" = "@target@" ] ; then echo $(CC); else echo gcc | sed '$(transform)'; fi; fi` info_TEXINFOS = binutils.texi @@ -285,26 +265,22 @@ sysdump_SOURCES = sysdump.c $(BULIBS) nlmconv_SOURCES = nlmconv.c nlmheader.y $(BULIBS) -windres_SOURCES = windres.c resrc.c rescoff.c resbin.c rcparse.y rclex.l \ - winduni.c resres.c $(BULIBS) +windres_SOURCES = windres.c resrc.c rescoff.c resbin.c rcparse.y rclex.l winduni.c resres.c $(BULIBS) windres_LDADD = $(BFDLIB) $(LIBIBERTY) @LEXLIB@ $(INTLLIBS) dllwrap_SOURCES = dllwrap.c version.c dllwrap_LDADD = $(LIBIBERTY) $(INTLLIBS) -DISTSTUFF = arparse.c arparse.h arlex.c nlmheader.c sysinfo.c sysinfo.h \ - syslex.c deflex.c defparse.h defparse.c rclex.c rcparse.h rcparse.c +DISTSTUFF = arparse.c arparse.h arlex.c nlmheader.c sysinfo.c sysinfo.h syslex.c deflex.c defparse.h defparse.c rclex.c rcparse.h rcparse.c -DISTCLEANFILES = stamp-under sysinfo underscore.c sysroff.c sysroff.h \ - site.exp site.bak +DISTCLEANFILES = stamp-under sysinfo underscore.c sysroff.c sysroff.h site.exp site.bak MAINTAINERCLEANFILES = config.texi -MOSTLYCLEANFILES = sysinfo $(DEMANGLER_NAME).1 binutils.log binutils.sum \ - abcdefgh* +MOSTLYCLEANFILES = sysinfo $(DEMANGLER_NAME).1 binutils.log binutils.sum abcdefgh* CLEANFILES = dep.sed DEP DEPA DEP1 DEP2 @@ -930,7 +906,7 @@ distdir: $(DISTFILES) @for file in $(DISTFILES); do \ if test -f $$file; then d=.; else d=$(srcdir); fi; \ if test -d $$d/$$file; then \ - cp -pr $$d/$$file $(distdir)/$$file; \ + cp -pr $$/$$file $(distdir)/$$file; \ else \ test -f $(distdir)/$$file \ || ln $$d/$$file $(distdir)/$$file 2> /dev/null \ @@ -1232,6 +1208,112 @@ binutils.dvi: $(srcdir)/binutils.texi config.texi binutils.info: $(srcdir)/binutils.texi config.texi +# Man page generation from texinfo +$(srcdir)/addr2line.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Daddr2line < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/ar.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dar < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/dlltool.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Ddlltool < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/dlltool.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Ddlltool < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/nlmconv.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dnlmconv < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/nm.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dnm < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/objcopy.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dobjcopy < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/objdump.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dobjdump < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/ranlib.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dranlib < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/readelf.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dreadelf < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/size.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dsize < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/strings.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dstrings < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/strip.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dstrip < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/windres.1: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dwindres < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + +$(srcdir)/cxxfilt.man: $(srcdir)/binutils.texi + touch $@ + -$(TEXI2POD) $(MANCONF) -Dcxxfilt < $< > $@.pod + -($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) + rm -f $@.pod + $(DEMANGLER_NAME).1: cxxfilt.man Makefile sed -e 's/@PROGRAM@/$(DEMANGLER_NAME)/' < $(srcdir)/cxxfilt.man \ > $(DEMANGLER_NAME).1 diff --git a/binutils/addr2line.1 b/binutils/addr2line.1 index d5fc415..3ae8c85 100644 --- a/binutils/addr2line.1 +++ b/binutils/addr2line.1 @@ -1,503 +1,301 @@ -.\" Copyright 1997, 2000 Free Software Foundation, Inc. -.\" See COPYING for conditions for redistribution -.TH addr2line 1 "27 March 1997" "Free Software Foundation" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.5 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP .. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R -.SH NAME -addr2line \- convert addresses into file names and line numbers - -.SH SYNOPSIS -.hy 0 -.na -.TP -.B addr2line -.RB "[\|" "\-b\ "\c -.I bfdname\c -.RB " | " "\-\-target="\c -.I bfdname\c -\&\|] -.RB "[\|" \-C | \-\-demangle "\|]" -.RB "[\|" "\-e\ "\c -.I filename\c -.RB " | " "\-\-exe="\c -.I filename\c -\&\|] -.RB "[\|" \-f | \-\-functions "\|]" -.RB "[\|" \-s | \-\-basenames "\|]" -.RB "[\|" \-H | \-\-help "\|]" -.RB "[\|" \-V | \-\-version "\|]" -.RB "[\|" addr addr ... "\|]" -.ad b -.hy 1 -.SH DESCRIPTION -\c -.B addr2line -translates program addresses into file names and line numbers. Given -an address and an executable, it uses the debugging information in the -executable to figure out which file name and line number are -associated with a given address. - -The executable to use is specified with the -.B \-e -option. The default is -.B a.out\c -\&. - -.B addr2line -has two modes of operation. - +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH ADDR2LINE.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" +addr2line \- convert addresses into file names and line numbers. +.SH "SYNOPSIS" +addr2line [ \-b \fIbfdname\fR | --target=\fIbfdname\fR ] + [ \-C | --demangle[=\fIstyle\fR ] + [ \-e \fIfilename\fR | --exe=\fIfilename\fR ] + [ \-f | --functions ] [ \-s | --basename ] + [ \-H | --help ] [ \-V | --version ] + [ addr addr ... ] +.SH "DESCRIPTION" +\f(CWaddr2line\fR translates program addresses into file names and line +numbers. Given an address and an executable, it uses the debugging +information in the executable to figure out which file name and line +number are associated with a given address. +.PP +The executable to use is specified with the \f(CW-e\fR option. The +default is the file \fIa.out\fR. +.PP +\f(CWaddr2line\fR has two modes of operation. +.PP In the first, hexadecimal addresses are specified on the command line, -and -.B addr2line -displays the file name and line number for each address. - -In the second, -.B addr2line -reads hexadecimal addresses from standard input, and prints the file -name and line number for each address on standard output. In this -mode, -.B addr2line -may be used in a pipe to convert dynamically chosen addresses. - -The format of the output is FILENAME:LINENO. The file name and line -number for each address is printed on a separate line. If the -.B \-f -option is used, then each FILENAME:LINENO line is preceded by a -FUNCTIONNAME line which is the name of the function containing the +and \f(CWaddr2line\fR displays the file name and line number for each address. - +.PP +In the second, \f(CWaddr2line\fR reads hexadecimal addresses from +standard input, and prints the file name and line number for each +address on standard output. In this mode, \f(CWaddr2line\fR may be used +in a pipe to convert dynamically chosen addresses. +.PP +The format of the output is \fBFILENAME:LINENO\fR. The file name and +line number for each address is printed on a separate line. If the +\f(CW-f\fR option is used, then each \fBFILENAME:LINENO\fR line is +preceded by a \fBFUNCTIONNAME\fR line which is the name of the function +containing the address. +.PP If the file name or function name can not be determined, -.B addr2line -will print two question marks in their place. If the line number can -not be determined, -.B addr2line -will print 0. +\f(CWaddr2line\fR will print two question marks in their place. If the +line number can not be determined, \f(CWaddr2line\fR will print 0. +.SH "OPTIONS" +The long and short forms of options, shown here as alternatives, are +equivalent. +.Ip "\f(CW-b \fIbfdname\fR\fR" 4 +.Ip "\f(CW--target=\fIbfdname\fR\fR" 4 +Specify that the object-code format for the object files is +\fIbfdname\fR. +.Ip "\f(CW-C\fR" 4 +.Ip "\f(CW--demangle[=\fIstyle\fR]\fR" 4 +Decode (\fIdemangle\fR) low-level symbol names into user-level names. +Besides removing any initial underscore prepended by the system, this +makes \*(C+ function names readable. Different compilers have different +mangling styles. The optional demangling style argument can be used to +choose an appropriate demangling style for your compiler. +.Ip "\f(CW-e \fIfilename\fR\fR" 4 +.Ip "\f(CW--exe=\fIfilename\fR\fR" 4 +Specify the name of the executable for which addresses should be +translated. The default file is \fIa.out\fR. +.Ip "\f(CW-f\fR" 4 +.Ip "\f(CW--functions\fR" 4 +Display function names as well as file and line number information. +.Ip "\f(CW-s\fR" 4 +.Ip "\f(CW--basenames\fR" 4 +Display only the base of each file name. +.SH "SEE ALSO" +Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. +.PP +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". -.SH OPTIONS -.TP -.BI "\-b " "bfdname"\c -.TP -.BI "\-\-target=" "bfdname" -Specify the object-code format for the object files to be -\c -.I bfdname\c -\&. +.rn }` '' +.IX Title "ADDR2LINE.1 1" +.IX Name "addr2line - convert addresses into file names and line numbers." -.TP -.B \-C -.TP -.B \-\-demangle -Decode (\fIdemangle\fP) low-level symbol names into user-level names. -Besides removing any initial underscore prepended by the system, this -makes C++ function names readable. +.IX Header "NAME" -.TP -.BI "\-e " "filename"\c -.TP -.BI "\-\-exe=" "filename" -Specify the name of the executable for which addresses should be -translated. The default file is -.B a.out\c -\&. +.IX Header "SYNOPSIS" -.TP -.B \-f -.TP -.B \-\-functions -Display function names as well as file and line number information. +.IX Header "DESCRIPTION" -.TP -.B \-s -.TP -.B \-\-basenames -Display only the base of each file name. +.IX Header "OPTIONS" -.SH "SEE ALSO" -.RB "`\|" binutils "\|'" -entry in -.B -info\c -\&; -.I -The GNU Binary Utilities\c -\&, Roland H. Pesch (October 1991). +.IX Item "\f(CW-b \fIbfdname\fR\fR" -.SH COPYING -Copyright (c) 1993, 94, 95, 96, 97, 98, 1999, 2000 Free Software Foundation, Inc. -.PP -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. +.IX Item "\f(CW--target=\fIbfdname\fR\fR" + +.IX Item "\f(CW-C\fR" + +.IX Item "\f(CW--demangle[=\fIstyle\fR]\fR" -\" .SH GNU Free Documentation License -\" Version 1.1, March 2000 +.IX Item "\f(CW-e \fIfilename\fR\fR" -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP +.IX Item "\f(CW--exe=\fIfilename\fR\fR" -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP +.IX Item "\f(CW-f\fR" -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP +.IX Item "\f(CW--functions\fR" -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP +.IX Item "\f(CW-s\fR" -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP +.IX Item "\f(CW--basenames\fR" -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP +.IX Header "SEE ALSO" -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP +.IX Header "COPYRIGHT" -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. diff --git a/binutils/ar.1 b/binutils/ar.1 index d50c3a8..d37236c 100644 --- a/binutils/ar.1 +++ b/binutils/ar.1 @@ -1,892 +1,469 @@ -.\" Copyright 1991, 1992, 1993, 1995, 1998, 1999, 2000 -.\" Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH ar 1 "1999" "Free Software Foundation" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.7 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP .. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R -.SH NAME -ar \- create, modify, and extract from archives. - -.SH SYNOPSIS -.hy 0 -.na -.BR ar " [\|" "-" "\|]"\c -.I {dmpqrtx}[abcfilNoPsSuvV] \c -[\|\c -.I membername\c -\&\|] \c -[\|\c -.I count\c -\&\|] \c -.I archive\c -\& \c -.I files\c -\&.\|.\|. - -.ad b -.hy 1 -.SH DESCRIPTION -The GNU \c -.B ar\c -\& program creates, modifies, and extracts from -archives. An \c -.I archive\c -\& is a single file holding a collection of +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH AR.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" +ar \- create, modify, and extract from archives +.SH "SYNOPSIS" +ar [\-X32_64] [\-]\fIp\fR[\fImod\fR [\fIrelpos\fR] [\fIcount\fR]] \fIarchive\fR [\fImember\fR...] +.SH "DESCRIPTION" +The GNU \f(CWar\fR program creates, modifies, and extracts from +archives. An \fIarchive\fR is a single file holding a collection of other files in a structure that makes it possible to retrieve -the original individual files (called \c -.I members\c -\& of the archive). - -The original files' contents, mode (permissions), timestamp, owner, and -group are preserved in the archive, and may be reconstituted on +the original individual files (called \fImembers\fR of the archive). +.PP +The original files\*(R' contents, mode (permissions), timestamp, owner, and +group are preserved in the archive, and can be restored on extraction. - -GNU \c -.B ar\c -\& can maintain archives whose members have names of any -length; however, depending on how \c -.B ar\c -\& 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 +.PP +GNU \f(CWar\fR can maintain archives whose members have names of any +length; however, depending on how \f(CWar\fR 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 limit is often 15 characters (typical of formats related to a.out) or 16 characters (typical of formats related to coff). - -\c -.B ar\c -\& is considered a binary utility because archives of this sort -are most often used as \c -.I libraries\c -\& holding commonly needed +.PP +\f(CWar\fR is considered a binary utility because archives of this sort +are most often used as \fIlibraries\fR holding commonly needed subroutines. - -\c -.B ar\c -\& will create an index to the symbols defined in relocatable -object modules in the archive when you specify the modifier `\|\c -.B s\c -\|'. -Once created, this index is updated in the archive whenever \c -.B ar\c -\& -makes a change to its contents (save for the `\|\c -.B q\c -\|' update operation). +.PP +\f(CWar\fR creates an index to the symbols defined in relocatable +object modules in the archive when you specify the modifier \fBs\fR. +Once created, this index is updated in the archive whenever \f(CWar\fR +makes a change to its contents (save for the \fBq\fR update operation). 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 `\|\c -.B nm \-s\c -\|' or `\|\c -.B nm \-\-print\-armap\c -\|' to list this index -table. If an archive lacks the table, another form of \c -.B ar\c -\& called -\c -.B ranlib\c -\& can be used to add just the table. - -\c -.B ar\c -\& insists on at least two arguments to execute: one -keyletter specifying the \c -.I operation\c -\& (optionally accompanied by other -keyletters specifying \c -.I modifiers\c -\&), and the archive name to act on. - -Most operations can also accept further \c -.I files\c -\& arguments, -specifying particular files to operate on. - -.SH OPTIONS -GNU \c -.B ar\c -\& allows you to mix the operation code \c -.I p\c -\& and modifier -flags \c -.I mod\c -\& in any order, within the first command-line argument. - +.PP +You may use \fBnm \-s\fR or \fBnm --print-armap\fR to list this index +table. If an archive lacks the table, another form of \f(CWar\fR called +\f(CWranlib\fR can be used to add just the table. +.PP +GNU \f(CWar\fR is designed to be compatible with two different +facilities. You can control its activity using command-line options, +like the different varieties of \f(CWar\fR on Unix systems; or, if you +specify the single command-line option \fB\-M\fR, you can control it +with a script supplied via standard input, like the MRI ``librarian'\*(R' +program. +.SH "OPTIONS" +GNU \f(CWar\fR allows you to mix the operation code \fIp\fR and modifier +flags \fImod\fR in any order, within the first command-line argument. +.PP If you wish, you may begin the first command-line argument with a dash. - -The \c -.I p\c -\& keyletter specifies what operation to execute; it may be +.PP +The \fIp\fR keyletter specifies what operation to execute; it may be any of the following, but you must specify only one of them: - -.TP -.B d -\c -.I Delete\c -\& modules from the archive. Specify the names of modules to -be deleted as \c -.I files\c -\&; the archive is untouched if you +.Ip "\f(CWd\fR" 4 +\fIDelete\fR modules from the archive. Specify the names of modules to +be deleted as \fImember\fR...; the archive is untouched if you specify no files to delete. - -If you specify the `\|\c -.B v\c -\|' modifier, \c -.B ar\c -\& will list each module +.Sp +If you specify the \fBv\fR modifier, \f(CWar\fR lists each module as it is deleted. - -.TP -.B m -Use this operation to \c -.I move\c -\& members in an archive. - +.Ip "\f(CWm\fR" 4 +Use this operation to \fImove\fR members in an archive. +.Sp The ordering of members in an archive can make a difference in how programs are linked using the library, if a symbol is defined in more than one member. - -If no modifiers are used with \c -.B m\c -\&, any members you name in the -\c -.I files\c -\& arguments are moved to the \c -.I end\c -\& of the archive; -you can use the `\|\c -.B a\c -\|', `\|\c -.B b\c -\|', or `\|\c -.B i\c -\|' modifiers to move them to a +.Sp +If no modifiers are used with \f(CWm\fR, any members you name in the +\fImember\fR arguments are moved to the \fIend\fR of the archive; +you can use the \fBa\fR, \fBb\fR, or \fBi\fR modifiers to move them to a specified place instead. - -.TP -.B p -\c -.I Print\c -\& the specified members of the archive, to the standard -output file. If the `\|\c -.B v\c -\|' modifier is specified, show the member +.Ip "\f(CWp\fR" 4 +\fIPrint\fR the specified members of the archive, to the standard +output file. If the \fBv\fR modifier is specified, show the member name before copying its contents to standard output. - -If you specify no \c -.I files\c -\&, all the files in the archive are printed. - -.TP -.B q -\c -.I Quick append\c -\&; add \c -.I files\c -\& to the end of \c -.I archive\c -\&, -without checking for replacement. - -The modifiers `\|\c -.B a\c -\|', `\|\c -.B b\c -\|', and `\|\c -.B i\c -\|' do \c -.I not\c -\& affect this +.Sp +If you specify no \fImember\fR arguments, all the files in the archive are +printed. +.Ip "\f(CWq\fR" 4 +\fIQuick append\fR; Historically, add the files \fImember\fR... to the end of +\fIarchive\fR, without checking for replacement. +.Sp +The modifiers \fBa\fR, \fBb\fR, and \fBi\fR do \fInot\fR affect this operation; new members are always placed at the end of the archive. - -The modifier `\|\c -.B v\c -\|' makes \c -.B ar\c -\& list each file as it is appended. - +.Sp +The modifier \fBv\fR makes \f(CWar\fR list each file as it is appended. +.Sp Since the point of this operation is speed, the archive's symbol table -index is not updated, even if it already existed; you can use `\|\c -.B ar s\c -\|' or -\c -.B ranlib\c -\& explicitly to update the symbol table index. - +index is not updated, even if it already existed; you can use \fBar s\fR or +\f(CWranlib\fR explicitly to update the symbol table index. +.Sp However, too many different systems assume quick append rebuilds the -index, so GNU -.B ar -implements `\|\c -.B q\c -\|' as a synonym for `\|\c -.B r\c -\|'. - -.TP -.B r -Insert \c -.I files\c -\& into \c -.I archive\c -\& (with \c -.I replacement\c -\&). This -operation differs from `\|\c -.B q\c -\|' in that any previously existing members -are deleted if their names match those being added. - -If one of the files named in \c -.I files\c -\& doesn't exist, \c -.B ar\c -\& +index, so \s-1GNU\s0 ar implements \f(CWq\fR as a synonym for \f(CWr\fR. +.Ip "\f(CWr\fR" 4 +Insert the files \fImember\fR... into \fIarchive\fR (with +\fIreplacement\fR). This operation differs from \fBq\fR in that any +previously existing members are deleted if their names match those being +added. +.Sp +If one of the files named in \fImember\fR... does not exist, \f(CWar\fR displays an error message, and leaves undisturbed any existing members of the archive matching that name. - +.Sp By default, new members are added at the end of the file; but you may -use one of the modifiers `\|\c -.B a\c -\|', `\|\c -.B b\c -\|', or `\|\c -.B i\c -\|' to request +use one of the modifiers \fBa\fR, \fBb\fR, or \fBi\fR to request placement relative to some existing member. - -The modifier `\|\c -.B v\c -\|' used with this operation elicits a line of -output for each file inserted, along with one of the letters `\|\c -.B a\c -\|' or -`\|\c -.B r\c -\|' to indicate whether the file was appended (no old member +.Sp +The modifier \fBv\fR used with this operation elicits a line of +output for each file inserted, along with one of the letters \fBa\fR or +\fBr\fR to indicate whether the file was appended (no old member deleted) or replaced. - -.TP -.B t -Display a \c -.I table\c -\& listing the contents of \c -.I archive\c -\&, or those -of the files listed in \c -.I files\c -\& that are present in the +.Ip "\f(CWt\fR" 4 +Display a \fItable\fR listing the contents of \fIarchive\fR, or those +of the files listed in \fImember\fR... 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 `\|\c -.B v\c -\|' modifier. - -If you do not specify any \c -.I files\c -\&, all files in the archive +request that by also specifying the \fBv\fR modifier. +.Sp +If you do not specify a \fImember\fR, all files in the archive are listed. - -If there is more than one file with the same name (say, `\|\c -.B fie\c -\|') in -an archive (say `\|\c -.B b.a\c -\|'), `\|\c -.B ar t b.a fie\c -\|' will list only the +.Sp +If there is more than one file with the same name (say, \fBfie\fR) in +an archive (say \fBb.a\fR), \fBar t b.a fie\fR lists only the first instance; to see them all, you must ask for a complete -listing\(em\&in our example, `\|\c -.B ar t b.a\c -\|'. - -.TP -.B x -\c -.I Extract\c -\& members (named \c -.I files\c -\&) from the archive. You can -use the `\|\c -.B v\c -\|' modifier with this operation, to request that -\c -.B ar\c -\& list each name as it extracts it. - -If you do not specify any \c -.I files\c -\&, all files in the archive +listing---in our example, \fBar t b.a\fR. +.Ip "\f(CWx\fR" 4 +\fIExtract\fR members (named \fImember\fR) from the archive. You can +use the \fBv\fR modifier with this operation, to request that +\f(CWar\fR list each name as it extracts it. +.Sp +If you do not specify a \fImember\fR, all files in the archive are extracted. - .PP - -A number of modifiers (\c -.I mod\c -\&) may immediately follow the \c -.I p\c -\& +A number of modifiers (\fImod\fR) may immediately follow the \fIp\fR keyletter, to specify variations on an operation's behavior: +.Ip "\f(CWa\fR" 4 +Add new files \fIafter\fR an existing member of the +archive. If you use the modifier \fBa\fR, the name of an existing archive +member must be present as the \fIrelpos\fR argument, before the +\fIarchive\fR specification. +.Ip "\f(CWb\fR" 4 +Add new files \fIbefore\fR an existing member of the +archive. If you use the modifier \fBb\fR, the name of an existing archive +member must be present as the \fIrelpos\fR argument, before the +\fIarchive\fR specification. (same as \fBi\fR). +.Ip "\f(CWc\fR" 4 +\fICreate\fR the archive. The specified \fIarchive\fR is always +created if it did not exist, when you request an update. But a warning is +issued unless you specify in advance that you expect to create it, by +using this modifier. +.Ip "\f(CWf\fR" 4 +Truncate names in the archive. \s-1GNU\s0 \f(CWar\fR will normally permit file +names of any length. This will cause it to create archives which are +not compatible with the native \f(CWar\fR program on some systems. If +this is a concern, the \fBf\fR modifier may be used to truncate file +names when putting them in the archive. +.Ip "\f(CWi\fR" 4 +Insert new files \fIbefore\fR an existing member of the +archive. If you use the modifier \fBi\fR, the name of an existing archive +member must be present as the \fIrelpos\fR argument, before the +\fIarchive\fR specification. (same as \fBb\fR). +.Ip "\f(CWl\fR" 4 +This modifier is accepted but not used. +.Ip "\f(CWN\fR" 4 +Uses the \fIcount\fR parameter. This is used if there are multiple +entries in the archive with the same name. Extract or delete instance +\fIcount\fR of the given name from the archive. +.Ip "\f(CWo\fR" 4 +Preserve the \fIoriginal\fR dates of members when extracting them. If +you do not specify this modifier, files extracted from the archive +are stamped with the time of extraction. +.Ip "\f(CWP\fR" 4 +Use the full path name when matching names in the archive. \s-1GNU\s0 +\f(CWar\fR can not create an archive with a full path name (such archives +are not \s-1POSIX\s0 complaint), but other archive creators can. This option +will cause \s-1GNU\s0 \f(CWar\fR to match file names using a complete path +name, which can be convenient when extracting a single file from an +archive created by another tool. +.Ip "\f(CWs\fR" 4 +Write an object-file index into the archive, or update an existing one, +even if no other change is made to the archive. You may use this modifier +flag either with any operation, or alone. Running \fBar s\fR on an +archive is equivalent to running \fBranlib\fR on it. +.Ip "\f(CWS\fR" 4 +Do not generate an archive symbol table. This can speed up building a +large library in several steps. The resulting archive can not be used +with the linker. In order to build a symbol table, you must omit the +\fBS\fR modifier on the last execution of \fBar\fR, or you must run +\fBranlib\fR on the archive. +.Ip "\f(CWu\fR" 4 +Normally, \fBar r\fR... inserts all files +listed into the archive. If you would like to insert \fIonly\fR those +of the files you list that are newer than existing members of the same +names, use this modifier. The \fBu\fR modifier is allowed only for the +operation \fBr\fR (replace). In particular, the combination \fBqu\fR is +not allowed, since checking the timestamps would lose any speed +advantage from the operation \fBq\fR. +.Ip "\f(CWv\fR" 4 +This modifier requests the \fIverbose\fR version of an operation. Many +operations display additional information, such as filenames processed, +when the modifier \fBv\fR is appended. +.Ip "\f(CWV\fR" 4 +This modifier shows the version number of \f(CWar\fR. +.PP +\f(CWar\fR ignores an initial option spelt \f(CW-X32_64\fR, for +compatibility with \s-1AIX\s0. The behaviour produced by this option is the +default for \s-1GNU\s0 \f(CWar\fR. \f(CWar\fR does not support any of the other +\f(CW-X\fR options; in particular, it does not support \f(CW-X32\fR +which is the default for \s-1AIX\s0 \f(CWar\fR. +.SH "SEE ALSO" +\fInm\fR\|(1), \fIranlib\fR\|(1), and the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. +.PP +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". -.TP -.B a -Add new files \c -.I after\c -\& an existing member of the -archive. If you use the modifier \c -.B a\c -\&, the name of an existing archive -member must be present as the \c -.I membername\c -\& argument, before the -\c -.I archive\c -\& specification. +.rn }` '' +.IX Title "AR.1 1" +.IX Name "ar - create, modify, and extract from archives" -.TP -.B b -Add new files \c -.I before\c -\& an existing member of the -archive. If you use the modifier \c -.B b\c -\&, the name of an existing archive -member must be present as the \c -.I membername\c -\& argument, before the -\c -.I archive\c -\& specification. (same as `\|\c -.B i\c -\|'). +.IX Header "NAME" -.TP -.B c -\c -.I Create\c -\& the archive. The specified \c -.I archive\c -\& is always -created if it didn't exist, when you request an update. But a warning is -issued unless you specify in advance that you expect to create it, by -using this modifier. +.IX Header "SYNOPSIS" -.TP -.B f -Truncate names in the archive. -.B ar -will normally permit file names of any length. This will cause it to -create archives which are not compatible with the native -.B ar -program on some systems. If this is a concern, the -.B f -modifier may be used to truncate file names when putting them in the -archive. +.IX Header "DESCRIPTION" -.TP -.B i -Insert new files \c -.I before\c -\& an existing member of the -archive. If you use the modifier \c -.B i\c -\&, the name of an existing archive -member must be present as the \c -.I membername\c -\& argument, before the -\c -.I archive\c -\& specification. (same as `\|\c -.B b\c -\|'). +.IX Header "OPTIONS" -.TP -.B l -This modifier is accepted but not used. +.IX Item "\f(CWd\fR" -.TP -.B N -Uses the -.I count -parameter. This is used if there are multiple entries in the archive -with the same name. Extract or delete instance -.I count -of the given name from the archive. +.IX Item "\f(CWm\fR" -.TP -.B o -Preserve the \c -.I original\c -\& 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. +.IX Item "\f(CWp\fR" -.TP -.B P -Use the full path name when matching names in the archive. -.B ar -can not create an archive with a full path name (such archives are not -POSIX complaint), but other archive creators can. This option will -cause -.B ar -to match file names using a complete path name, which can be -convenient when extracting a single file from an archive created by -another tool. +.IX Item "\f(CWq\fR" -.TP -.B s -Write an object-file index into the archive, or update an existing one, -even if no other change is made to the archive. You may use this modifier -flag either with any operation, or alone. Running `\|\c -.B ar s\c -\|' on an -archive is equivalent to running `\|\c -.B ranlib\c -\|' on it. +.IX Item "\f(CWr\fR" -.TP -.B S -Do not generate an archive symbol table. This can speed up building a -large library in several steps. The resulting archive can not be used -with the linker. In order to build a symbol table, you must omit the -`\|\c -.B S\c -\|' modifier on the last execution of `\|\c -.B ar\c -\|', or you must run `\|\c -.B ranlib\c -\|' on the archive. +.IX Item "\f(CWt\fR" -.TP -.B u -Normally, \c -.B ar r\c -\&.\|.\|. inserts all files -listed into the archive. If you would like to insert \c -.I only\c -\& those -of the files you list that are newer than existing members of the same -names, use this modifier. The `\|\c -.B u\c -\|' modifier is allowed only for the -operation `\|\c -.B r\c -\|' (replace). In particular, the combination `\|\c -.B qu\c -\|' is -not allowed, since checking the timestamps would lose any speed -advantage from the operation `\|\c -.B q\c -\|'. +.IX Item "\f(CWx\fR" -.TP -.B v -This modifier requests the \c -.I verbose\c -\& version of an operation. Many -operations display additional information, such as filenames processed, -when the modifier `\|\c -.B v\c -\|' is appended. +.IX Item "\f(CWa\fR" -.TP -.B V -This modifier shows the version number of -.BR ar . +.IX Item "\f(CWb\fR" -.PP +.IX Item "\f(CWc\fR" -.SH "SEE ALSO" -.RB "`\|" binutils "\|'" -entry in -.B -info\c -\&; -.I -The GNU Binary Utilities\c -, Roland H. Pesch (October 1991). -.BR nm ( 1 )\c -\&, -.BR ranlib ( 1 )\c -\&. +.IX Item "\f(CWf\fR" -.SH COPYING -Copyright (c) 1991, 1992, 1993, 1995, 1998, 1999, 2000 Free Software Foundation, Inc. -.PP -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. +.IX Item "\f(CWi\fR" + +.IX Item "\f(CWl\fR" + +.IX Item "\f(CWN\fR" + +.IX Item "\f(CWo\fR" -\" .SH GNU Free Documentation License -\" Version 1.1, March 2000 +.IX Item "\f(CWP\fR" -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP +.IX Item "\f(CWs\fR" -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP +.IX Item "\f(CWS\fR" -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP +.IX Item "\f(CWu\fR" -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP +.IX Item "\f(CWv\fR" -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP +.IX Item "\f(CWV\fR" -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP +.IX Header "SEE ALSO" -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP +.IX Header "COPYRIGHT" -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. diff --git a/binutils/binutils.texi b/binutils/binutils.texi index 2534c41..2afe7c0 100644 --- a/binutils/binutils.texi +++ b/binutils/binutils.texi @@ -28,15 +28,17 @@ END-INFO-DIR-ENTRY @end ifinfo @ifinfo +@c man begin COPYRIGHT Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, with no Front-Cover Texts, and with no - Back-Cover Texts. A copy of the license is included in the - section entitled "GNU Free Documentation License". +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled "GNU Free Documentation License". +@c man end @ignore Permission is granted to process this file through TeX and print the results, provided the printed document carries a copying permission @@ -173,11 +175,16 @@ section entitled "GNU Free Documentation License". @kindex ar @cindex archives @cindex collections of files + +@c man title ar create, modify, and extract from archives + @smallexample ar [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}] ar -M [ <mri-script ] @end smallexample +@c man begin DESCRIPTION ar + The @sc{gnu} @code{ar} program creates, modifies, and extracts from archives. An @dfn{archive} is a single file holding a collection of other files in a structure that makes it possible to retrieve @@ -222,6 +229,8 @@ specify the single command-line option @samp{-M}, you can control it with a script supplied via standard input, like the MRI ``librarian'' program. +@c man end + @menu * ar cmdline:: Controlling @code{ar} on the command line * ar scripts:: Controlling @code{ar} with a script @@ -232,7 +241,9 @@ program. @section Controlling @code{ar} on the command line @smallexample +@c man begin SYNOPSIS ar ar [-X32_64] [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}] +@c man end @end smallexample @cindex Unix compatibility, @code{ar} @@ -244,6 +255,8 @@ arguments to execute: one keyletter specifying the @emph{operation} Most operations can also accept further @var{member} arguments, specifying particular files to operate on. +@c man begin OPTIONS ar + @sc{gnu} @code{ar} allows you to mix the operation code @var{p} and modifier flags @var{mod} in any order, within the first command-line argument. @@ -455,6 +468,14 @@ default for GNU @code{ar}. @code{ar} does not support any of the other @code{-X} options; in particular, it does not support @code{-X32} which is the default for AIX @code{ar}. +@c man end + +@ignore +@c man begin SEEALSO ar +nm(1), ranlib(1), and the Info entries for @file{binutils}. +@c man end +@end ignore + @node ar scripts @section Controlling @code{ar} with a script @@ -632,7 +653,10 @@ The @sc{gnu} linker @code{ld} is now described in a separate manual. @cindex symbols @kindex nm +@c man title nm list symbols from object files + @smallexample +@c man begin SYNOPSIS nm nm [ -a | --debug-syms ] [ -g | --extern-only ] [ -B ] [ -C | --demangle[=@var{style}] ] [ -D | --dynamic ] [ -s | --print-armap ] [ -A | -o | --print-file-name ] @@ -642,8 +666,10 @@ nm [ -a | --debug-syms ] [ -g | --extern-only ] [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ] [ --defined-only ] [-l | --line-numbers ] [ --no-demangle ] [ -V | --version ] [ -X 32_64 ] [ --help ] [ @var{objfile}@dots{} ] +@c man end @end smallexample +@c man begin DESCRIPTION nm @sc{gnu} @code{nm} lists the symbols from object files @var{objfile}@dots{}. If no object files are listed as arguments, @code{nm} assumes the file @file{a.out}. @@ -674,8 +700,11 @@ The symbol is in the uninitialized data section (known as BSS). The symbol is common. Common symbols are uninitialized data. When linking, multiple common symbols may appear with the same name. If the symbol is defined anywhere, the common symbols are treated as undefined -references. For more details on common symbols, see the discussion of +references. +@ifclear man +For more details on common symbols, see the discussion of --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}. +@end man @item D The symbol is in the initialized data section. @@ -732,6 +761,9 @@ The symbol type is unknown, or object file format specific. The symbol name. @end itemize +@c man end + +@c man begin OPTIONS nm The long and short forms of options, shown here as alternatives, are equivalent. @@ -869,10 +901,21 @@ to @code{-X 32}, which is not supported by @sc{gnu} @code{nm}. Show a summary of the options to @code{nm} and exit. @end table +@c man end + +@ignore +@c man begin SEEALSO nm +ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}. +@c man end +@end ignore + @node objcopy @chapter objcopy +@c man title objcopy copy and translate object files + @smallexample +@c man begin SYNOPSIS objcopy objcopy [ -F @var{bfdname} | --target=@var{bfdname} ] [ -I @var{bfdname} | --input-target=@var{bfdname} ] [ -O @var{bfdname} | --output-target=@var{bfdname} ] @@ -902,8 +945,10 @@ objcopy [ -F @var{bfdname} | --target=@var{bfdname} ] [ --redefine-sym @var{old}=@var{new} ] [ --weaken ] [ -v | --verbose ] [ -V | --version ] [ --help ] @var{infile} [@var{outfile}] +@c man end @end smallexample +@c man begin DESCRIPTION objcopy The @sc{gnu} @code{objcopy} utility copies the contents of an object file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to read and write the object files. It can write the destination object @@ -939,6 +984,10 @@ files. If the input format has an endianness, (some formats do not), @code{objcopy} can only copy the inputs into file formats that have the same endianness or which have no endianness (eg @samp{srec}). +@c man end + +@c man begin OPTIONS objcopy + @table @code @item @var{infile} @itemx @var{outfile} @@ -1203,13 +1252,24 @@ archives, @samp{objcopy -V} lists all members of the archive. Show a summary of the options to @code{objcopy}. @end table +@c man end + +@ignore +@c man begin SEEALSO objcopy +ld(1), objdump(1), and the Info entries for @file{binutils}. +@c man end +@end ignore + @node objdump @chapter objdump @cindex object file information @kindex objdump +@c man title objdump display information from object files. + @smallexample +@c man begin SYNOPSIS objdump objdump [ -a | --archive-headers ] [ -b @var{bfdname} | --target=@var{bfdname} ] [ -C | --demangle[=@var{style}] ] @@ -1244,8 +1304,11 @@ objdump [ -a | --archive-headers ] [ -V | --version ] [ -H | --help ] @var{objfile}@dots{} +@c man end @end smallexample +@c man begin DESCRIPTION objdump + @code{objdump} displays information about one or more object files. The options control what particular information to display. This information is mostly useful to programmers who are working on the @@ -1256,6 +1319,10 @@ program to compile and work. specify archives, @code{objdump} shows information on each of the member object files. +@c man end + +@c man begin OPTIONS objdump + The long and short forms of options, shown here as alternatives, are equivalent. At least one option from the list @samp{-a,-d,-D,-f,-g,-G,-h,-H,-p,-r,-R,-S,-t,-T,-V,-x} must be given. @@ -1481,8 +1548,11 @@ ELF file. This is only useful on systems (such as Solaris 2.0) in which @code{.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 @samp{--syms} -output. For more information on stabs symbols, see @ref{Top,Stabs,Stabs +output. +@ifclear man +For more information on stabs symbols, see @ref{Top,Stabs,Stabs Overview,stabs.info, The ``stabs'' debug format}. +@end ifclear @item --start-address=@var{address} @cindex start-address @@ -1525,6 +1595,14 @@ relocation entries. Using @samp{-x} is equivalent to specifying all of Format some lines for output devices that have more than 80 columns. @end table +@c man end + +@ignore +@c man begin SEEALSO objdump +nm(1), readelf(1), and the Info entries for @file{binutils}. +@c man end +@end ignore + @node ranlib @chapter ranlib @@ -1532,10 +1610,16 @@ Format some lines for output devices that have more than 80 columns. @cindex archive contents @cindex symbol index +@c man title ranlib generate index to archive. + @smallexample +@c man begin SYNOPSIS ranlib ranlib [-vV] @var{archive} +@c man end @end smallexample +@c man begin DESCRIPTION ranlib + @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. @@ -1550,6 +1634,10 @@ The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; runnin @code{ranlib} is completely equivalent to executing @samp{ar -s}. @xref{ar}. +@c man end + +@c man begin OPTIONS ranlib + @table @code @item -v @itemx -V @@ -1557,19 +1645,33 @@ The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; runnin Show the version number of @code{ranlib}. @end table +@c man end + +@ignore +@c man begin SEEALSO ranlib +ar(1), nm(1), and the Info entries for @file{binutils}. +@c man end +@end ignore + @node size @chapter size @kindex size @cindex section sizes +@c man title size list section sizes and total size. + @smallexample +@c man begin SYNOPSIS size size [ -A | -B | --format=@var{compatibility} ] [ --help ] [ -d | -o | -x | --radix=@var{number} ] [ --target=@var{bfdname} ] [ -V | --version ] [ @var{objfile}@dots{} ] +@c man end @end smallexample +@c man begin DESCRIPTION size + The @sc{gnu} @code{size} utility lists the section sizes---and the total 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 @@ -1578,6 +1680,10 @@ object file or each module in an archive. @var{objfile}@dots{} are the object files to be examined. If none are specified, the file @code{a.out} will be used. +@c man end + +@c man begin OPTIONS size + The command line options have the following meanings: @table @code @@ -1653,6 +1759,14 @@ automatically recognize many formats. Display the version number of @code{size}. @end table +@c man end + +@ignore +@c man begin SEEALSO size +ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}. +@c man end +@end ignore + @node strings @chapter strings @kindex strings @@ -1660,13 +1774,19 @@ Display the version number of @code{size}. @cindex printing strings @cindex strings, printing +@c man title strings print the strings of printable characters in files. + @smallexample +@c man begin SYNOPSIS strings strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-] [--all] [--print-file-name] [--bytes=@var{min-len}] [--radix=@var{radix}] [--target=@var{bfdname}] [--help] [--version] @var{file}@dots{} +@c man end @end smallexample +@c man begin DESCRIPTION strings + For each @var{file} given, @sc{gnu} @code{strings} prints the printable character sequences that are at least 4 characters long (or the number given with the options below) and are followed by an unprintable @@ -1677,6 +1797,10 @@ the strings from the whole file. @code{strings} is mainly useful for determining the contents of non-text files. +@c man end + +@c man begin OPTIONS strings + @table @code @item -a @itemx --all @@ -1718,6 +1842,15 @@ Specify an object code format other than your system's default format. Print the program version number on the standard output and exit. @end table +@c man end + +@ignore +@c man begin SEEALSO strings +ar(1), nm(1), objdump(1), ranlib(1), readelf(1) +and the Info entries for @file{binutils}. +@c man end +@end ignore + @node strip @chapter strip @@ -1726,7 +1859,10 @@ Print the program version number on the standard output and exit. @cindex discarding symbols @cindex symbols, discarding +@c man title strip Discard symbols from object files. + @smallexample +@c man begin SYNOPSIS strip strip [ -F @var{bfdname} | --target=@var{bfdname} ] [ -I @var{bfdname} | --input-target=@var{bfdname} ] [ -O @var{bfdname} | --output-target=@var{bfdname} ] @@ -1738,8 +1874,11 @@ strip [ -F @var{bfdname} | --target=@var{bfdname} ] [ -o @var{file} ] [ -p | --preserve-dates ] [ -v | --verbose ] [ -V | --version ] [ --help ] @var{objfile}@dots{} +@c man end @end smallexample +@c man begin DESCRIPTION strip + @sc{gnu} @code{strip} discards all symbols from object files @var{objfile}. The list of object files may include archives. At least one object file must be given. @@ -1747,6 +1886,10 @@ At least one object file must be given. @code{strip} modifies the files named in its argument, rather than writing modified copies under different names. +@c man end + +@c man begin OPTIONS strip + @table @code @item -F @var{bfdname} @itemx --target=@var{bfdname} @@ -1825,20 +1968,34 @@ Verbose output: list all object files modified. In the case of archives, @samp{strip -v} lists all members of the archive. @end table +@c man end + +@ignore +@c man begin SEEALSO strip +the Info entries for @file{binutils}. +@c man end +@end ignore + @node c++filt, addr2line, strip, Top @chapter c++filt @kindex c++filt @cindex demangling C++ symbols +@c man title cxxfilt Demangle C++ and Java symbols. + @smallexample +@c man begin SYNOPSIS cxxfilt c++filt [ -_ | --strip-underscores ] [ -j | --java ] [ -n | --no-strip-underscores ] [ -s @var{format} | --format=@var{format} ] [ --help ] [ --version ] [ @var{symbol}@dots{} ] +@c man end @end smallexample +@c man begin DESCRIPTION cxxfilt + @kindex cxxfilt The C++ and Java languages provides function overloading, which means that you can write many functions with the same name (providing each @@ -1866,6 +2023,10 @@ If no @var{symbol} arguments are given, @code{c++filt} reads symbol names from the standard input and writes the demangled names to the standard output. All results are printed on the standard output. +@c man end + +@c man begin OPTIONS cxxfilt + @table @code @item -_ @itemx --strip-underscores @@ -1911,6 +2072,14 @@ Print a summary of the options to @code{c++filt} and exit. Print the version number of @code{c++filt} and exit. @end table +@c man end + +@ignore +@c man begin SEEALSO cxxfilt +the Info entries for @file{binutils}. +@c man end +@end ignore + @quotation @emph{Warning:} @code{c++filt} is a new utility, and the details of its user interface are subject to change in future releases. In particular, @@ -1935,15 +2104,21 @@ c++filt @var{option} @var{symbol} @kindex addr2line @cindex address to file name and line number +@c man title addr2line convert addresses into file names and line numbers. + @smallexample +@c man begin SYNOPSIS addr2line addr2line [ -b @var{bfdname} | --target=@var{bfdname} ] [ -C | --demangle[=@var{style} ] [ -e @var{filename} | --exe=@var{filename} ] [ -f | --functions ] [ -s | --basename ] [ -H | --help ] [ -V | --version ] [ addr addr ... ] +@c man end @end smallexample +@c man begin DESCRIPTION addr2line + @code{addr2line} translates program addresses into file names and line numbers. Given an address and an executable, it uses the debugging information in the executable to figure out which file name and line @@ -1973,6 +2148,10 @@ If the file name or function name can not be determined, @code{addr2line} will print two question marks in their place. If the line number can not be determined, @code{addr2line} will print 0. +@c man end + +@c man begin OPTIONS addr2line + The long and short forms of options, shown here as alternatives, are equivalent. @@ -2007,6 +2186,14 @@ Display function names as well as file and line number information. Display only the base of each file name. @end table +@c man end + +@ignore +@c man begin SEEALSO addr2line +Info entries for @file{binutils}. +@c man end +@end ignore + @node nlmconv @chapter nlmconv @@ -2027,15 +2214,21 @@ with the above formats.}. utilities, since it is only useful for NLM targets. @end quotation +@c man title nlmconv converts object code into an NLM. + @smallexample +@c man begin SYNOPSIS nlmconv nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ] [ -O @var{bfdname} | --output-target=@var{bfdname} ] [ -T @var{headerfile} | --header-file=@var{headerfile} ] [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ] [ -h | --help ] [ -V | --version ] @var{infile} @var{outfile} +@c man end @end smallexample +@c man begin DESCRIPTION nlmconv + @code{nlmconv} converts the relocatable @samp{i386} object file @var{infile} into the NetWare Loadable Module @var{outfile}, optionally reading @var{headerfile} for NLM header information. For instructions @@ -2044,14 +2237,20 @@ on writing the NLM command file language used in header files, see the Development and Tools Overview}, which is part of the NLM Software Developer's Kit (``NLM SDK''), available from Novell, Inc. @code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read -@var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for -more information. +@var{infile}; +@ifclear man +see @ref{BFD,,BFD,ld.info,Using LD}, for more information. +@end ifclear @code{nlmconv} can perform a link step. In other words, you can list more than one object file for input if you list them in the definitions file (rather than simply specifying one input file on the command line). In this case, @code{nlmconv} calls the linker for you. +@c man end + +@c man begin OPTIONS nlmconv + @table @code @item -I @var{bfdname} @itemx --input-target=@var{bfdname} @@ -2092,6 +2291,14 @@ Prints a usage summary. Prints the version number for @code{nlmconv}. @end table +@c man end + +@ignore +@c man begin SEEALSO nlmconv +the Info entries for @file{binutils}. +@c man end +@end ignore + @node windres @chapter windres @@ -2102,10 +2309,16 @@ Prints the version number for @code{nlmconv}. utilities, since it is only useful for Windows targets. @end quotation +@c man title windres manipulate Windows resources. + @smallexample +@c man begin SYNOPSIS windres windres [options] [input-file] [output-file] +@c man end @end smallexample +@c man begin DESCRIPTION windres + @code{windres} reads resources from an input file and copies them into an output file. Either file may be in one of three formats: @@ -2148,6 +2361,10 @@ to convert it to a COFF object file, and then link the COFF file into your application. This will make the resources described in the @code{rc} file available to Windows. +@c man end + +@c man begin OPTIONS windres + @table @code @item -i @var{filename} @itemx --input @var{filename} @@ -2233,6 +2450,13 @@ If @code{windres} is compiled with @code{YYDEBUG} defined as @code{1}, this will turn on parser debugging. @end table +@c man end + +@ignore +@c man begin SEEALSO windres +the Info entries for @file{binutils}. +@c man end +@end ignore @node dlltool @chapter Create files needed to build and use DLLs @@ -2247,7 +2471,10 @@ dynamic link libraries (DLLs). utilities, since it is only useful for those targets which support DLLs. @end quotation +@c man title dlltool Create files needed to build and use DLLs. + @smallexample +@c man begin SYNOPSIS dlltool dlltool [-d|--input-def @var{def-file-name}] [-b|--base-file @var{base-file-name}] [-e|--output-exp @var{exports-file-name}] @@ -2263,8 +2490,11 @@ dlltool [-d|--input-def @var{def-file-name}] [-x|--no-idata4] [-c|--no-idata5] [-i|--interwork] [-n|--nodelete] [-v|--verbose] [-h|--help] [-V|--version] [object-file @dots{}] +@c man end @end smallexample +@c man begin DESCRIPTION dlltool + @code{dlltool} reads its inputs, which can come from the @samp{-d} and @samp{-b} options as well as object files specified on the command line. It then processes these inputs and if the @samp{-e} option has @@ -2329,6 +2559,10 @@ that uses that DLL: gcc program.o dll.lib -o program @end smallexample +@c man end + +@c man begin OPTIONS dlltool + The command line options have the following meanings: @table @code @@ -2478,13 +2712,24 @@ Displays dlltool's version number and then exits. @end table +@c man end + +@ignore +@c man begin SEEALSO dlltool +the Info entries for @file{binutils}. +@c man end +@end ignore + @node readelf @chapter readelf @cindex ELF file information @kindex readelf +@c man title readelf Displays information about ELF files. + @smallexample +@c man begin SYNOPSIS readelf readelf [ -a | --all ] [ -h | --file-header] [ -l | --program-headers | --segments] @@ -2503,8 +2748,11 @@ readelf [ -a | --all ] [ -v | --version] [ -H | --help] @var{elffile}@dots{} +@c man end @end smallexample +@c man begin DESCRIPTION readelf + @code{readelf} displays information about one or more ELF format object files. The options control what particular information to display. @@ -2512,6 +2760,10 @@ files. The options control what particular information to display. moment, @code{readelf} does not support examining archives, nor does it support examing 64 bit ELF files. +@c man end + +@c man begin OPTIONS readelf + The long and short forms of options, shown here as alternatives, are equivalent. At least one option besides @samp{-v} or @samp{-H} must be given. @@ -2612,6 +2864,13 @@ Display the command line options understood by @code{readelf}. @end table +@c man end + +@ignore +@c man begin SEEALSO readelf +objdump(1), and the Info entries for @file{binutils}. +@c man end +@end ignore @node Selecting The Target System @chapter Selecting the target system diff --git a/binutils/cxxfilt.man b/binutils/cxxfilt.man index a985dc9..d8c1105 100644 --- a/binutils/cxxfilt.man +++ b/binutils/cxxfilt.man @@ -1,114 +1,327 @@ -.\" Copyright 1991, 1994 Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH @PROGRAM@ 1 "June 1993" "cygnus support" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.3 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 .. +.de Ve +.ft R -.SH NAME -@PROGRAM@ \- demangle C++ symbols - -.SH SYNOPSIS -.hy 0 -.na -.TP -.B @PROGRAM@ -.RB "[\|" \-_ | \-\-strip-underscores "\|]" -.RB "[\|" "\-s {gnu,lucid,arm} " | " \-\-format={gnu,lucid,arm}" "\|]" -.RB "[\|" \-\-help "\|]" -.RB "[\|" \-\-version "\|]" -.RB "[\|" symbol "...\|]" -.SH DESCRIPTION -The C++ language provides function overloading, which means that you can -write many functions with the same name (providing each takes parameters -of different types). All C++ function names are encoded into a -low-level assembly label (this process is known as -.I mangling\c -). The -.B @PROGRAM@ -program does the inverse mapping: it decodes (\fIdemangles\fR) -low-level names into user-level names so that the linker can keep -these overloaded functions from clashing. +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH CXXFILT.MAN 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" +cxxfilt \- Demangle \*(C+ and Java symbols. +.SH "SYNOPSIS" +c++filt [ \-_ | --strip-underscores ] + [ \-j | --java ] + [ \-n | --no-strip-underscores ] + [ \-s \fIformat\fR | --format=\fIformat\fR ] + [ --help ] [ --version ] [ \fIsymbol\fR... ] +.SH "DESCRIPTION" +The \*(C+ and Java languages provides function overloading, which means +that you can write many functions with the same name (providing each +takes parameters of different types). All \*(C+ and Java function names +are encoded into a low-level assembly label (this process is known as +\fImangling\fR). The \f(CWc++filt\fR +[1] +program does the inverse mapping: it decodes (\fIdemangles\fR) low-level +names into user-level names so that the linker can keep these overloaded +functions from clashing. .PP Every alphanumeric word (consisting of letters, digits, underscores, dollars, or periods) seen in the input is a potential label. If the -label decodes into a C++ name, the C++ name replaces the low-level +label decodes into a \*(C+ name, the \*(C+ name replaces the low-level name in the output. .PP -You can use -.B @PROGRAM@ -to decipher individual symbols by specifying these symbols on the -command line. +You can use \f(CWc++filt\fR to decipher individual symbols: .PP -If no -.B symbol -arguments are given, -.B @PROGRAM@ -reads symbol names from the standard input and writes the demangled -names to the standard output. All results are printed on the standard -output. -.SH OPTIONS -.TP -.B \-_ -.TP -.B \-\-strip\-underscores -On some systems, both the C and C++ compilers put an -underscore in front of every name. For example, the C name -.B foo -gets the low-level name -.BR _foo . -This option removes the leading underscore. - -.TP -.B "\-s {gnu,lucid,arm}" -.TP -.B \-\-format={gnu,lucid,arm} -GNU -.B nm -can decode three different methods of mangling, used by different C++ -compilers. This option selects which method it uses: the one used by -the GNU compiler, the one used by the Lucid compiler, or the one -specified by the C++ Annotated Reference Manual. The default is the -GNU style. - -.TP -.B \-\-help -Print a summary of the options to -.B @PROGRAM@ -and exit. - -.TP -.B \-\-version -Print the version number of -.B @PROGRAM@ -and exit. - +.Vb 2 +\& +\& c++filt I<symbol> +.Ve +If no \fIsymbol\fR arguments are given, \f(CWc++filt\fR reads symbol +names from the standard input and writes the demangled names to the +standard output. All results are printed on the standard output. +.SH "OPTIONS" +.Ip "\f(CW-_\fR" 4 +.Ip "\f(CW--strip-underscores\fR" 4 +On some systems, both the C and \*(C+ compilers put an underscore in front +of every name. For example, the C name \f(CWfoo\fR gets the low-level +name \f(CW_foo\fR. This option removes the initial underscore. Whether +\f(CWc++filt\fR removes the underscore by default is target dependent. +.Ip "\f(CW-j\fR" 4 +.Ip "\f(CW--java\fR" 4 +Prints demangled names using Java syntax. The default is to use \*(C+ +syntax. +.Ip "\f(CW-n\fR" 4 +.Ip "\f(CW--no-strip-underscores\fR" 4 +Do not remove the initial underscore. +.Ip "\f(CW-s \fIformat\fR\fR" 4 +.Ip "\f(CW--format=\fIformat\fR\fR" 4 +\s-1GNU\s0 \f(CWnm\fR can decode three different methods of mangling, used by +different \*(C+ compilers. The argument to this option selects which +method it uses: +.Ip "\f(CWgnu\fR" 8 +the one used by the \s-1GNU\s0 compiler (the default method) +.Ip "\f(CWlucid\fR" 8 +the one used by the Lucid compiler +.Ip "\f(CWarm\fR" 8 +the one specified by the \*(C+ Annotated Reference Manual +.Ip "\f(CWhp\fR" 8 +the one used by the \s-1HP\s0 compiler +.Ip "\f(CWedg\fR" 8 +the one used by the \s-1EDG\s0 compiler +.Ip "\f(CWgnu-new-abi\fR" 8 +the one used by the \s-1GNU\s0 compiler with the new \s-1ABI\s0. +.Ip "\f(CW--help\fR" 4 +Print a summary of the options to \f(CWc++filt\fR and exit. +.Ip "\f(CW--version\fR" 4 +Print the version number of \f(CWc++filt\fR and exit. +.SH "FOOTNOTES" +.Ip "1." 4 +\s-1MS\s0\-\s-1DOS\s0 does not allow \f(CW+\fR characters in file names, so on +\s-1MS\s0\-\s-1DOS\s0 this program is named \f(CWcxxfilt\fR. .SH "SEE ALSO" -.RB "`\|" binutils "\|'" -entry in -.B -info\c -\&; -.I -The GNU Binary Utilities\c -\&, Roland H. Pesch (June 1993). - -.SH COPYING -Copyright (c) 1993 Free Software Foundation, Inc. -.PP -Permission is granted to make and distribute verbatim copies of -this manual provided the copyright notice and this permission notice -are preserved on all copies. +the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. .PP -Permission is granted to copy and distribute modified versions of this -manual under the conditions for verbatim copying, provided that the -entire resulting derived work is distributed under the terms of a -permission notice identical to this one. -.PP -Permission is granted to copy and distribute translations of this -manual into another language, under the above conditions for modified -versions, except that this permission notice may be included in -translations approved by the Free Software Foundation instead of in -the original English. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". + +.rn }` '' +.IX Title "CXXFILT.MAN 1" +.IX Name "cxxfilt - Demangle C++ and Java symbols." + +.IX Header "NAME" + +.IX Header "SYNOPSIS" + +.IX Header "DESCRIPTION" + +.IX Header "OPTIONS" + +.IX Item "\f(CW-_\fR" + +.IX Item "\f(CW--strip-underscores\fR" + +.IX Item "\f(CW-j\fR" + +.IX Item "\f(CW--java\fR" + +.IX Item "\f(CW-n\fR" + +.IX Item "\f(CW--no-strip-underscores\fR" + +.IX Item "\f(CW-s \fIformat\fR\fR" + +.IX Item "\f(CW--format=\fIformat\fR\fR" + +.IX Item "\f(CWgnu\fR" + +.IX Item "\f(CWlucid\fR" + +.IX Item "\f(CWarm\fR" + +.IX Item "\f(CWhp\fR" + +.IX Item "\f(CWedg\fR" + +.IX Item "\f(CWgnu-new-abi\fR" + +.IX Item "\f(CW--help\fR" + +.IX Item "\f(CW--version\fR" + +.IX Header "FOOTNOTES" + +.IX Item "1." + +.IX Header "SEE ALSO" + +.IX Header "COPYRIGHT" + diff --git a/binutils/dlltool.1 b/binutils/dlltool.1 new file mode 100644 index 0000000..ddb5ca8 --- /dev/null +++ b/binutils/dlltool.1 @@ -0,0 +1,509 @@ +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.1 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R + +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH DLLTOOL.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" +dlltool \- Create files needed to build and use DLLs. +.SH "SYNOPSIS" +dlltool [\-d|--input-def \fIdef-file-name\fR] + [\-b|--base-file \fIbase-file-name\fR] + [\-e|--output-exp \fIexports-file-name\fR] + [\-z|--output-def \fIdef-file-name\fR] + [\-l|--output-lib \fIlibrary-file-name\fR] + [--export-all-symbols] [--no-export-all-symbols] + [--exclude-symbols \fIlist\fR] + [--no-default-excludes] + [\-S|--as \fIpath-to-assembler\fR] [\-f|--as-flags \fIoptions\fR] + [\-D|--dllname \fIname\fR] [\-m|--machine \fImachine\fR] + [\-a|--add-indirect] [\-U|--add-underscore] [\-k|--kill-at] + [\-A|--add-stdcall-alias] + [\-x|--no-idata4] [\-c|--no-idata5] [\-i|--interwork] + [\-n|--nodelete] [\-v|--verbose] [\-h|--help] [\-V|--version] + [object-file ...] +.SH "DESCRIPTION" +\f(CWdlltool\fR reads its inputs, which can come from the \fB\-d\fR and +\fB\-b\fR options as well as object files specified on the command +line. It then processes these inputs and if the \fB\-e\fR option has +been specified it creates a exports file. If the \fB\-l\fR option +has been specified it creates a library file and if the \fB\-z\fR option +has been specified it creates a def file. Any or all of the \-e, \-l +and \-z options can be present in one invocation of dlltool. +.PP +When creating a DLL, along with the source for the DLL, it is necessary +to have three other files. \f(CWdlltool\fR can help with the creation of +these files. +.PP +The first file is a \fB.def\fR file which specifies which functions are +exported from the DLL, which functions the DLL imports, and so on. This +is a text file and can be created by hand, or \f(CWdlltool\fR can be used +to create it using the \fB\-z\fR option. In this case \f(CWdlltool\fR +will scan the object files specified on its command line looking for +those functions which have been specially marked as being exported and +put entries for them in the .def file it creates. +.PP +In order to mark a function as being exported from a DLL, it needs to +have an \fB\-export:<name_of_function>\fR entry in the \fB.drectve\fR +section of the object file. This can be done in C by using the +\fIasm()\fR operator: +.PP +.Vb 5 +\& +\& asm (".section .drectve"); +\& asm (".ascii \e"-export:my_func\e""); +\& +\& int my_func (void) { ... } +.Ve +The second file needed for DLL creation is an exports file. This file +is linked with the object files that make up the body of the DLL and it +handles the interface between the DLL and the outside world. This is a +binary file and it can be created by giving the \fB\-e\fR option to +\f(CWdlltool\fR when it is creating or reading in a .def file. +.PP +The third file needed for DLL creation is the library file that programs +will link with in order to access the functions in the DLL. This file +can be created by giving the \fB\-l\fR option to dlltool when it +is creating or reading in a .def file. +.PP +\f(CWdlltool\fR builds the library file by hand, but it builds the +exports file by creating temporary files containing assembler statements +and then assembling these. The \fB\-S\fR command line option can be +used to specify the path to the assembler that dlltool will use, +and the \fB\-f\fR option can be used to pass specific flags to that +assembler. The \fB\-n\fR can be used to prevent dlltool from deleting +these temporary assembler files when it is done, and if \fB\-n\fR is +specified twice then this will prevent dlltool from deleting the +temporary object files it used to build the library. +.PP +Here is an example of creating a DLL from a source file \fBdll.c\fR and +also creating a program (from an object file called \fBprogram.o\fR) +that uses that DLL: +.PP +.Vb 5 +\& +\& gcc -c dll.c +\& dlltool -e exports.o -l dll.lib dll.o +\& gcc dll.o exports.o -o dll.dll +\& gcc program.o dll.lib -o program +.Ve +.SH "OPTIONS" +The command line options have the following meanings: +.Ip "\f(CW-d \fIfilename\fR\fR" 4 +.Ip "\f(CW--input-def \fIfilename\fR\fR" 4 +Specifies the name of a .def file to be read in and processed. +.Ip "\f(CW-b \fIfilename\fR\fR" 4 +.Ip "\f(CW--base-file \fIfilename\fR\fR" 4 +Specifies the name of a base file to be read in and processed. The +contents of this file will be added to the relocation section in the +exports file generated by dlltool. +.Ip "\f(CW-e \fIfilename\fR\fR" 4 +.Ip "\f(CW--output-exp \fIfilename\fR\fR" 4 +Specifies the name of the export file to be created by dlltool. +.Ip "\f(CW-z \fIfilename\fR\fR" 4 +.Ip "\f(CW--output-def \fIfilename\fR\fR" 4 +Specifies the name of the .def file to be created by dlltool. +.Ip "\f(CW-l \fIfilename\fR\fR" 4 +.Ip "\f(CW--output-lib \fIfilename\fR\fR" 4 +Specifies the name of the library file to be created by dlltool. +.Ip "\f(CW--export-all-symbols\fR" 4 +Treat all global and weak defined symbols found in the input object +files as symbols to be exported. There is a small list of symbols which +are not exported by default; see the \f(CW--no-default-excludes\fR +option. You may add to the list of symbols to not export by using the +\f(CW--exclude-symbols\fR option. +.Ip "\f(CW--no-export-all-symbols\fR" 4 +Only export symbols explicitly listed in an input .def file or in +\&\fB.drectve\fR sections in the input object files. This is the default +behaviour. The \fB.drectve\fR sections are created by \fBdllexport\fR +attributes in the source code. +.Ip "\f(CW--exclude-symbols \fIlist\fR\fR" 4 +Do not export the symbols in \fIlist\fR. This is a list of symbol names +separated by comma or colon characters. The symbol names should not +contain a leading underscore. This is only meaningful when +\f(CW--export-all-symbols\fR is used. +.Ip "\f(CW--no-default-excludes\fR" 4 +When \f(CW--export-all-symbols\fR is used, it will by default avoid +exporting certain special symbols. The current list of symbols to avoid +exporting is \fBDllMain@12\fR, \fBDllEntryPoint@0\fR, +\fBimpure_ptr\fR. You may use the \f(CW--no-default-excludes\fR option +to go ahead and export these special symbols. This is only meaningful +when \f(CW--export-all-symbols\fR is used. +.Ip "\f(CW-S \fIpath\fR\fR" 4 +.Ip "\f(CW--as \fIpath\fR\fR" 4 +Specifies the path, including the filename, of the assembler to be used +to create the exports file. +.Ip "\f(CW-f \fIswitches\fR\fR" 4 +.Ip "\f(CW--as-flags \fIswitches\fR\fR" 4 +Specifies any specific command line switches to be passed to the +assembler when building the exports file. This option will work even if +the \fB\-S\fR option is not used. This option only takes one argument, +and if it occurs more than once on the command line, then later +occurrences will override earlier occurrences. So if it is necessary to +pass multiple switches to the assembler they should be enclosed in +double quotes. +.Ip "\f(CW-D \fIname\fR\fR" 4 +.Ip "\f(CW--dll-name \fIname\fR\fR" 4 +Specifies the name to be stored in the .def file as the name of the \s-1DLL\s0 +when the \fB\-e\fR option is used. If this option is not present, then +the filename given to the \fB\-e\fR option will be used as the name of +the \s-1DLL\s0. +.Ip "\f(CW-m \fImachine\fR\fR" 4 +.Ip "\f(CW-machine \fImachine\fR\fR" 4 +Specifies the type of machine for which the library file should be +built. \f(CWdlltool\fR has a built in default type, depending upon how +it was created, but this option can be used to override that. This is +normally only useful when creating DLLs for an \s-1ARM\s0 processor, when the +contents of the \s-1DLL\s0 are actually encode using \s-1THUMB\s0 instructions. +.Ip "\f(CW-a\fR" 4 +.Ip "\f(CW--add-indirect\fR" 4 +Specifies that when \f(CWdlltool\fR is creating the exports file it +should add a section which allows the exported functions to be +referenced without using the import library. Whatever the hell that +means! +.Ip "\f(CW-U\fR" 4 +.Ip "\f(CW--add-underscore\fR" 4 +Specifies that when \f(CWdlltool\fR is creating the exports file it +should prepend an underscore to the names of the exported functions. +.Ip "\f(CW-k\fR" 4 +.Ip "\f(CW--kill-at\fR" 4 +Specifies that when \f(CWdlltool\fR is creating the exports file it +should not append the string \fB@ <number>\fR. These numbers are +called ordinal numbers and they represent another way of accessing the +function in a \s-1DLL\s0, other than by name. +.Ip "\f(CW-A\fR" 4 +.Ip "\f(CW--add-stdcall-alias\fR" 4 +Specifies that when \f(CWdlltool\fR is creating the exports file it +should add aliases for stdcall symbols without \fB@ <number>\fR +in addition to the symbols with \fB@ <number>\fR. +.Ip "\f(CW-x\fR" 4 +.Ip "\f(CW--no-idata4\fR" 4 +Specifies that when \f(CWdlltool\fR is creating the exports and library +files it should omit the .idata4 section. This is for compatibility +with certain operating systems. +.Ip "\f(CW-c\fR" 4 +.Ip "\f(CW--no-idata5\fR" 4 +Specifies that when \f(CWdlltool\fR is creating the exports and library +files it should omit the .idata5 section. This is for compatibility +with certain operating systems. +.Ip "\f(CW-i\fR" 4 +.Ip "\f(CW--interwork\fR" 4 +Specifies that \f(CWdlltool\fR should mark the objects in the library +file and exports file that it produces as supporting interworking +between \s-1ARM\s0 and \s-1THUMB\s0 code. +.Ip "\f(CW-n\fR" 4 +.Ip "\f(CW--nodelete\fR" 4 +Makes \f(CWdlltool\fR preserve the temporary assembler files it used to +create the exports file. If this option is repeated then dlltool will +also preserve the temporary object files it uses to create the library +file. +.Ip "\f(CW-v\fR" 4 +.Ip "\f(CW--verbose\fR" 4 +Make dlltool describe what it is doing. +.Ip "\f(CW-h\fR" 4 +.Ip "\f(CW--help\fR" 4 +Displays a list of command line options and then exits. +.Ip "\f(CW-V\fR" 4 +.Ip "\f(CW--version\fR" 4 +Displays dlltool's version number and then exits. +.SH "SEE ALSO" +the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. +.PP +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". + +.rn }` '' +.IX Title "DLLTOOL.1 1" +.IX Name "dlltool - Create files needed to build and use DLLs." + +.IX Header "NAME" + +.IX Header "SYNOPSIS" + +.IX Header "DESCRIPTION" + +.IX Header "OPTIONS" + +.IX Item "\f(CW-d \fIfilename\fR\fR" + +.IX Item "\f(CW--input-def \fIfilename\fR\fR" + +.IX Item "\f(CW-b \fIfilename\fR\fR" + +.IX Item "\f(CW--base-file \fIfilename\fR\fR" + +.IX Item "\f(CW-e \fIfilename\fR\fR" + +.IX Item "\f(CW--output-exp \fIfilename\fR\fR" + +.IX Item "\f(CW-z \fIfilename\fR\fR" + +.IX Item "\f(CW--output-def \fIfilename\fR\fR" + +.IX Item "\f(CW-l \fIfilename\fR\fR" + +.IX Item "\f(CW--output-lib \fIfilename\fR\fR" + +.IX Item "\f(CW--export-all-symbols\fR" + +.IX Item "\f(CW--no-export-all-symbols\fR" + +.IX Item "\f(CW--exclude-symbols \fIlist\fR\fR" + +.IX Item "\f(CW--no-default-excludes\fR" + +.IX Item "\f(CW-S \fIpath\fR\fR" + +.IX Item "\f(CW--as \fIpath\fR\fR" + +.IX Item "\f(CW-f \fIswitches\fR\fR" + +.IX Item "\f(CW--as-flags \fIswitches\fR\fR" + +.IX Item "\f(CW-D \fIname\fR\fR" + +.IX Item "\f(CW--dll-name \fIname\fR\fR" + +.IX Item "\f(CW-m \fImachine\fR\fR" + +.IX Item "\f(CW-machine \fImachine\fR\fR" + +.IX Item "\f(CW-a\fR" + +.IX Item "\f(CW--add-indirect\fR" + +.IX Item "\f(CW-U\fR" + +.IX Item "\f(CW--add-underscore\fR" + +.IX Item "\f(CW-k\fR" + +.IX Item "\f(CW--kill-at\fR" + +.IX Item "\f(CW-A\fR" + +.IX Item "\f(CW--add-stdcall-alias\fR" + +.IX Item "\f(CW-x\fR" + +.IX Item "\f(CW--no-idata4\fR" + +.IX Item "\f(CW-c\fR" + +.IX Item "\f(CW--no-idata5\fR" + +.IX Item "\f(CW-i\fR" + +.IX Item "\f(CW--interwork\fR" + +.IX Item "\f(CW-n\fR" + +.IX Item "\f(CW--nodelete\fR" + +.IX Item "\f(CW-v\fR" + +.IX Item "\f(CW--verbose\fR" + +.IX Item "\f(CW-h\fR" + +.IX Item "\f(CW--help\fR" + +.IX Item "\f(CW-V\fR" + +.IX Item "\f(CW--version\fR" + +.IX Header "SEE ALSO" + +.IX Header "COPYRIGHT" + diff --git a/binutils/nlmconv.1 b/binutils/nlmconv.1 index 35bdeb9..7590b66 100644 --- a/binutils/nlmconv.1 +++ b/binutils/nlmconv.1 @@ -1,472 +1,301 @@ -.\" Copyright 1991, 1993, 1994, 1996, 2000 Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH nlmconv 1 "March 1996" "Free Software Foundation" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.5 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP .. - -.SH NAME -nlmconv \- converts object code into an NLM - -.SH SYNOPSIS -.hy 0 -.na -.TP -.B nlmconv -.RB "[\|" \-I\ \fIbfdname\fB\ |\ \-\-input\-target=\fIbfdname\fR "\|]" -.RB "[\|" \-O\ \fIbfdname\fB\ |\ \-\-output\-target=\fIbfdname\fR "\|]" -.RB "[\|" \-T\ \fIheaderfile\fB\ |\ \-\-header\-file=\fIheaderfile\fR "\|]" -.RB "[\|" \-V\ |\ \-\-version\fR "\|]" -.RB "[\|" \-\-help\fR "\|]" -.B infile -.B outfile -.SH DESCRIPTION -.B nlmconv -converts the relocatable object file -.B infile -into the NetWare Loadable Module -.BR outfile , -optionally reading -.I headerfile -for NLM header information. For instructions on writing the NLM -command file language used in header files, see -.IR "The NetWare Tool Maker Specification Manual" , -available from Novell, Inc. -.B nlmconv -currently works with i386 object files in -.BR COFF , -.BR ELF , -or -.B a.out -format, and with SPARC object files in -.B ELF -or -.B a.out -format. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip .br -.B nlmconv -uses the GNU Binary File Descriptor library to read -.IR infile . -.SH OPTIONS -.TP -.B \-I \fIbfdname\fR, \fB\-\-input\-target=\fIbfdname -Consider the source file's object format to be -.IR bfdname , -rather than attempting to deduce it. -.TP -.B \-O \fIbfdname\fR, \fB\-\-output\-target=\fIbfdname -Write the output file using the object format -.IR bfdname . -.B nlmconv -infers the output format based on the input format, e.g. for an i386 -input file the output format is -.IR nlm32\-i386 . -.TP -.B \-T \fIheaderfile\fR, \fB\-\-header\-file=\fIheaderfile -Reads -.I headerfile -for NLM header information. For instructions on writing the NLM -command file language used in header files, see -.IR "The NetWare Tool Maker Specification Manual" , -available from Novell, Inc. -.TP -.B \-V\fR, \fB\-\-version -Show the version number of -.B nlmconv -and exit. -.TP -.B \-h\fR, \fB\-\-help -Show a summary of the options to -.B nlmconv -and exit. -.SH "SEE ALSO" -.RB "`\|" binutils "\|'" -entry in -.B -info\c -\&; -.I -The GNU Binary Utilities\c -\&, Roland H. Pesch (June 1993). +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R -.SH COPYING -Copyright (c) 1993, 2000 Free Software Foundation, Inc. +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH NLMCONV.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" +nlmconv \- converts object code into an NLM. +.SH "SYNOPSIS" +nlmconv [ \-I \fIbfdname\fR | --input-target=\fIbfdname\fR ] + [ \-O \fIbfdname\fR | --output-target=\fIbfdname\fR ] + [ \-T \fIheaderfile\fR | --header-file=\fIheaderfile\fR ] + [ \-d | --debug] [ \-l \fIlinker\fR | --linker=\fIlinker\fR ] + [ \-h | --help ] [ \-V | --version ] + \fIinfile\fR \fIoutfile\fR +.SH "DESCRIPTION" +\f(CWnlmconv\fR converts the relocatable \fBi386\fR object file +\fIinfile\fR into the NetWare Loadable Module \fIoutfile\fR, optionally +reading \fIheaderfile\fR for NLM header information. For instructions +on writing the NLM command file language used in header files, see the +\fBlinkers\fR section, \fBNLMLINK\fR in particular, of the \fINLM +Development and Tools Overview\fR, which is part of the NLM Software +Developer's Kit (``NLM SDK''), available from Novell, Inc. +\f(CWnlmconv\fR uses the GNU Binary File Descriptor library to read +\fIinfile\fR; +.PP +\f(CWnlmconv\fR can perform a link step. In other words, you can list +more than one object file for input if you list them in the definitions +file (rather than simply specifying one input file on the command line). +In this case, \f(CWnlmconv\fR calls the linker for you. +.SH "OPTIONS" +.Ip "\f(CW-I \fIbfdname\fR\fR" 4 +.Ip "\f(CW--input-target=\fIbfdname\fR\fR" 4 +Object format of the input file. \f(CWnlmconv\fR can usually determine +the format of a given file (so no default is necessary). +.Ip "\f(CW-O \fIbfdname\fR\fR" 4 +.Ip "\f(CW--output-target=\fIbfdname\fR\fR" 4 +Object format of the output file. \f(CWnlmconv\fR infers the output +format based on the input format, e.g. for a \fBi386\fR input file the +output format is \fBnlm32-i386\fR. +.Ip "\f(CW-T \fIheaderfile\fR\fR" 4 +.Ip "\f(CW--header-file=\fIheaderfile\fR\fR" 4 +Reads \fIheaderfile\fR for \s-1NLM\s0 header information. For instructions on +writing the \s-1NLM\s0 command file language used in header files, see see the +\fBlinkers\fR section, of the \fI\s-1NLM\s0 Development and Tools +Overview\fR, which is part of the \s-1NLM\s0 Software Developer's Kit, available +from Novell, Inc. +.Ip "\f(CW-d\fR" 4 +.Ip "\f(CW--debug\fR" 4 +Displays (on standard error) the linker command line used by \f(CWnlmconv\fR. +.Ip "\f(CW-l \fIlinker\fR\fR" 4 +.Ip "\f(CW--linker=\fIlinker\fR\fR" 4 +Use \fIlinker\fR for any linking. \fIlinker\fR can be an absolute or a +relative pathname. +.Ip "\f(CW-h\fR" 4 +.Ip "\f(CW--help\fR" 4 +Prints a usage summary. +.Ip "\f(CW-V\fR" 4 +.Ip "\f(CW--version\fR" 4 +Prints the version number for \f(CWnlmconv\fR. +.SH "SEE ALSO" +the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. .PP -This document is distributed under the terms of the GNU Free -Documenation License. That license is described in the GNU Free -Documentation License section. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". + +.rn }` '' +.IX Title "NLMCONV.1 1" +.IX Name "nlmconv - converts object code into an NLM." + +.IX Header "NAME" + +.IX Header "SYNOPSIS" + +.IX Header "DESCRIPTION" + +.IX Header "OPTIONS" + +.IX Item "\f(CW-I \fIbfdname\fR\fR" + +.IX Item "\f(CW--input-target=\fIbfdname\fR\fR" + +.IX Item "\f(CW-O \fIbfdname\fR\fR" + +.IX Item "\f(CW--output-target=\fIbfdname\fR\fR" + +.IX Item "\f(CW-T \fIheaderfile\fR\fR" + +.IX Item "\f(CW--header-file=\fIheaderfile\fR\fR" + +.IX Item "\f(CW-d\fR" -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. +.IX Item "\f(CW--debug\fR" -\" .SH GNU Free Documentation License -\" Version 1.1, March 2000 +.IX Item "\f(CW-l \fIlinker\fR\fR" -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP +.IX Item "\f(CW--linker=\fIlinker\fR\fR" -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP +.IX Item "\f(CW-h\fR" -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP +.IX Item "\f(CW--help\fR" -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP +.IX Item "\f(CW-V\fR" -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP +.IX Item "\f(CW--version\fR" -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP +.IX Header "SEE ALSO" -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP +.IX Header "COPYRIGHT" -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. diff --git a/binutils/nm.1 b/binutils/nm.1 index 48fefe5..bf7daa9 100644 --- a/binutils/nm.1 +++ b/binutils/nm.1 @@ -1,589 +1,264 @@ -.\" Copyright 1991, 1992, 1993, 1994, 1995, 1996, 2000 -.\" Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH nm 1 "5 November 1991" "Free Software Foundation" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.5 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP .. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R -.SH NAME -nm \- list symbols from object files. - -.SH SYNOPSIS -.hy 0 -.na -.TP -.B nm -.RB "[\|" \-a | \-\-debug\-syms "\|]" -.RB "[\|" \-g | \-\-extern\-only "\|]" -.RB "[\|" \-B "\|]" -.RB "[\|" \-C | \-\-demangle "\|]" -.RB "[\|" \-D | \-\-dynamic "\|]" -.RB "[\|" \-s | \-\-print\-armap "\|]" -.RB "[\|" \-o | \-\-print\-file\-name "\|]" -.RB "[\|" \-n | \-\-numeric\-sort "\|]" -.RB "[\|" \-p | \-\-no\-sort "\|]" -.RB "[\|" \-r | \-\-reverse\-sort "\|]" -.RB "[\|" \-\-size\-sort "\|]" -.RB "[\|" \-u | \-\-undefined\-only "\|]" -.RB "[\|" \-l | \-\-line\-numbers "\|]" -.RB "[\|" \-\-help "\|]" -.RB "[\|" \-\-version "\|]" -.RB "[\|" "\-t \fIradix" | \-\-radix=\fIradix "\|]" -.RB "[\|" \-P | --portability "\|]" -.RB "[\|" "\-f \fIformat" | \-\-format=\fIformat "\|]" -.RB "[\|" "\-\-target=\fIbfdname" "\|]" -.RB "[\|" \c -.I objfile\c -\&.\|.\|.\|] -.ad b -.hy 1 -.SH DESCRIPTION -GNU \c -.B nm\c -\& lists the symbols from object files \c -.I objfile\c -\&. If no object files are given as arguments, \c -.B nm\c -\& assumes `\|\c -.B a.out\c -\|'. - -.SH OPTIONS -The long and short forms of options, shown here as alternatives, are -equivalent. - -.TP -.B \-A -.TP -.B \-o -.TP -.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. - -.TP -.B \-a -.TP -.B \-\-debug\-syms -Display debugger-only symbols; normally these are not listed. - -.TP -.B \-B -The same as -.B \-\-format=bsd -(for compatibility with the MIPS \fBnm\fP). - -.TP -.B \-C -.TP -.B \-\-demangle -Decode (\fIdemangle\fP) low-level symbol names into user-level names. -Besides removing any initial underscore prepended by the system, this -makes C++ function names readable. - -.TP -.B \-D -.TP -.B \-\-dynamic -Display the dynamic symbols rather than the normal symbols. This is -only meaningful for dynamic objects, such as certain types of shared -libraries. - -.TP -.B "\-f \fIformat" -Use the output format \fIformat\fP, which can be ``bsd'', -``sysv'', or ``posix''. The default is ``bsd''. -Only the first character of \fIformat\fP is significant; it can be -either upper or lower case. - -.TP -.B \-g -.TP -.B \-\-extern\-only -Display only external symbols. - -.TP -.B \-n -.TP -.B \-v -.TP -.B \-\-numeric\-sort -Sort symbols numerically by their addresses, not alphabetically by their -names. - -.TP -.B \-p -.TP -.B \-\-no\-sort -Don't bother to sort the symbols in any order; just print them in the -order encountered. - -.TP -.B \-P -.TP -.B \-\-portability -Use the POSIX.2 standard output format instead of the default format. -Equivalent to ``\-f posix''. - -.TP -.B \-s -.TP -.B \-\-print\-armap -When listing symbols from archive members, include the index: a mapping -(stored in the archive by \c -.B ar\c -\& or \c -.B ranlib\c -\&) of what modules -contain definitions for what names. - -.TP -.B \-r -.TP -.B \-\-reverse\-sort -Reverse the sense of the sort (whether numeric or alphabetic); let the -last come first. - -.TP -.B \-\-size\-sort -Sort symbols by size. The size is computed as the difference between -the value of the symbol and the value of the symbol with the next higher -value. The size of the symbol is printed, rather than the value. - -.TP -.B "\-t \fIradix" -.TP -.B "\-\-radix=\fIradix" -Use \fIradix\fP as the radix for printing the symbol values. It must be -``d'' for decimal, ``o'' for octal, or ``x'' for hexadecimal. - -.TP -.BI "\-\-target=" "bfdname" -Specify an object code format other than your system's default format. -See -.BR objdump ( 1 ), -for information on listing available formats. - -.TP -.B \-u -.TP -.B \-\-undefined\-only -Display only undefined symbols (those external to each object file). - -.TP -.B \-l -.TP -.B \-\-line\-numbers -For each symbol, use debugging information to try to find a filename and -line number. For a defined symbol, look for the line number of the -address of the symbol. For an undefined symbol, look for the line -number of a relocation entry which refers to the symbol. If line number -information can be found, print it after the other symbol information. - -.TP -.B \-V -.TP -.B \-\-version -Show the version number of -.B nm -and exit. +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH NM.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" +nm \- list symbols from object files +.SH "SYNOPSIS" +nm [ \-a | --debug-syms ] [ \-g | --extern-only ] + [ \-B ] [ \-C | --demangle[=\fIstyle\fR] ] [ \-D | --dynamic ] + [ \-s | --print-armap ] [ \-A | \-o | --print-file-name ] + [ \-n | \-v | --numeric-sort ] [ \-p | --no-sort ] + [ \-r | --reverse-sort ] [ --size-sort ] [ \-u | --undefined-only ] + [ \-t \fIradix\fR | --radix=\fIradix\fR ] [ \-P | --portability ] + [ --target=\fIbfdname\fR ] [ \-f \fIformat\fR | --format=\fIformat\fR ] + [ --defined-only ] [\-l | --line-numbers ] [ --no-demangle ] + [ \-V | --version ] [ \-X 32_64 ] [ --help ] [ \fIobjfile\fR... ] +.SH "DESCRIPTION" +GNU \f(CWnm\fR lists the symbols from object files \fIobjfile\fR.... +If no object files are listed as arguments, \f(CWnm\fR assumes the file +\fIa.out\fR. +.PP +For each symbol, \f(CWnm\fR shows: +.Ip "\(bu" 4 +The symbol value, in the radix selected by options (see below), or +hexadecimal by default. +.Ip "\(bu" 4 +The symbol type. At least the following types are used; others are, as +well, depending on the object file format. If lowercase, the symbol is +local; if uppercase, the symbol is global (external). +.Ip "\f(CWA\fR" 8 +The symbol's value is absolute, and will not be changed by further +linking. +.Ip "\f(CWB\fR" 8 +The symbol is in the uninitialized data section (known as \s-1BSS\s0). +.Ip "\f(CWC\fR" 8 +The symbol is common. Common symbols are uninitialized data. When +linking, multiple common symbols may appear with the same name. If the +symbol is defined anywhere, the common symbols are treated as undefined +references. +.SH "OPTIONS" +.SH "SEE ALSO" +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. +.Sp +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". -.TP -.B \-\-help -Show a summary of the options to -.B nm -and exit. +.rn }` '' +.IX Title "NM.1 1" +.IX Name "nm - list symbols from object files" -.SH "SEE ALSO" -.RB "`\|" binutils "\|'" -entry in -.B -info\c -\&; -.I -The GNU Binary Utilities\c -\&, Roland H. Pesch (October 1991); -.BR ar "(" 1 ")," -.BR objdump ( 1 ), -.BR ranlib "(" 1 ")." +.IX Header "NAME" +.IX Header "SYNOPSIS" -.SH COPYING -Copyright (c) 1991, 2000 Free Software Foundation, Inc. -.PP -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. +.IX Header "DESCRIPTION" -\" .SH GNU Free Documentation License -\" Version 1.1, March 2000 +.IX Item "\(bu" -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP +.IX Item "\(bu" -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP +.IX Item "\f(CWA\fR" -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP +.IX Item "\f(CWB\fR" -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP +.IX Item "\f(CWC\fR" -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP +.IX Header "OPTIONS" -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP +.IX Header "SEE ALSO" -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP +.IX Header "COPYRIGHT" -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. diff --git a/binutils/objcopy.1 b/binutils/objcopy.1 index 6535eab..2e52d08 100644 --- a/binutils/objcopy.1 +++ b/binutils/objcopy.1 @@ -1,701 +1,633 @@ -.\" Copyright 1991, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000 -.\" Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH objcopy 1 "05 April 2000" "Free Software Foundation" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.10 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp +.if t .sp .5v +.if n .sp .. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R -.SH NAME +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH OBJCOPY.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" objcopy \- copy and translate object files - -.SH SYNOPSIS -.hy 0 -.na -.TP -.B objcopy -.RB "[\|" \-F\ \fIbfdname\fR\ |\ \fB\-\-target=\fIbfdname\fR "\|]" -.RB "[\|" \-I\ \fIbfdname\fR\ |\ \fB\-\-input\-target=\fIbfdname\fR "\|]" -.RB "[\|" \-O\ \fIbfdname\fR\ |\ \fB\-\-output\-target=\fIbfdname\fR "\|]" -.RB "[\|" \-j\ \fIsectionname\fR\ |\ \fB\-\-only\-section=\fIsectionname\fR "\|]" -.RB "[\|" \-R\ \fIsectionname\fR\ |\ \fB\-\-remove\-section=\fIsectionname\fR "\|]" -.RB "[\|" \-S\fR\ |\ \fB\-\-strip\-all\fR "\|]" -.RB "[\|" \-g\fR\ |\ \fB\-\-strip\-debug\fR "\|]" -.RB "[\|" \-\-strip\-unneeded\fR "\|]" -.RB "[\|" \-K\ \fIsymbolname\fR\ |\ \fB\-\-keep\-symbol=\fIsymbolname\fR "\|]" -.RB "[\|" \-N\ \fIsymbolname\fR\ |\ \fB\-\-strip\-symbol=\fIsymbolname\fR "\|]" -.RB "[\|" \-L\ \fIsymbolname\fR\ |\ \fB\-\-localize\-symbol=\fIsymbolname\fR "\|]" -.RB "[\|" \-W\ \fIsymbolname\fR\ |\ \fB\-\-weaken\-symbol=\fIsymbolname\fR "\|]" -.RB "[\|" \-x\fR\ |\ \fB\-\-discard\-all\fR "\|]" -.RB "[\|" \-X\fR\ |\ \fB\-\-discard\-locals\fR "\|]" -.RB "[\|" \-b\ \fIbyte\fR\ |\ \fB\-\-byte=\fIbyte\fR "\|]" -.RB "[\|" \-i\ \fIinterleave\fR\ |\ \fB\-\-interleave=\fIinterleave\fR "\|]" -.RB "[\|" \-p\fR\ |\ \fB\-\-preserve\-dates\fR "\|]" -.RB "[\|" \-\-debugging "\|]" -.RB "[\|" \-\-gap\-fill=\fIval\fR "\|]" -.RB "[\|" \-\-pad\-to=\fIaddress\fR "\|]" -.RB "[\|" \-\-set\-start=\fIval\fR "\|]" -.RB "[\|" \-\-change\-start=\fIincr\fR "\|]" -.RB "[\|" \-\-change\-addresses=\fIincr\fR "\|]" -.RB "[\|" \-\-change\-section\-address\ \fIsection{=,+,-}val\fR "\|]" -.RB "[\|" \-\-change\-section\-lma\ \fIsection{=,+,-}val\fR "\|]" -.RB "[\|" \-\-change\-section\-vma\ \fIsection{=,+,-}val\fR "\|]" -.RB "[\|" \-\-change\-warnings\fR "\|]" -.RB "[\|" \-\-no\-change\-warnings\fR "\|]" -.RB "[\|" \-\-set\-section\-flags\ \fIsection=flags\fR "\|]" -.RB "[\|" \-\-add\-section\ \fIsectionname=filename\fR "\|]" -.RB "[\|" \-\-change\-leading\-char\fR "\|]" -.RB "[\|" \-\-remove\-leading\-char\fR "\|]" -.RB "[\|" \-\-srec\-len=\fIval\fR "\|]" -.RB "[\|" \-\-srec\-forceS3\fR "\|]" -.RB "[\|" \-\-redefine\-sym\ \fIold=new\fR "\|]" -.RB "[\|" \-\-weaken\fR "\|]" -.RB "[\|" \-v\ |\ \-\-verbose\fR "\|]" -.RB "[\|" \-V\ |\ \-\-version\fR "\|]" -.RB "[\|" \-\-help\fR "\|]" -.B infile -.RB "[\|" outfile\fR "\|]" -.SH DESCRIPTION -The GNU -.B objcopy -utility copies the contents of an object file to another. -.B objcopy -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 -.B objcopy -is controlled by command-line options. +.SH "SYNOPSIS" +objcopy [ \-F \fIbfdname\fR | --target=\fIbfdname\fR ] + [ \-I \fIbfdname\fR | --input-target=\fIbfdname\fR ] + [ \-O \fIbfdname\fR | --output-target=\fIbfdname\fR ] + [ \-B \fIbfdarch\fR | --binary-architecture=\fIbfdarch\fR ] + [ \-S | --strip-all ] [ \-g | --strip-debug ] + [ \-K \fIsymbolname\fR | --keep-symbol=\fIsymbolname\fR ] + [ \-N \fIsymbolname\fR | --strip-symbol=\fIsymbolname\fR ] + [ \-L \fIsymbolname\fR | --localize-symbol=\fIsymbolname\fR ] + [ \-W \fIsymbolname\fR | --weaken-symbol=\fIsymbolname\fR ] + [ \-x | --discard-all ] [ \-X | --discard-locals ] + [ \-b \fIbyte\fR | --byte=\fIbyte\fR ] + [ \-i \fIinterleave\fR | --interleave=\fIinterleave\fR ] + [ \-j \fIsectionname\fR | --only-section=\fIsectionname\fR ] + [ \-R \fIsectionname\fR | --remove-section=\fIsectionname\fR ] + [ \-p | --preserve-dates ] [ --debugging ] + [ --gap-fill=\fIval\fR ] [ --pad-to=\fIaddress\fR ] + [ --set-start=\fIval\fR ] [ --adjust-start=\fIincr\fR ] + [ --change-addresses=\fIincr\fR ] + [ --change-section-address \fIsection\fR{=,+,\-}\fIval\fR ] + [ --change-section-lma \fIsection\fR{=,+,\-}\fIval\fR ] + [ --change-section-vma \fIsection\fR{=,+,\-}\fIval\fR ] + [ --change-warnings ] [ --no-change-warnings ] + [ --set-section-flags \fIsection\fR=\fIflags\fR ] + [ --add-section \fIsectionname\fR=\fIfilename\fR ] + [ --change-leading-char ] [ --remove-leading-char ] + [ --srec-len=\fIival\fR ] [ --srec-forceS3 ] + [ --redefine-sym \fIold\fR=\fInew\fR ] [ --weaken ] + [ \-v | --verbose ] [ \-V | --version ] [ --help ] + \fIinfile\fR [\fIoutfile\fR] +.SH "DESCRIPTION" +The GNU \f(CWobjcopy\fR utility copies the contents of an object +file to another. \f(CWobjcopy\fR 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 \f(CWobjcopy\fR is controlled by command-line options. +Note that \f(CWobjcopy\fR should be able to copy a fully linked file +between any two formats. However, copying a relocatable object file +between any two formats may not work as expected. .PP -.B objcopy -creates temporary files to do its translations and deletes them -afterward. -.B objcopy -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. +\f(CWobjcopy\fR creates temporary files to do its translations and +deletes them afterward. \f(CWobjcopy\fR uses BFD to do all its +translation work; it has access to all the formats described in BFD +and thus is able to recognize most formats without being told +explicitly. .PP -.B objcopy -can be used to generate S-records by using an output target of -.B srec -(e.g., use -.B -O srec). +\f(CWobjcopy\fR can be used to generate S\-records by using an output +target of \fBsrec\fR (e.g., use \fB\-O srec\fR). .PP -.B objcopy -can be used to generate a raw binary file by using an output target of -.B binary -(e.g., use -.B -O binary). -When -.B objcopy -generates a raw binary file, it will essentially produce a memory dump -of the contents of the input object file. All symbols and relocation -information will be discarded. The memory dump will start at the -virtual address of the lowest section copied into the output file. +\f(CWobjcopy\fR can be used to generate a raw binary file by using an +output target of \fBbinary\fR (e.g., use \fB\-O binary\fR). When +\f(CWobjcopy\fR generates a raw binary file, it will essentially produce +a memory dump of the contents of the input object file. All symbols and +relocation information will be discarded. The memory dump will start at +the load address of the lowest section copied into the output file. .PP -When generating an S-record or a raw binary file, it may be helpful to -use -.B -S -to remove sections containing debugging information. In some cases -.B -R -will be useful to remove sections which contain information which is -not needed by the binary file. +When generating an S\-record or a raw binary file, it may be helpful to +use \fB\-S\fR to remove sections containing debugging information. In +some cases \fB\-R\fR will be useful to remove sections which contain +information that is not needed by the binary file. .PP -.I infile -and -.I outfile -are the source and output files respectively. If you do not specify -.IR outfile , -.B objcopy -creates a temporary file and destructively renames the result with the -name of the input file. - -.SH OPTIONS -.TP -.B \-I \fIbfdname\fR, \fB\-\-input\-target=\fIbfdname -Consider the source file's object format to be -.IR bfdname , -rather than attempting to deduce it. -.TP -.B \-O \fIbfdname\fR, \fB\-\-output\-target=\fIbfdname -Write the output file using the object format -.IR bfdname . -.TP -.B \-F \fIbfdname\fR, \fB\-\-target=\fIbfdname -Use -.I bfdname -as the object format for both the input and the output file; i.e. -simply transfer data from source to destination with no translation. -.TP -.B \-j \fIsectionname\fR, \fB\-\-only\-section=\fIsectionname -Copy only the named section from the input file to the output file, -discarding all other sections. This option may be given more than -once. Note that using this option inappropriately may make the output -file unusable. -.TP -.B \-R \fIsectionname\fR, \fB\-\-remove-section=\fIsectionname -Remove the named section from the file. This option may be given more -than once. Note that using this option inappropriately may make the -output file unusable. -.TP -.B \-S\fR, \fB\-\-strip\-all +Note \- \f(CWobjcopy\fR is not able to change the endianness of its input +files. If the input format has an endianness, (some formats do not), +\f(CWobjcopy\fR can only copy the inputs into file formats that have the +same endianness or which have no endianness (eg \fBsrec\fR). +.SH "OPTIONS" +.Ip "\f(CW\fIinfile\fR\fR" 4 +.Ip "\f(CW\fIoutfile\fR\fR" 4 +The input and output files, respectively. +If you do not specify \fIoutfile\fR, \f(CWobjcopy\fR creates a +temporary file and destructively renames the result with +the name of \fIinfile\fR. +.Ip "\f(CW-I \fIbfdname\fR \fR" 4 +.Ip "\f(CW--input-target=\fIbfdname\fR\fR" 4 +Consider the source file's object format to be \fIbfdname\fR, rather than +attempting to deduce it. +.Ip "\f(CW-O \fIbfdname\fR\fR" 4 +.Ip "\f(CW--output-target=\fIbfdname\fR\fR" 4 +Write the output file using the object format \fIbfdname\fR. +.Ip "\f(CW-F \fIbfdname\fR\fR" 4 +.Ip "\f(CW--target=\fIbfdname\fR\fR" 4 +Use \fIbfdname\fR as the object format for both the input and the output +file; i.e., simply transfer data from source to destination with no +translation. +.Ip "\f(CW-B \fIbfdarch\fR\fR" 4 +.Ip "\f(CW--binary-architecture=\fIbfdarch\fR\fR" 4 +Useful when transforming a raw binary input file into an object file. +In this case the output architecture can be set to \fIbfdarch\fR. This +option will be ignored if the input file has a known \fIbfdarch\fR. You +can access this binary data inside a program by referencing the special +symbols that are created by the conversion process. These symbols are +called _binary_\fIobjfile\fR_start, _binary_\fIobjfile\fR_end and +_binary_\fIobjfile\fR_size. e.g. you can transform a picture file into +an object file and then access it in your code using these symbols. +.Ip "\f(CW-j \fIsectionname\fR\fR" 4 +.Ip "\f(CW--only-section=\fIsectionname\fR\fR" 4 +Copy only the named section from the input file to the output file. +This option may be given more than once. Note that using this option +inappropriately may make the output file unusable. +.Ip "\f(CW-R \fIsectionname\fR\fR" 4 +.Ip "\f(CW--remove-section=\fIsectionname\fR\fR" 4 +Remove any section named \fIsectionname\fR from the output file. This +option may be given more than once. Note that using this option +inappropriately may make the output file unusable. +.Ip "\f(CW-S\fR" 4 +.Ip "\f(CW--strip-all\fR" 4 Do not copy relocation and symbol information from the source file. -.TP -.B \-g\fR, \fB\-\-strip\-debug +.Ip "\f(CW-g\fR" 4 +.Ip "\f(CW--strip-debug\fR" 4 Do not copy debugging symbols from the source file. -.TP -.B \-\-strip\-unneeded +.Ip "\f(CW--strip-unneeded\fR" 4 Strip all symbols that are not needed for relocation processing. -.TP -.B \-K \fIsymbolname\fR, \fB\-\-keep\-symbol=\fIsymbolname -Copy only symbol \fIsymbolname\fP from the source file. This option +.Ip "\f(CW-K \fIsymbolname\fR\fR" 4 +.Ip "\f(CW--keep-symbol=\fIsymbolname\fR\fR" 4 +Copy only symbol \fIsymbolname\fR from the source file. This option may +be given more than once. +.Ip "\f(CW-N \fIsymbolname\fR\fR" 4 +.Ip "\f(CW--strip-symbol=\fIsymbolname\fR\fR" 4 +Do not copy symbol \fIsymbolname\fR from the source file. This option may be given more than once. -.TP -.B \-N \fIsymbolname\fR, \fB\-\-strip\-symbol=\fIsymbolname -Do not copy symbol \fIsymbolname\fP from the source file. This option -may be given more than once. -.TP -.B \-L \fIsymbolname\fR, \fB\-\-localize\-symbol=\fIsymbolname -Make symbol \fIsymbolname\fP local to the file, so that it is not +.Ip "\f(CW-L \fIsymbolname\fR\fR" 4 +.Ip "\f(CW--localize-symbol=\fIsymbolname\fR\fR" 4 +Make symbol \fIsymbolname\fR local to the file, so that it is not visible externally. This option may be given more than once. -.TP -.B \-W \fIsymbolname\fR, \fB\-\-weaken\-symbol=\fIsymbolname -Make symbol \fIsymbolname\fP weak. This option may be given more than once. -.TP -.B \-x\fR, \fB\-\-discard\-all +.Ip "\f(CW-W \fIsymbolname\fR\fR" 4 +.Ip "\f(CW--weaken-symbol=\fIsymbolname\fR\fR" 4 +Make symbol \fIsymbolname\fR weak. This option may be given more than once. +.Ip "\f(CW-x\fR" 4 +.Ip "\f(CW--discard-all\fR" 4 Do not copy non-global symbols from the source file. -.TP -.B \-X\fR, \fB\-\-discard\-locals -Do not copy compiler-generated local symbols. (These usually start -with "L" or "."). -.TP -.B \-b \fIbyte\fR, \fB\-\-byte=\fIbyte -Keep only every \fIbyte\fPth byte of the input file (header data is -not affected). \fIbyte\fP can be in the range from 0 to the -interleave-1. This option is useful for creating files to program -ROMs. It is typically used with an srec output target. -.TP -.B \-i \fIinterleave\fR, \fB\-\-interleave=\fIinterleave -Only copy one out of every \fIinterleave\fP bytes. Which one to copy is -selected by the \fB\-b\fP or \fB\-\-byte\fP option. The default is 4. -The interleave is ignored if neither \fB\-b\fP nor \fB\-\-byte\fP is given. -.TP -.B \-p\fR, \fB\-\-preserve\-dates +.Ip "\f(CW-X\fR" 4 +.Ip "\f(CW--discard-locals\fR" 4 +Do not copy compiler-generated local symbols. +(These usually start with \fBL\fR or \fB.\fR.) +.Ip "\f(CW-b \fIbyte\fR\fR" 4 +.Ip "\f(CW--byte=\fIbyte\fR\fR" 4 +Keep only every \fIbyte\fRth byte of the input file (header data is not +affected). \fIbyte\fR can be in the range from 0 to \fIinterleave\fR\-1, +where \fIinterleave\fR is given by the \fB\-i\fR or \fB--interleave\fR +option, or the default of 4. This option is useful for creating files +to program \s-1ROM\s0. It is typically used with an \f(CWsrec\fR output +target. +.Ip "\f(CW-i \fIinterleave\fR\fR" 4 +.Ip "\f(CW--interleave=\fIinterleave\fR\fR" 4 +Only copy one out of every \fIinterleave\fR bytes. Select which byte to +copy with the \fI\-b\fR or \fB--byte\fR option. The default is 4. +\f(CWobjcopy\fR ignores this option if you do not specify either \fB\-b\fR or +\fB--byte\fR. +.Ip "\f(CW-p\fR" 4 +.Ip "\f(CW--preserve-dates\fR" 4 Set the access and modification dates of the output file to be the same as those of the input file. -.TP -.B \-\-debugging +.Ip "\f(CW--debugging\fR" 4 Convert debugging information, if possible. This is not the default because only certain debugging formats are supported, and the conversion process can be time consuming. -.TP -.B \-\-gap\-fill=\fIval -Fill gaps between sections with \fIval\fP. This operation applies to -the \fIload address\fP (LMA) of the sections. It is done by increasing +.Ip "\f(CW--gap-fill \fIval\fR\fR" 4 +Fill gaps between sections with \fIval\fR. This operation applies to +the \fIload address\fR (\s-1LMA\s0) of the sections. It is done by increasing the size of the section with the lower address, and filling in the extra -space created with \fIval\fP. -.TP -.B \-\-pad\-to=\fIaddress -Pad the output file up to the load address \fIaddress\fP. This is +space created with \fIval\fR. +.Ip "\f(CW--pad-to \fIaddress\fR\fR" 4 +Pad the output file up to the load address \fIaddress\fR. This is done by increasing the size of the last section. The extra space is -filled in with the value specified by \fB\-\-gap\-fill\fP (default -zero). -.TP -.B \fB\-\-set\-start=\fIval -Set the start address of the new file to \fIval\fP. Not all object -file formats support setting the start address. -.TP -.B \fB\-\-change\-start=\fIincr\fR, \fB\-\-adjust\-start=\fIincr -Changes the start address by adding \fIincr\fP. Not all object file +filled in with the value specified by \fB--gap-fill\fR (default zero). +.Ip "\f(CW--set-start \fIval\fR\fR" 4 +Set the start address of the new file to \fIval\fR. Not all object file +formats support setting the start address. +.Ip "\f(CW--change-start \fIincr\fR\fR" 4 +.Ip "\f(CW--adjust-start \fIincr\fR\fR" 4 +Change the start address by adding \fIincr\fR. Not all object file formats support setting the start address. -.TP -.B \fB\-\-change\-addresses=\fIincr\fR, \fB\-\-adjust\-vma=\fIincr -Changes the address of all sections, as well as the start address, by -adding \fIincr\fP. Some object file formats do not permit section -addresses to be changed arbitrarily. Note that this does not relocate -the sections; if the program expects sections to be loaded at a +.Ip "\f(CW--change-addresses \fIincr\fR\fR" 4 +.Ip "\f(CW--adjust-vma \fIincr\fR\fR" 4 +Change the \s-1VMA\s0 and \s-1LMA\s0 addresses of all sections, as well as the start +address, by adding \fIincr\fR. Some object file formats do not permit +section addresses to be changed arbitrarily. Note that this does not +relocate the sections; if the program expects sections to be loaded at a certain address, and this option is used to change the sections such -that they are loaded at a different address, the program may fail. -.TP -.B \fB\-\-change\-section\-address\ \fIsection{=,+,-}val\fR, \fB\-\-adjust\-section\-vma\ \fIsection{=,+,-}val -Set or changes the VMA and LMA addresses of the named \fIsection\fP. -If \fI=\fP is used, the section address is set to \fIval\fP. -Otherwise, \fIval\fP is added to or subtracted from the section -address. See the comments under \fB\-\-change\-addresses\fP, above. If -\fIsection\fP does not exist in the input file, a warning will be -issued, unless \fB\-\-no\-change\-warnings\fP is used. -.TP -.B \fB\-\-change\-section\-lma\ \fIsection{=,+,-}val -Set or change the LMA address of the named \fIsection\fP. If \fI=\fP is -used, the section address is set to \fIval\fP. Otherwise, \fIval\fP -is added to or subtracted from the section address. See the comments -under \fB\-\-change\-addresses\fP, above. If \fIsection\fP does not exist -in the input file, a warning will be issued, unless -\fB\-\-no\-change\-warnings\fP is used. -.TP -.B \fB\-\-change\-section\-vma\ \fIsection{=,+,-}val -Set or change the VMA address of the named \fIsection\fP. If \fI=\fP is -used, the section address is set to \fIval\fP. Otherwise, \fIval\fP -is added to or subtracted from the section address. See the comments -under \fB\-\-change\-addresses\fP, above. If \fIsection\fP does not exist -in the input file, a warning will be issued, unless -\fB\-\-no\-change\-warnings\fP is used. -.TP -.B \fB\-\-change\-warnings\fR, \fB\-\-adjust\-warnings -If \fB\-\-change\-section\-XXX\fP is used, and the named section does -not exist, issue a warning. This is the default. -.TP -.B \fB\-\-no\-change\-warnings\fR, \fB\-\-no\-adjust\-warnings -Do not issue a warning if \fB\-\-change\-section\-XXX\fP is used, even -if the named section does not exist. -.TP -.B \fB\-\-set\-section\-flags\ \fIsection=flags -Set the flags for the named section. The \fIflags\fP argument is a +that they are loaded at a different address, the program may fail. +.Ip "\f(CW--change-section-address \fIsection\fR{=,+,-}\fIval\fR\fR" 4 +.Ip "\f(CW--adjust-section-vma \fIsection\fR{=,+,-}\fIval\fR\fR" 4 +Set or change both the \s-1VMA\s0 address and the \s-1LMA\s0 address of the named +\fIsection\fR. If \fB=\fR is used, the section address is set to +\fIval\fR. Otherwise, \fIval\fR is added to or subtracted from the +section address. See the comments under \fB--change-addresses\fR, +above. If \fIsection\fR does not exist in the input file, a warning will +be issued, unless \fB--no-change-warnings\fR is used. +.Ip "\f(CW--change-section-lma \fIsection\fR{=,+,-}\fIval\fR\fR" 4 +Set or change the \s-1LMA\s0 address of the named \fIsection\fR. The \s-1LMA\s0 +address is the address where the section will be loaded into memory at +program load time. Normally this is the same as the \s-1VMA\s0 address, which +is the address of the section at program run time, but on some systems, +especially those where a program is held in \s-1ROM\s0, the two can be +different. If \fB=\fR is used, the section address is set to +\fIval\fR. Otherwise, \fIval\fR is added to or subtracted from the +section address. See the comments under \fB--change-addresses\fR, +above. If \fIsection\fR does not exist in the input file, a warning +will be issued, unless \fB--no-change-warnings\fR is used. +.Ip "\f(CW--change-section-vma \fIsection\fR{=,+,-}\fIval\fR\fR" 4 +Set or change the \s-1VMA\s0 address of the named \fIsection\fR. The \s-1VMA\s0 +address is the address where the section will be located once the +program has started executing. Normally this is the same as the \s-1LMA\s0 +address, which is the address where the section will be loaded into +memory, but on some systems, especially those where a program is held in +\s-1ROM\s0, the two can be different. If \fB=\fR is used, the section address +is set to \fIval\fR. Otherwise, \fIval\fR is added to or subtracted +from the section address. See the comments under +\fB--change-addresses\fR, above. If \fIsection\fR does not exist in +the input file, a warning will be issued, unless +\fB--no-change-warnings\fR is used. +.Ip "\f(CW--change-warnings\fR" 4 +.Ip "\f(CW--adjust-warnings\fR" 4 +If \fB--change-section-address\fR or \fB--change-section-lma\fR or +\fB--change-section-vma\fR is used, and the named section does not +exist, issue a warning. This is the default. +.Ip "\f(CW--no-change-warnings\fR" 4 +.Ip "\f(CW--no-adjust-warnings\fR" 4 +Do not issue a warning if \fB--change-section-address\fR or +\fB--adjust-section-lma\fR or \fB--adjust-section-vma\fR is used, even +if the named section does not exist. +.Ip "\f(CW--set-section-flags \fIsection\fR=\fIflags\fR\fR" 4 +Set the flags for the named section. The \fIflags\fR argument is a comma separated string of flag names. The recognized names are -\fIalloc\fP, \fIcontents\fP, \fIload\fP, \fInoload\fP, \fIreadonly\fP, -\fIcode\fP, \fIdata\fP, \fIrom\fP, \fIshare\fP, and \fIdebug\fP. Not -all flags are meaningful for all object file formats. -.TP -.B \fB\-\-add\-section\ \fIsectionname=filename +\fBalloc\fR, \fBcontents\fR, \fBload\fR, \fBnoload\fR, +\fBreadonly\fR, \fBcode\fR, \fBdata\fR, \fBrom\fR, \fBshare\fR, and +\fBdebug\fR. You can set the \fBcontents\fR flag for a section which +does not have contents, but it is not meaningful to clear the +\fBcontents\fR flag of a section which does have contents\*(--just remove +the section instead. Not all flags are meaningful for all object file +formats. +.Ip "\f(CW--add-section \fIsectionname\fR=\fIfilename\fR\fR" 4 Add a new section named \fIsectionname\fR while copying the file. The -contents of the new section are taken from the file \fIfilename\fR. -The size of the section will be the size of the file. This option -only works on file formats which can support sections with arbitrary -names. -.TP -.B \-\-change\-leading\-char +contents of the new section are taken from the file \fIfilename\fR. The +size of the section will be the size of the file. This option only +works on file formats which can support sections with arbitrary names. +.Ip "\f(CW--change-leading-char\fR" 4 Some object file formats use special characters at the start of symbols. The most common such character is underscore, which compilers -often add before every symbol. This option tells -.B objcopy -to change the leading character of every symbol when it converts -between object file formats. If the object file formats use the same -leading character, this option has no effect. Otherwise, it will add -a character, or remove a character, or change a character, as +often add before every symbol. This option tells \f(CWobjcopy\fR to +change the leading character of every symbol when it converts between +object file formats. If the object file formats use the same leading +character, this option has no effect. Otherwise, it will add a +character, or remove a character, or change a character, as appropriate. -.TP -.B \-\-remove\-leading\-char +.Ip "\f(CW--remove-leading-char\fR" 4 If the first character of a global symbol is a special symbol leading character used by the object file format, remove the character. The most common symbol leading character is underscore. This option will -remove a leading underscore from all global symbols. This can be -useful if you want to link together objects of different file formats -with different conventions for symbol names. This is different from -\fB\-\-change\-leading\-char\fP because it always changes the symbol name +remove a leading underscore from all global symbols. This can be useful +if you want to link together objects of different file formats with +different conventions for symbol names. This is different from +\f(CW--change-leading-char\fR because it always changes the symbol name when appropriate, regardless of the object file format of the output -.TP -.B \fB\-\-srec\-len=\fIval -Meaningful only for srec output. Set the length of the Srecords to \fIval\fP. -This length covers both the address, data and crc fields. -.TP -.B \fB\-\-srec\-forceS3 -Meaningful only for srec output. Avoid generation of S1/S2 records, creating -S3-only record format. -.TP -.B \-\-redefine\-sym\ \fIold=new -Change the name of symbol \fIold\fR to \fInew\fR. This can be useful +file. +.Ip "\f(CW--srec-len=\fIival\fR\fR" 4 +Meaningful only for srec output. Set the maximum length of the Srecords +being produced to \fIival\fR. This length covers both address, data and +crc fields. +.Ip "\f(CW--srec-forceS3\fR" 4 +Meaningful only for srec output. Avoid generation of S1/S2 records, +creating S3-only record format. +.Ip "\f(CW--redefine-sym \fIold\fR=\fInew\fR\fR" 4 +Change the name of a symbol \fIold\fR, to \fInew\fR. This can be useful when one is trying link two things together for which you have no source, and there are name collisions. -.TP -.B \-\-weaken -Change all global symbols in the file to be weak. -.TP -.B \-v\fR, \fB\-\-verbose +.Ip "\f(CW--weaken\fR" 4 +Change all global symbols in the file to be weak. This can be useful +when building an object which will be linked against other objects using +the \f(CW-R\fR option to the linker. This option is only effective when +using an object file format which supports weak symbols. +.Ip "\f(CW-V\fR" 4 +.Ip "\f(CW--version\fR" 4 +Show the version number of \f(CWobjcopy\fR. +.Ip "\f(CW-v\fR" 4 +.Ip "\f(CW--verbose\fR" 4 Verbose output: list all object files modified. In the case of -archives, "\fBobjcopy \-V\fR" lists all members of the archive. -.TP -.B \-V\fR, \fB\-\-version -Show the version number of -.B objcopy -and exit. -.TP -.B \-\-help -Show a summary of the options to -.B objcopy -and exit. +archives, \fBobjcopy \-V\fR lists all members of the archive. +.Ip "\f(CW--help\fR" 4 +Show a summary of the options to \f(CWobjcopy\fR. .SH "SEE ALSO" -.RB "`\|" binutils "\|'" -entry in -.B -info\c -\&; -.I -The GNU Binary Utilities\c -\&, Roland H. Pesch (June 1993). - -.SH COPYING -Copyright (c) 1993, 94, 95, 96, 97, 98, 1999, 2000 Free Software Foundation, Inc. +\fIld\fR\|(1), \fIobjdump\fR\|(1), and the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. .PP -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. - -\" .SH GNU Free Documentation License -\" Version 1.1, March 2000 - -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP - -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP - -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP - -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP - -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP - -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP - -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP - -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". + +.rn }` '' +.IX Title "OBJCOPY.1 1" +.IX Name "objcopy - copy and translate object files" + +.IX Header "NAME" + +.IX Header "SYNOPSIS" + +.IX Header "DESCRIPTION" + +.IX Header "OPTIONS" + +.IX Item "\f(CW\fIinfile\fR\fR" + +.IX Item "\f(CW\fIoutfile\fR\fR" + +.IX Item "\f(CW-I \fIbfdname\fR \fR" + +.IX Item "\f(CW--input-target=\fIbfdname\fR\fR" + +.IX Item "\f(CW-O \fIbfdname\fR\fR" + +.IX Item "\f(CW--output-target=\fIbfdname\fR\fR" + +.IX Item "\f(CW-F \fIbfdname\fR\fR" + +.IX Item "\f(CW--target=\fIbfdname\fR\fR" + +.IX Item "\f(CW-B \fIbfdarch\fR\fR" + +.IX Item "\f(CW--binary-architecture=\fIbfdarch\fR\fR" + +.IX Item "\f(CW-j \fIsectionname\fR\fR" + +.IX Item "\f(CW--only-section=\fIsectionname\fR\fR" + +.IX Item "\f(CW-R \fIsectionname\fR\fR" + +.IX Item "\f(CW--remove-section=\fIsectionname\fR\fR" + +.IX Item "\f(CW-S\fR" + +.IX Item "\f(CW--strip-all\fR" + +.IX Item "\f(CW-g\fR" + +.IX Item "\f(CW--strip-debug\fR" + +.IX Item "\f(CW--strip-unneeded\fR" + +.IX Item "\f(CW-K \fIsymbolname\fR\fR" + +.IX Item "\f(CW--keep-symbol=\fIsymbolname\fR\fR" + +.IX Item "\f(CW-N \fIsymbolname\fR\fR" + +.IX Item "\f(CW--strip-symbol=\fIsymbolname\fR\fR" + +.IX Item "\f(CW-L \fIsymbolname\fR\fR" + +.IX Item "\f(CW--localize-symbol=\fIsymbolname\fR\fR" + +.IX Item "\f(CW-W \fIsymbolname\fR\fR" + +.IX Item "\f(CW--weaken-symbol=\fIsymbolname\fR\fR" + +.IX Item "\f(CW-x\fR" + +.IX Item "\f(CW--discard-all\fR" + +.IX Item "\f(CW-X\fR" + +.IX Item "\f(CW--discard-locals\fR" + +.IX Item "\f(CW-b \fIbyte\fR\fR" + +.IX Item "\f(CW--byte=\fIbyte\fR\fR" + +.IX Item "\f(CW-i \fIinterleave\fR\fR" + +.IX Item "\f(CW--interleave=\fIinterleave\fR\fR" + +.IX Item "\f(CW-p\fR" + +.IX Item "\f(CW--preserve-dates\fR" + +.IX Item "\f(CW--debugging\fR" + +.IX Item "\f(CW--gap-fill \fIval\fR\fR" + +.IX Item "\f(CW--pad-to \fIaddress\fR\fR" + +.IX Item "\f(CW--set-start \fIval\fR\fR" + +.IX Item "\f(CW--change-start \fIincr\fR\fR" + +.IX Item "\f(CW--adjust-start \fIincr\fR\fR" + +.IX Item "\f(CW--change-addresses \fIincr\fR\fR" + +.IX Item "\f(CW--adjust-vma \fIincr\fR\fR" + +.IX Item "\f(CW--change-section-address \fIsection\fR{=,+,-}\fIval\fR\fR" + +.IX Item "\f(CW--adjust-section-vma \fIsection\fR{=,+,-}\fIval\fR\fR" + +.IX Item "\f(CW--change-section-lma \fIsection\fR{=,+,-}\fIval\fR\fR" + +.IX Item "\f(CW--change-section-vma \fIsection\fR{=,+,-}\fIval\fR\fR" + +.IX Item "\f(CW--change-warnings\fR" + +.IX Item "\f(CW--adjust-warnings\fR" + +.IX Item "\f(CW--no-change-warnings\fR" + +.IX Item "\f(CW--no-adjust-warnings\fR" + +.IX Item "\f(CW--set-section-flags \fIsection\fR=\fIflags\fR\fR" + +.IX Item "\f(CW--add-section \fIsectionname\fR=\fIfilename\fR\fR" + +.IX Item "\f(CW--change-leading-char\fR" + +.IX Item "\f(CW--remove-leading-char\fR" + +.IX Item "\f(CW--srec-len=\fIival\fR\fR" + +.IX Item "\f(CW--srec-forceS3\fR" + +.IX Item "\f(CW--redefine-sym \fIold\fR=\fInew\fR\fR" + +.IX Item "\f(CW--weaken\fR" + +.IX Item "\f(CW-V\fR" + +.IX Item "\f(CW--version\fR" + +.IX Item "\f(CW-v\fR" + +.IX Item "\f(CW--verbose\fR" + +.IX Item "\f(CW--help\fR" + +.IX Header "SEE ALSO" + +.IX Header "COPYRIGHT" + diff --git a/binutils/objdump.1 b/binutils/objdump.1 index 1807534..d43cd48 100644 --- a/binutils/objdump.1 +++ b/binutils/objdump.1 @@ -1,772 +1,580 @@ -.\" Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000 -.\" Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH objdump 1 "5 November 1991" "Free Software Foundation" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.5 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 .. +.de Ve +.ft R -.SH NAME +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH OBJDUMP.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" objdump \- display information from object files. - -.SH SYNOPSIS -.hy 0 -.na -.TP -.B objdump -.RB "[\|" \-a | \-\-archive\-headers "\|]" -.RB "[\|" "\-b\ "\c -.I bfdname\c -.RB " | " "\-\-target="\c -.I bfdname\c -\&\|] -.RB "[\|" \-C | \-\-demangle "\|]" -.RB "[\|" \-\-debugging "\|]" -.RB "[\|" \-d | \-\-disassemble "\|]" -.RB "[\|" \-D | \-\-disassemble-all "\|]" -.RB "[\|" \-\-disassemble\-zeroes "\|]" -.RB "[\|" \-EB | \-EL | \-\-endian=\c -.I {big|little}\c -\&\|] -.RB "[\|" \-f | \-\-file\-headers "\|]" -.RB "[\|" \-h | \-\-section\-headers -.RB "| " \-\-headers "\|]" -.RB "[\|" \-i | \-\-info "\|]" -.RB "[\|" "\-j\ "\c -.I section\c -.RB " | " "\-\-section="\c -.I section\c -\&\|] -.RB "[\|" \-l | \-\-line\-numbers "\|]" -.RB "[\|" "\-m\ "\c -.I machine\c -.RB " | " "\-\-architecture="\c -.I machine\c -\&\|] -.RB "[\|" \-p | \-\-private\-headers "\|]" -.RB "[\|" \-\-prefix\-addresses "\|]" -.RB "[\|" \-r | \-\-reloc "\|]" -.RB "[\|" \-R | \-\-dynamic\-reloc "\|]" -.RB "[\|" \-s | \-\-full\-contents "\|]" -.RB "[\|" \-S | \-\-source "\|]" -.RB "[\|" \-\-[no\-]show\-raw\-insn "\|]" -.RB "[\|" \-\-stabs "\|]" -.RB "[\|" \-t | \-\-syms "\|]" -.RB "[\|" \-T | \-\-dynamic\-syms "\|]" -.RB "[\|" \-x | \-\-all\-headers "\|]" -.RB "[\|" "\-\-start\-address="\c -.I address\c -\&\|] -.RB "[\|" "\-\-stop\-address="\c -.I address\c -\&\|] -.RB "[\|" "\-\-adjust\-vma="\c -.I offset\c -\&\|] -.RB "[\|" \-\-version "\|]" -.RB "[\|" \-\-help "\|]" -.I objfile\c -\&.\|.\|. -.ad b -.hy 1 -.SH DESCRIPTION -\c -.B objdump\c -\& displays information about one or more object files. +.SH "SYNOPSIS" +objdump [ \-a | --archive-headers ] + [ \-b \fIbfdname\fR | --target=\fIbfdname\fR ] + [ \-C | --demangle[=\fIstyle\fR] ] + [ \-d | --disassemble ] + [ \-D | --disassemble-all ] + [ \-z | --disassemble-zeroes ] + [ \-EB | \-EL | --endian={big | little } ] + [ \-f | --file-headers ] + [ --file-start-context ] + [ \-g | --debugging ] + [ \-h | --section-headers | --headers ] + [ \-i | --info ] + [ \-j \fIsection\fR | --section=\fIsection\fR ] + [ \-l | --line-numbers ] + [ \-S | --source ] + [ \-m \fImachine\fR | --architecture=\fImachine\fR ] + [ \-M \fIoptions\fR | --disassembler-options=\fIoptions\fR] + [ \-p | --private-headers ] + [ \-r | --reloc ] + [ \-R | --dynamic-reloc ] + [ \-s | --full-contents ] + [ \-G | --stabs ] + [ \-t | --syms ] + [ \-T | --dynamic-syms ] + [ \-x | --all-headers ] + [ \-w | --wide ] + [ --start-address=\fIaddress\fR ] + [ --stop-address=\fIaddress\fR ] + [ --prefix-addresses] + [ --[no-]show-raw-insn ] + [ --adjust-vma=\fIoffset\fR ] + [ \-V | --version ] + [ \-H | --help ] + \fIobjfile\fR... +.SH "DESCRIPTION" +\f(CWobjdump\fR displays information about one or more object files. The options control what particular information to display. This information is mostly useful to programmers who are working on the compilation tools, as opposed to programmers who just want their program to compile and work. .PP -.IR "objfile" .\|.\|. -are the object files to be examined. When you specify archives, -\c -.B objdump\c -\& shows information on each of the member object files. - -.SH OPTIONS -Where long and short forms of an option are shown together, they are -equivalent. At least one option besides -.B \-l -(\fB\-\-line\-numbers\fP) must be given. - -.TP -.B \-a -.TP -.B \-\-archive\-headers -If any files from \c -.I objfile\c -\& are archives, display the archive -header information (in a format similar to `\|\c -.B ls \-l\c -\|'). Besides the -information you could list with `\|\c -.B ar tv\c -\|', `\|\c -.B objdump \-a\c -\|' shows +\fIobjfile\fR... are the object files to be examined. When you +specify archives, \f(CWobjdump\fR shows information on each of the member +object files. +.SH "OPTIONS" +The long and short forms of options, shown here as alternatives, are +equivalent. At least one option from the list +\fB\-a,\-d,\-D,\-f,\-g,\-G,\-h,\-H,\-p,\-r,\-R,\-S,\-t,\-T,\-V,\-x\fR must be given. +.Ip "\f(CW-a\fR" 4 +.Ip "\f(CW--archive-header\fR" 4 +If any of the \fIobjfile\fR files are archives, display the archive +header information (in a format similar to \fBls \-l\fR). Besides the +information you could list with \fBar tv\fR, \fBobjdump \-a\fR shows the object file format of each archive member. - -.TP -.BI "\-\-adjust\-vma=" "offset" -When dumping information, first add -.I offset -to all the section addresses. This is useful if the section addresses -do not correspond to the symbol table, which can happen when putting -sections at particular addresses when using a format which can not -represent section addresses, such as a.out. - -.TP -.BI "\-b " "bfdname"\c -.TP -.BI "\-\-target=" "bfdname" -Specify the object-code format for the object files to be -\c -.I bfdname\c -\&. This may not be necessary; \c -.I objdump\c -\& can -automatically recognize many formats. For example, -.sp -.br -objdump\ \-b\ oasys\ \-m\ vax\ \-h\ fu.o -.br -.sp -display summary information from the section headers (`\|\c -.B \-h\c -\|') of -`\|\c -.B fu.o\c -\|', which is explicitly identified (`\|\c -.B \-m\c -\|') as a Vax object +.Ip "\f(CW--adjust-vma=\fIoffset\fR\fR" 4 +When dumping information, first add \fIoffset\fR to all the section +addresses. This is useful if the section addresses do not correspond to +the symbol table, which can happen when putting sections at particular +addresses when using a format which can not represent section addresses, +such as a.out. +.Ip "\f(CW-b \fIbfdname\fR\fR" 4 +.Ip "\f(CW--target=\fIbfdname\fR\fR" 4 +Specify that the object-code format for the object files is +\fIbfdname\fR. This option may not be necessary; \fIobjdump\fR can +automatically recognize many formats. +.Sp +For example, + + objdump \-b oasys \-m vax \-h fu.o +.Sp +displays summary information from the section headers (\fB\-h\fR) of +\fIfu.o\fR, which is explicitly identified (\fB\-m\fR) as a \s-1VAX\s0 object file in the format produced by Oasys compilers. You can list the -formats available with the `\|\c -.B \-i\c -\|' option. - -.TP -.B \-C -.TP -.B \-\-demangle -Decode (\fIdemangle\fP) low-level symbol names into user-level names. +formats available with the \fB\-i\fR option. +.Ip "\f(CW-C\fR" 4 +.Ip "\f(CW--demangle[=\fIstyle\fR]\fR" 4 +Decode (\fIdemangle\fR) low-level symbol names into user-level names. Besides removing any initial underscore prepended by the system, this -makes C++ function names readable. - -.TP -.B \-\-debugging +makes \*(C+ function names readable. Different compilers have different +mangling styles. The optional demangling style argument can be used to +choose an appropriate demangling style for your compiler. +.Ip "\f(CW-G\fR" 4 +.Ip "\f(CW--debugging\fR" 4 Display debugging information. This attempts to parse debugging information stored in the file and print it out using a C like syntax. Only certain types of debugging information have been implemented. - -.TP -.B \-d -.TP -.B \-\-disassemble -Display the assembler mnemonics for the machine -instructions from \c -.I objfile\c -\&. -This option only disassembles those sections which are +.Ip "\f(CW-d\fR" 4 +.Ip "\f(CW--disassemble\fR" 4 +Display the assembler mnemonics for the machine instructions from +\fIobjfile\fR. This option only disassembles those sections which are expected to contain instructions. - -.TP -.B \-D -.TP -.B \-\-disassemble-all -Like \fB\-d\fP, but disassemble the contents of all sections, not just +.Ip "\f(CW-D\fR" 4 +.Ip "\f(CW--disassemble-all\fR" 4 +Like \fB\-d\fR, but disassemble the contents of all sections, not just those expected to contain instructions. - -.TP -.B \-\-prefix\-addresses +.Ip "\f(CW--prefix-addresses\fR" 4 When disassembling, print the complete address on each line. This is the older disassembly format. - -.TP -.B \-\-disassemble\-zeroes +.Ip "\f(CW--disassemble-zeroes\fR" 4 Normally the disassembly output will skip blocks of zeroes. This option directs the disassembler to disassemble those blocks, just like any other data. - -.TP -.B \-EB -.TP -.B \-EL -.TP -.BI "\-\-endian=" "{big|little}" +.Ip "\f(CW-EB\fR" 4 +.Ip "\f(CW-EL\fR" 4 +.Ip "\f(CW--endian={big|little}\fR" 4 Specify the endianness of the object files. This only affects disassembly. This can be useful when disassembling a file format which -does not describe endianness information, such as S-records. - -.TP -.B \-f -.TP -.B \-\-file\-headers +does not describe endianness information, such as S\-records. +.Ip "\f(CW-f\fR" 4 +.Ip "\f(CW--file-header\fR" 4 Display summary information from the overall header of -each file in \c -.I objfile\c -\&. - -.TP -.B \-h -.TP -.B \-\-section\-headers -.TP -.B \-\-headers +each of the \fIobjfile\fR files. +.Ip "\f(CW--file-start-context\fR" 4 +Specify that when displaying interlisted source code/disassembly +(assumes \*(L'\-S') from a file that has not yet been displayed, extend the +context to the start of the file. +.Ip "\f(CW-h\fR" 4 +.Ip "\f(CW--section-header\fR" 4 +.Ip "\f(CW--header\fR" 4 Display summary information from the section headers of the object file. - -.TP -.B \-\-help -Print a summary of the options to -.B objdump -and exit. - -.TP -.B \-i -.TP -.B \-\-info +.Sp +File segments may be relocated to nonstandard addresses, for example by +using the \fB\-Ttext\fR, \fB\-Tdata\fR, or \fB\-Tbss\fR options to +\f(CWld\fR. However, some object file formats, such as a.out, do not +store the starting address of the file segments. In those situations, +although \f(CWld\fR relocates the sections correctly, using \fBobjdump +\-h\fR to list the file section headers cannot show the correct addresses. +Instead, it shows the usual addresses, which are implicit for the +target. +.Ip "\f(CW--help\fR" 4 +Print a summary of the options to \f(CWobjdump\fR and exit. +.Ip "\f(CW-i\fR" 4 +.Ip "\f(CW--info\fR" 4 Display a list showing all architectures and object formats available -for specification with \c -.B \-b\c -\& or \c -.B \-m\c -\&. - -.TP -.BI "\-j " "name"\c -.TP -.BI "\-\-section=" "name" -Display information only for section \c -.I name\c -\&. - -.TP -.B \-l -.TP -.B \-\-line\-numbers -Label the display (using debugging information) with the filename -and source line numbers corresponding to the object code shown. -Only useful with \fB\-d\fP, \fB\-D\fP, or \fB\-r\fP. - -.TP -.BI "\-m " "machine"\c -.TP -.BI "\-\-architecture=" "machine" +for specification with \fB\-b\fR or \fB\-m\fR. +.Ip "\f(CW-j \fIname\fR\fR" 4 +.Ip "\f(CW--section=\fIname\fR\fR" 4 +Display information only for section \fIname\fR. +.Ip "\f(CW-l\fR" 4 +.Ip "\f(CW--line-numbers\fR" 4 +Label the display (using debugging information) with the filename and +source line numbers corresponding to the object code or relocs shown. +Only useful with \fB\-d\fR, \fB\-D\fR, or \fB\-r\fR. +.Ip "\f(CW-m \fImachine\fR\fR" 4 +.Ip "\f(CW--architecture=\fImachine\fR\fR" 4 Specify the architecture to use when disassembling object files. This can be useful when disassembling object files which do not describe -architecture information, such as S-records. You can list the available -architectures with the \fB\-i\fP option. - -.TP -.B \-p -.TP -.B \-\-private\-headers -Print information that is specific to the object file format. The -exact information printed depends upon the object file format. For -some object file formats, no additional information is printed. - -.TP -.B \-r -.TP -.B \-\-reloc -Print the relocation entries of the file. If used with \fB\-d\fP or -\fB\-D\fP, the relocations are printed interspersed with the +architecture information, such as S\-records. You can list the available +architectures with the \fB\-i\fR option. +.Ip "\f(CW-M \fIoptions\fR\fR" 4 +.Ip "\f(CW--disassembler-options=\fIoptions\fR\fR" 4 +Pass target specific information to the disassembler. Only supported on +some targets. +.Sp +If the target is an \s-1ARM\s0 architecture then this switch can be used to +select which register name set is used during disassembler. Specifying +\fB\-M reg-name-std\fR (the default) will select the register names as +used in \s-1ARM\s0's instruction set documentation, but with register 13 called +\&'sp\*(R', register 14 called \*(L'lr\*(R' and register 15 called \*(L'pc\*(R'. Specifying +\fB\-M reg-names-apcs\fR will select the name set used by the \s-1ARM\s0 +Procedure Call Standard, whilst specifying \fB\-M reg-names-raw\fR will +just use \fBr\fR followed by the register number. +.Sp +There are also two variants on the \s-1APCS\s0 register naming scheme enabled +by \fB\-M reg-names-atpcs\fR and \fB\-M reg-names-special-atpcs\fR which +use the \s-1ARM/\s0Thumb Procedure Call Standard naming conventions. (Eiuther +with the normal register name sor the special register names). +.Sp +This option can also be used for \s-1ARM\s0 architectures to force the +disassembler to interpret all instructions as \s-1THUMB\s0 instructions by +using the switch \fB--disassembler-options=force-thumb\fR. This can be +useful when attempting to disassemble thumb code produced by other +compilers. +.Ip "\f(CW-p\fR" 4 +.Ip "\f(CW--private-headers\fR" 4 +Print information that is specific to the object file format. The exact +information printed depends upon the object file format. For some +object file formats, no additional information is printed. +.Ip "\f(CW-r\fR" 4 +.Ip "\f(CW--reloc\fR" 4 +Print the relocation entries of the file. If used with \fB\-d\fR or +\fB\-D\fR, the relocations are printed interspersed with the disassembly. - -.TP -.B \-R -.TP -.B \-\-dynamic\-reloc +.Ip "\f(CW-R\fR" 4 +.Ip "\f(CW--dynamic-reloc\fR" 4 Print the dynamic relocation entries of the file. This is only meaningful for dynamic objects, such as certain types of shared libraries. - -.TP -.B \-s -.TP -.B \-\-full\-contents +.Ip "\f(CW-s\fR" 4 +.Ip "\f(CW--full-contents\fR" 4 Display the full contents of any sections requested. - -.TP -.B \-S -.TP -.B \-\-source +.Ip "\f(CW-S\fR" 4 +.Ip "\f(CW--source\fR" 4 Display source code intermixed with disassembly, if possible. Implies -\fB-d\fP. - -.TP -.B \-\-show\-raw\-insn +\fB\-d\fR. +.Ip "\f(CW--show-raw-insn\fR" 4 When disassembling instructions, print the instruction in hex as well as in symbolic form. This is the default except when -.B \-\-prefix\-addresses -is used. - -.TP -.B \-\-no\-show\-raw\-insn +\f(CW--prefix-addresses\fR is used. +.Ip "\f(CW--no-show-raw-insn\fR" 4 When disassembling instructions, do not print the instruction bytes. -This is the default when -.B \-\-prefix\-addresses -is used. - -.TP -.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 -.B \-\-syms +This is the default when \f(CW--prefix-addresses\fR is used. +.Ip "\f(CW-G\fR" 4 +.Ip "\f(CW--stabs\fR" 4 +Display the full contents of any sections requested. Display the +contents of the .stab and .stab.index and .stab.excl sections from an +\s-1ELF\s0 file. This is only useful on systems (such as Solaris 2.0) in which +\&\f(CW.stab\fR debugging symbol-table entries are carried in an \s-1ELF\s0 +section. In most other file formats, debugging symbol-table entries are +interleaved with linkage symbols, and are visible in the \fB--syms\fR output. - -.TP -.BI "\-\-start\-address=" "address" +.Ip "\f(CW--start-address=\fIaddress\fR\fR" 4 Start displaying data at the specified address. This affects the output -of the -.B \-d\c -, -.B \-r -and -.B \-s -options. - -.TP -.BI "\-\-stop\-address=" "address" +of the \f(CW-d\fR, \f(CW-r\fR and \f(CW-s\fR options. +.Ip "\f(CW--stop-address=\fIaddress\fR\fR" 4 Stop displaying data at the specified address. This affects the output -of the -.B \-d\c -, -.B \-r -and -.B \-s -options. - -.TP -.B \-t -.TP -.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 -\|' program. - -.TP -.B \-T -.TP -.B \-\-dynamic\-syms -Dynamic Symbol Table. Print the dynamic symbol table entries of the -file. This is only meaningful for dynamic objects, such as certain -types of shared libraries. This is similar to the information -provided by the `\|\c -.B nm\c -\|' program when given the -.B \-D (\-\-dynamic) -option. - -.TP -.B \-\-version -Print the version number of -.B objdump -and exit. - -.TP -.B \-x -.TP -.B \-\-all\-headers +of the \f(CW-d\fR, \f(CW-r\fR and \f(CW-s\fR options. +.Ip "\f(CW-t\fR" 4 +.Ip "\f(CW--syms\fR" 4 +Print the symbol table entries of the file. +This is similar to the information provided by the \fBnm\fR program. +.Ip "\f(CW-T\fR" 4 +.Ip "\f(CW--dynamic-syms\fR" 4 +Print the dynamic symbol table entries of the file. This is only +meaningful for dynamic objects, such as certain types of shared +libraries. This is similar to the information provided by the \fBnm\fR +program when given the \fB\-D\fR (\fB--dynamic\fR) option. +.Ip "\f(CW--version\fR" 4 +Print the version number of \f(CWobjdump\fR and exit. +.Ip "\f(CW-x\fR" 4 +.Ip "\f(CW--all-header\fR" 4 Display all available header information, including the symbol table and -relocation entries. Using `\|\c -.B \-x\c -\|' is equivalent to specifying all of -`\|\c -.B \-a \-f \-h \-r \-t\c -\|'. - +relocation entries. Using \fB\-x\fR is equivalent to specifying all of +\fB\-a \-f \-h \-r \-t\fR. +.Ip "\f(CW-w\fR" 4 +.Ip "\f(CW--wide\fR" 4 +Format some lines for output devices that have more than 80 columns. .SH "SEE ALSO" -.RB "`\|" binutils "\|'" -entry in -.B -info\c -\&; -.I -The GNU Binary Utilities\c -\&, Roland H. Pesch (October 1991); -.BR nm "(" 1 ")." - -.SH COPYING -Copyright (c) 1991, 92, 93, 94, 95, 1996 Free Software Foundation, Inc. -.PP +\fInm\fR\|(1), \fIreadelf\fR\|(1), and the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. .PP -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. - -\" .SH GNU Free Documentation License -\" Version 1.1, March 2000 - -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP - -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP - -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP - -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP - -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP - -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP - -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP - -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". + +.rn }` '' +.IX Title "OBJDUMP.1 1" +.IX Name "objdump - display information from object files." + +.IX Header "NAME" + +.IX Header "SYNOPSIS" + +.IX Header "DESCRIPTION" + +.IX Header "OPTIONS" + +.IX Item "\f(CW-a\fR" + +.IX Item "\f(CW--archive-header\fR" + +.IX Item "\f(CW--adjust-vma=\fIoffset\fR\fR" + +.IX Item "\f(CW-b \fIbfdname\fR\fR" + +.IX Item "\f(CW--target=\fIbfdname\fR\fR" + +.IX Item "\f(CW-C\fR" + +.IX Item "\f(CW--demangle[=\fIstyle\fR]\fR" + +.IX Item "\f(CW-G\fR" + +.IX Item "\f(CW--debugging\fR" + +.IX Item "\f(CW-d\fR" + +.IX Item "\f(CW--disassemble\fR" + +.IX Item "\f(CW-D\fR" + +.IX Item "\f(CW--disassemble-all\fR" + +.IX Item "\f(CW--prefix-addresses\fR" + +.IX Item "\f(CW--disassemble-zeroes\fR" + +.IX Item "\f(CW-EB\fR" + +.IX Item "\f(CW-EL\fR" + +.IX Item "\f(CW--endian={big|little}\fR" + +.IX Item "\f(CW-f\fR" + +.IX Item "\f(CW--file-header\fR" + +.IX Item "\f(CW--file-start-context\fR" + +.IX Item "\f(CW-h\fR" + +.IX Item "\f(CW--section-header\fR" + +.IX Item "\f(CW--header\fR" + +.IX Item "\f(CW--help\fR" + +.IX Item "\f(CW-i\fR" + +.IX Item "\f(CW--info\fR" + +.IX Item "\f(CW-j \fIname\fR\fR" + +.IX Item "\f(CW--section=\fIname\fR\fR" + +.IX Item "\f(CW-l\fR" + +.IX Item "\f(CW--line-numbers\fR" + +.IX Item "\f(CW-m \fImachine\fR\fR" + +.IX Item "\f(CW--architecture=\fImachine\fR\fR" + +.IX Item "\f(CW-M \fIoptions\fR\fR" + +.IX Item "\f(CW--disassembler-options=\fIoptions\fR\fR" + +.IX Item "\f(CW-p\fR" + +.IX Item "\f(CW--private-headers\fR" + +.IX Item "\f(CW-r\fR" + +.IX Item "\f(CW--reloc\fR" + +.IX Item "\f(CW-R\fR" + +.IX Item "\f(CW--dynamic-reloc\fR" + +.IX Item "\f(CW-s\fR" + +.IX Item "\f(CW--full-contents\fR" + +.IX Item "\f(CW-S\fR" + +.IX Item "\f(CW--source\fR" + +.IX Item "\f(CW--show-raw-insn\fR" + +.IX Item "\f(CW--no-show-raw-insn\fR" + +.IX Item "\f(CW-G\fR" + +.IX Item "\f(CW--stabs\fR" + +.IX Item "\f(CW--start-address=\fIaddress\fR\fR" + +.IX Item "\f(CW--stop-address=\fIaddress\fR\fR" + +.IX Item "\f(CW-t\fR" + +.IX Item "\f(CW--syms\fR" + +.IX Item "\f(CW-T\fR" + +.IX Item "\f(CW--dynamic-syms\fR" + +.IX Item "\f(CW--version\fR" + +.IX Item "\f(CW-x\fR" + +.IX Item "\f(CW--all-header\fR" + +.IX Item "\f(CW-w\fR" + +.IX Item "\f(CW--wide\fR" + +.IX Header "SEE ALSO" + +.IX Header "COPYRIGHT" + diff --git a/binutils/ranlib.1 b/binutils/ranlib.1 index 15c30ed..c84969f 100644 --- a/binutils/ranlib.1 +++ b/binutils/ranlib.1 @@ -1,441 +1,247 @@ -.\" Copyright 1991, 1992, 1993, 2000 Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH ranlib 1 "5 November 1991" "Free Software Foundation" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.5 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 .. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R -.SH NAME +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH RANLIB.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" ranlib \- generate index to archive. - -.SH SYNOPSIS -.hy 0 -.na -.B ranlib \c -.RB "[\|" \-v | \-V "\|]" -.I archive\c -\& -.ad b -.hy 1 -.SH DESCRIPTION -.B ranlib -generates an index to the contents of an archive, and +.SH "SYNOPSIS" +ranlib [\-vV] \fIarchive\fR +.SH "DESCRIPTION" +\f(CWranlib\fR 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. .PP -You may use -.RB ` "nm \-s" ' -or -.RB ` "nm \-\-print-armap" ' -to list this index. +You may use \fBnm \-s\fR or \fBnm --print-armap\fR to list this index. .PP -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. .PP -The GNU -.B ranlib -program is another form of GNU -.BR ar ; -running -.B ranlib -is completely equivalent to executing -.RB ` "ar \-s" '. - -.SH OPTIONS -.TP -.B \-v -Print the version number of -.B ranlib -and exit. - +The GNU \f(CWranlib\fR program is another form of GNU \f(CWar\fR; running +\f(CWranlib\fR is completely equivalent to executing \fBar \-s\fR. +.SH "OPTIONS" +.Ip "\f(CW-v\fR" 4 +.Ip "\f(CW-V\fR" 4 +.Ip "\f(CW--version\fR" 4 +Show the version number of \f(CWranlib\fR. .SH "SEE ALSO" -.RB "`\|" binutils "\|'" -entry in -.B -info\c -\&; -.I -The GNU Binary Utilities\c -\&, Roland H. Pesch (October 1991); -.BR ar "(" 1 ")," -.BR nm "(" 1 ")." +\fIar\fR\|(1), \fInm\fR\|(1), and the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. +.PP +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". +.rn }` '' +.IX Title "RANLIB.1 1" +.IX Name "ranlib - generate index to archive." -.SH COPYING -Copyright (c) 1991, 2000 Free Software Foundation, Inc. -.PP -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. +.IX Header "NAME" -\" .SH GNU Free Documentation License -\" Version 1.1, March 2000 +.IX Header "SYNOPSIS" -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP +.IX Header "DESCRIPTION" -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP +.IX Header "OPTIONS" -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP +.IX Item "\f(CW-v\fR" -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP +.IX Item "\f(CW-V\fR" -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP +.IX Item "\f(CW--version\fR" -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP +.IX Header "SEE ALSO" -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP +.IX Header "COPYRIGHT" -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. diff --git a/binutils/readelf.1 b/binutils/readelf.1 new file mode 100644 index 0000000..52f3c79 --- /dev/null +++ b/binutils/readelf.1 @@ -0,0 +1,389 @@ +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.1 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R + +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH READELF.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" +readelf \- Displays information about ELF files. +.SH "SYNOPSIS" +readelf [ \-a | --all ] + [ \-h | --file-header] + [ \-l | --program-headers | --segments] + [ \-S | --section-headers | --sections] + [ \-e | --headers] + [ \-s | --syms | --symbols] + [ \-n | --notes] + [ \-r | --relocs] + [ \-u | --unwind] + [ \-d | --dynamic] + [ \-V | --version-info] + [ \-D | --use-dynamic] + [ \-x <number> | --hex-dump=<number>] + [ \-w[liaprf] | --debug-dump[=info,=line,=abbrev,=pubnames,=ranges,=frames]] + [ --histogram] + [ \-v | --version] + [ \-H | --help] + \fIelffile\fR... +.SH "DESCRIPTION" +\f(CWreadelf\fR displays information about one or more ELF format object +files. The options control what particular information to display. +.PP +\fIelffile\fR... are the object files to be examined. At the +moment, \f(CWreadelf\fR does not support examining archives, nor does it +support examing 64 bit ELF files. +.SH "OPTIONS" +The long and short forms of options, shown here as alternatives, are +equivalent. At least one option besides \fB\-v\fR or \fB\-H\fR must be +given. +.Ip "\f(CW-a\fR" 4 +.Ip "\f(CW--all\fR" 4 +Equivalent to specifiying \fB--file-header\fR, +\fB--program-headers\fR, \fB--sections\fR, \fB--symbols\fR, +\fB--relocs\fR, \fB--dynamic\fR, \fB--notes\fR and +\fB--version-info\fR. +.Ip "\f(CW-h\fR" 4 +.Ip "\f(CW--file-header\fR" 4 +Displays the information contained in the \s-1ELF\s0 header at the start of the +file. +.Ip "\f(CW-l\fR" 4 +.Ip "\f(CW--program-headers\fR" 4 +.Ip "\f(CW--segments\fR" 4 +Displays the information contained in the file's segment headers, if it +has any. +.Ip "\f(CW-S\fR" 4 +.Ip "\f(CW--sections\fR" 4 +.Ip "\f(CW--section-headers\fR" 4 +Displays the information contained in the file's section headers, if it +has any. +.Ip "\f(CW-s\fR" 4 +.Ip "\f(CW--symbols\fR" 4 +.Ip "\f(CW--syms\fR" 4 +Displays the entries in symbol table section of the file, if it has one. +.Ip "\f(CW-e\fR" 4 +.Ip "\f(CW--headers\fR" 4 +Display all the headers in the file. Equivalent to \fB\-h \-l \-S\fR. +.Ip "\f(CW-n\fR" 4 +.Ip "\f(CW--notes\fR" 4 +Displays the contents of the \s-1NOTE\s0 segment, if it exists. +.Ip "\f(CW-r\fR" 4 +.Ip "\f(CW--relocs\fR" 4 +Displays the contents of the file's relocation section, if it has one. +.Ip "\f(CW-u\fR" 4 +.Ip "\f(CW--unwind\fR" 4 +Displays the contents of the file's unwind section, if it has one. Only +the unwind sections for \s-1IA64\s0 \s-1ELF\s0 files are currently supported. +.Ip "\f(CW-d\fR" 4 +.Ip "\f(CW--dynamic\fR" 4 +Displays the contents of the file's dynamic section, if it has one. +.Ip "\f(CW-V\fR" 4 +.Ip "\f(CW--version-info\fR" 4 +Displays the contents of the version sections in the file, it they +exist. +.Ip "\f(CW-D\fR" 4 +.Ip "\f(CW--use-dynamic\fR" 4 +When displaying symbols, this option makes \f(CWreadelf\fR use the +symbol table in the file's dynamic section, rather than the one in the +symbols section. +.Ip "\f(CW-x <number>\fR" 4 +.Ip "\f(CW--hex-dump=<number>\fR" 4 +Displays the contents of the indicated section as a hexadecimal dump. +.Ip "\f(CW-w[liaprf]\fR" 4 +.Ip "\f(CW--debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=frames]\fR" 4 +Displays the contents of the debug sections in the file, if any are +present. If one of the optional letters or words follows the switch +then only data found in those specific sections will be dumped. +.Ip "\f(CW--histogram\fR" 4 +Display a histogram of bucket list lengths when displaying the contents +of the symbol tables. +.Ip "\f(CW-v\fR" 4 +.Ip "\f(CW--version\fR" 4 +Display the version number of readelf. +.Ip "\f(CW-H\fR" 4 +.Ip "\f(CW--help\fR" 4 +Display the command line options understood by \f(CWreadelf\fR. +.SH "SEE ALSO" +\fIobjdump\fR\|(1), and the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. +.PP +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". + +.rn }` '' +.IX Title "READELF.1 1" +.IX Name "readelf - Displays information about ELF files." + +.IX Header "NAME" + +.IX Header "SYNOPSIS" + +.IX Header "DESCRIPTION" + +.IX Header "OPTIONS" + +.IX Item "\f(CW-a\fR" + +.IX Item "\f(CW--all\fR" + +.IX Item "\f(CW-h\fR" + +.IX Item "\f(CW--file-header\fR" + +.IX Item "\f(CW-l\fR" + +.IX Item "\f(CW--program-headers\fR" + +.IX Item "\f(CW--segments\fR" + +.IX Item "\f(CW-S\fR" + +.IX Item "\f(CW--sections\fR" + +.IX Item "\f(CW--section-headers\fR" + +.IX Item "\f(CW-s\fR" + +.IX Item "\f(CW--symbols\fR" + +.IX Item "\f(CW--syms\fR" + +.IX Item "\f(CW-e\fR" + +.IX Item "\f(CW--headers\fR" + +.IX Item "\f(CW-n\fR" + +.IX Item "\f(CW--notes\fR" + +.IX Item "\f(CW-r\fR" + +.IX Item "\f(CW--relocs\fR" + +.IX Item "\f(CW-u\fR" + +.IX Item "\f(CW--unwind\fR" + +.IX Item "\f(CW-d\fR" + +.IX Item "\f(CW--dynamic\fR" + +.IX Item "\f(CW-V\fR" + +.IX Item "\f(CW--version-info\fR" + +.IX Item "\f(CW-D\fR" + +.IX Item "\f(CW--use-dynamic\fR" + +.IX Item "\f(CW-x <number>\fR" + +.IX Item "\f(CW--hex-dump=<number>\fR" + +.IX Item "\f(CW-w[liaprf]\fR" + +.IX Item "\f(CW--debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=frames]\fR" + +.IX Item "\f(CW--histogram\fR" + +.IX Item "\f(CW-v\fR" + +.IX Item "\f(CW--version\fR" + +.IX Item "\f(CW-H\fR" + +.IX Item "\f(CW--help\fR" + +.IX Header "SEE ALSO" + +.IX Header "COPYRIGHT" + diff --git a/binutils/size.1 b/binutils/size.1 index 041e975..b319a9c 100644 --- a/binutils/size.1 +++ b/binutils/size.1 @@ -1,520 +1,315 @@ -.\" Copyright 1991, 1992, 1993, 1994, 1995, 2000 -.\" Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH size 1 "5 November 1991" "Free Software Foundation" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.5 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp +.if t .sp .5v +.if n .sp .. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R -.SH NAME +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH SIZE.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" size \- list section sizes and total size. - -.SH SYNOPSIS -.hy 0 -.na -.TP -.B size -.RB "[\|" \-A \||\| \-B \||\| \c -.BI "\-\-format=" compatibility\c -\&\|] -.RB "[\|" \-\-help "\|]" -.RB "[\|" \-d \||\| \-o \||\| \-x\c -\||\|\c -.BI "\-\-radix=" number\c -\&\|] -.RB "[\|" \c -.BI "\-\-target=" bfdname\c -\&\|] -.RB "[\|" \-V \||\| \-\-version "\|]" -.I objfile\c -\&.\|.\|. -.ad b -.hy 1 -.SH DESCRIPTION -The GNU \c -.B size\c -\& utility lists the section sizes\(em\&and the total -size\(em\&for each of the object files -.I objfile -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 -.B \-A -.TP -.B \-B -.TP -.BI "\-\-format " "compatibility" -Using one of these options, you can choose whether the output from GNU -\c -.B size\c -\& resembles output from System V \c -.B size\c -\& (using `\|\c -.B \-A\c -\|', -or `\|\c -.B \-\-format=sysv\c -\|'), or Berkeley \c -.B size\c -\& (using `\|\c -.B \-B\c -\|', or -`\|\c -.B \-\-format=berkeley\c -\|'). The default is the one-line format similar to +.SH "SYNOPSIS" +size [ \-A | \-B | --format=\fIcompatibility\fR ] + [ --help ] [ \-d | \-o | \-x | --radix=\fInumber\fR ] + [ --target=\fIbfdname\fR ] [ \-V | --version ] + [ \fIobjfile\fR... ] +.SH "DESCRIPTION" +The GNU \f(CWsize\fR utility lists the section sizes---and the total +size---for each of the object or archive files \fIobjfile\fR in its +argument list. By default, one line of output is generated for each +object file or each module in an archive. +.PP +\fIobjfile\fR... are the object files to be examined. +If none are specified, the file \f(CWa.out\fR will be used. +.SH "OPTIONS" +The command line options have the following meanings: +.Ip "\f(CW-A\fR" 4 +.Ip "\f(CW-B\fR" 4 +.Ip "\f(CW--format=\fIcompatibility\fR\fR" 4 +Using one of these options, you can choose whether the output from \s-1GNU\s0 +\f(CWsize\fR resembles output from System V \f(CWsize\fR (using \fB\-A\fR, +or \fB--format=sysv\fR), or Berkeley \f(CWsize\fR (using \fB\-B\fR, or +\fB--format=berkeley\fR). The default is the one-line format similar to Berkeley's. - -.TP -.B \-\-help +.Sp +Here is an example of the Berkeley (default) format of output from +\f(CWsize\fR: + + $ size --format=Berkeley ranlib size + text data bss dec hex filename + 294880 81920 11592 388392 5ed28 ranlib + 294880 81920 11888 388688 5ee50 size +.Sp +This is the same data, but displayed closer to System V conventions: +.Sp +.Vb 16 +\& +\& $ size --format=SysV ranlib size +\& ranlib : +\& section size addr +\& .text 294880 8192 +\& .data 81920 303104 +\& .bss 11592 385024 +\& Total 388392 +\& +\& +\& size : +\& section size addr +\& .text 294880 8192 +\& .data 81920 303104 +\& .bss 11888 385024 +\& Total 388688 +.Ve +.Ip "\f(CW--help\fR" 4 Show a summary of acceptable arguments and options. - -.TP -.B \-d -.TP -.B \-o -.TP -.B \-x -.TP -.BI "\-\-radix " "number" +.Ip "\f(CW-d\fR" 4 +.Ip "\f(CW-o\fR" 4 +.Ip "\f(CW-x\fR" 4 +.Ip "\f(CW--radix=\fInumber\fR\fR" 4 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 -\|'); octal -(`\|\c -.B \-o\c -\|', or `\|\c -.B \-\-radix 8\c -\|'); or hexadecimal (`\|\c -.B \-x\c -\|', or -`\|\c -.B \-\-radix 16\c -\|'). In `\|\c -.B \-\-radix \c -.I number\c -\&\c -\|', only the three +section is given in decimal (\fB\-d\fR, or \fB--radix=10\fR); octal +(\fB\-o\fR, or \fB--radix=8\fR); or hexadecimal (\fB\-x\fR, or +\fB--radix=16\fR). In \fB--radix=\fR\fInumber\fR, only the three values (8, 10, 16) are supported. The total size is always given in two -radices; decimal and hexadecimal for `\|\c -.B \-d\c -\|' or `\|\c -.B \-x\c -\|' output, or -octal and hexadecimal if you're using `\|\c -.B \-o\c -\|'. +radices; decimal and hexadecimal for \fB\-d\fR or \fB\-x\fR output, or +octal and hexadecimal if you're using \fB\-o\fR. +.Ip "\f(CW--target=\fIbfdname\fR\fR" 4 +Specify that the object-code format for \fIobjfile\fR is +\fIbfdname\fR. This option may not be necessary; \f(CWsize\fR can +automatically recognize many formats. +.Ip "\f(CW-V\fR" 4 +.Ip "\f(CW--version\fR" 4 +Display the version number of \f(CWsize\fR. +.SH "SEE ALSO" +\fIar\fR\|(1), \fIobjdump\fR\|(1), \fIreadelf\fR\|(1), and the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. +.PP +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". -.TP -.BI "\-\-target " "bfdname" -You can specify a particular object-code format for \c -.I objfile\c -\& as -\c -.I bfdname\c -\&. This may not be necessary; \c -.I size\c -\& can -automatically recognize many formats. See -.BR objdump ( 1 ) -for information -on listing available formats. +.rn }` '' +.IX Title "SIZE.1 1" +.IX Name "size - list section sizes and total size." -.TP -.B \-V -.TP -.B \-\-version -Display version number information on \c -.B size\c -\& itself. +.IX Header "NAME" -.SH "SEE ALSO" -.RB "`\|" binutils "\|'" -entry in -.BR info ; -.IR "The GNU Binary Utilities" , - Roland H. Pesch (October 1991); -.BR ar "(" 1 ")," -.BR objdump ( 1 ). +.IX Header "SYNOPSIS" -.SH COPYING -Copyright (c) 1991, 2000 Free Software Foundation, Inc. -.PP -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. +.IX Header "DESCRIPTION" + +.IX Header "OPTIONS" + +.IX Item "\f(CW-A\fR" + +.IX Item "\f(CW-B\fR" + +.IX Item "\f(CW--format=\fIcompatibility\fR\fR" + +.IX Item "\f(CW--help\fR" + +.IX Item "\f(CW-d\fR" -\" .SH GNU Free Documentation License -\" Version 1.1, March 2000 +.IX Item "\f(CW-o\fR" -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP +.IX Item "\f(CW-x\fR" -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP +.IX Item "\f(CW--radix=\fInumber\fR\fR" -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP +.IX Item "\f(CW--target=\fIbfdname\fR\fR" -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP +.IX Item "\f(CW-V\fR" -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP +.IX Item "\f(CW--version\fR" -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP +.IX Header "SEE ALSO" -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP +.IX Header "COPYRIGHT" -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. diff --git a/binutils/strings.1 b/binutils/strings.1 index 0ced90b..441c087 100644 --- a/binutils/strings.1 +++ b/binutils/strings.1 @@ -1,509 +1,297 @@ -.\" Copyright 1993, 1994, 1995, 2000 Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH strings 1 "09 March 2000" "Free Software Foundation" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.7 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP .. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R -.SH NAME -strings \- print the strings of printable characters in files - -.SH SYNOPSIS -.hy 0 -.na -.TP -.B strings -.RB "[\|" \-a | \-\c -.RB | \-\-all "\|]" -.RB "[\|" \-f | \-\-print\-file\-name "\|]" -.RB "[\|" \-o "\|]" -.RB "[\|" \-\-help "\|]" -.RB "[\|" \-v | \-\-version "\|]" -.RB "[\|" \-n -.I min\-len\c -.RI | \-min\-len\c -.RB | "\-\-bytes="\c -.I min\-len\c -\&\|] -.RB "[\|" \-t -.I {o,x,d}\c -.RB "[\|" "\-\-target=\fIbfdname" "\|]" -.RB | "\-\-radix="\c -.I {o,x,d}\c -\&\|] -.I file\c -.ad b -.hy 1 -.SH DESCRIPTION -For each -.I file -given, GNU \c -.B strings -prints the printable character sequences that are at least 4 -characters long (or the number given with the options below) and are -followed by an unprintable character. By default, it only prints the -strings from the initialized and loaded sections of object files; for -other types of files, it prints the strings from the whole file. - +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH STRINGS.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" +strings \- print the strings of printable characters in files. +.SH "SYNOPSIS" +strings [\-afov] [\-\fImin-len\fR] [\-n \fImin-len\fR] [\-t \fIradix\fR] [\-] + [--all] [--print-file-name] [--bytes=\fImin-len\fR] + [--radix=\fIradix\fR] [--target=\fIbfdname\fR] + [--help] [--version] \fIfile\fR... +.SH "DESCRIPTION" +For each \fIfile\fR given, GNU \f(CWstrings\fR prints the printable +character sequences that are at least 4 characters long (or the number +given with the options below) and are followed by an unprintable +character. By default, it only prints the strings from the initialized +and loaded sections of object files; for other types of files, it prints +the strings from the whole file. .PP -.B strings -is mainly useful for determining the contents of non-text files. - -.SH OPTIONS -The long and short forms of options, shown here as alternatives, are -equivalent. - -.TP -.B \-a -.TP -.B \-\-all -.TP -.B \- +\f(CWstrings\fR is mainly useful for determining the contents of non-text +files. +.SH "OPTIONS" +.Ip "\f(CW-a\fR" 4 +.Ip "\f(CW--all\fR" 4 +.Ip "\f(CW-\fR" 4 Do not scan only the initialized and loaded sections of object files; scan the whole files. - -.TP -.B \-f -.TP -.B \-\-print\-file\-name +.Ip "\f(CW-f\fR" 4 +.Ip "\f(CW--print-file-name\fR" 4 Print the name of the file before each string. +.Ip "\f(CW--help\fR" 4 +Print a summary of the program usage on the standard output and exit. +.Ip "\f(CW-\fImin-len\fR\fR" 4 +.Ip "\f(CW-n \fImin-len\fR\fR" 4 +.Ip "\f(CW--bytes=\fImin-len\fR\fR" 4 +Print sequences of characters that are at least \fImin-len\fR characters +long, instead of the default 4. +.Ip "\f(CW-o\fR" 4 +Like \fB\-t o\fR. Some other versions of \f(CWstrings\fR have \fB\-o\fR +act like \fB\-t d\fR instead. Since we can not be compatible with both +ways, we simply chose one. +.Ip "\f(CW-t \fIradix\fR\fR" 4 +.Ip "\f(CW--radix=\fIradix\fR\fR" 4 +Print the offset within the file before each string. The single +character argument specifies the radix of the offset---\fBo\fR for +octal, \fBx\fR for hexadecimal, or \fBd\fR for decimal. +.Ip "\f(CW--target=\fIbfdname\fR\fR" 4 +Specify an object code format other than your system's default format. +.Ip "\f(CW-v\fR" 4 +.Ip "\f(CW--version\fR" 4 +Print the program version number on the standard output and exit. +.SH "SEE ALSO" +\fIar\fR\|(1), \fInm\fR\|(1), \fIobjdump\fR\|(1), \fIranlib\fR\|(1), \fIreadelf\fR\|(1) +and the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. +.PP +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". -.TP -.B \-\-help -Print a summary of the options to -.B strings -on the standard output and exit. +.rn }` '' +.IX Title "STRINGS.1 1" +.IX Name "strings - print the strings of printable characters in files." -.TP -.B \-v -.TP -.B \-\-version -Print the version number -of -.B strings -on the standard output and exit. +.IX Header "NAME" -.TP -.B "\-n \fImin\-len\fP" -.TP -.B "\-\fImin\-len\fP" -.TP -.B "\-\-bytes=\fImin\-len\fP" -Print sequences of characters that are at least -.I min\-len -characters long, instead of the default 4. +.IX Header "SYNOPSIS" -.TP -.BR "\-t " {o,x,d} -.TP -.BR "\-\-radix=" {o,x,d} -Print the offset within the file before each string. The single -character argument specifies the radix of the offset\(emoctal, -hexadecimal, or decimal. +.IX Header "DESCRIPTION" -.TP -.BI "\-\-target=" "bfdname" -Specify an object code format other than your system's default format. -See -.BR objdump ( 1 ), -for information on listing available formats. +.IX Header "OPTIONS" -.TP -.B \-o -Like -.BR "\-t o" . +.IX Item "\f(CW-a\fR" -.PP +.IX Item "\f(CW--all\fR" -.SH "SEE ALSO" -.RB "`\|" binutils "\|'" -entry in -.B -info\c -\&; -.I -The GNU Binary Utilities\c -\&, Roland H. Pesch (October 1991); -.BR ar ( 1 ), -.BR nm ( 1 ), -.BR objdump ( 1 ), -.BR ranlib ( 1 ). +.IX Item "\f(CW-\fR" +.IX Item "\f(CW-f\fR" -.SH COPYING -Copyright (c) 1993, 2000 Free Software Foundation, Inc. -.PP -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. +.IX Item "\f(CW--print-file-name\fR" + +.IX Item "\f(CW--help\fR" + +.IX Item "\f(CW-\fImin-len\fR\fR" + +.IX Item "\f(CW-n \fImin-len\fR\fR" + +.IX Item "\f(CW--bytes=\fImin-len\fR\fR" -\" .SH GNU Free Documentation License -\" Version 1.1, March 2000 +.IX Item "\f(CW-o\fR" -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP +.IX Item "\f(CW-t \fIradix\fR\fR" -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP +.IX Item "\f(CW--radix=\fIradix\fR\fR" -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP +.IX Item "\f(CW--target=\fIbfdname\fR\fR" -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP +.IX Item "\f(CW-v\fR" -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP +.IX Item "\f(CW--version\fR" -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP +.IX Header "SEE ALSO" -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP +.IX Header "COPYRIGHT" -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. diff --git a/binutils/strip.1 b/binutils/strip.1 index 063b33e..0c8d63b 100644 --- a/binutils/strip.1 +++ b/binutils/strip.1 @@ -1,544 +1,358 @@ -.\" Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000 -.\" Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH strip 1 "5 November 1991" "Free Software Foundation" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.6 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 .. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R -.SH NAME +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH STRIP.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" strip \- Discard symbols from object files. - -.SH SYNOPSIS -.hy 0 -.na -.TP -.B strip -.RB "[\|" \-F\ \fIbfdname\fR\ |\ \fB\-\-target=\fIbfdname\fP "\|]" -.RB "[\|" \-I\ \fIbfdname\fR\ |\ \fB\-\-input\-target=\fIbfdname\fP "\|]" -.RB "[\|" \-O\ \fIbfdname\fR\ |\ \fB\-\-output\-target=\fIbfdname\fP "\|]" -.RB "[\|" \-R\ \fIsectionname\fR\ |\ \fB\-\-remove\-section=\fIsectionname\fP "\|]" -.RB "[\|" \-s\fR\ |\ \fB\-\-strip\-all "\|]" -.RB "[\|" \-S\fR\ |\ \fB\-g\fR\ |\ \fB\-\-strip\-debug "\|]" -.RB "[\|" \-\-strip\-unneeded\fR "\|]" -.RB "[\|" \-x\fR\ |\ \fB\-\-discard\-all "\|]" -.RB "[\|" \-X\fR\ |\ \fB\-\-discard\-locals "\|]" -.RB "[\|" \-K\ \fIsymbolname\fR\ |\ \fB\-\-keep\-symbol=\fIsymbolname\fR "\|]" -.RB "[\|" \-N\ \fIsymbolname\fR\ |\ \fB\-\-strip\-symbol=\fIsymbolname\fR "\|]" -.RB "[\|" \-o\ \fIfile\fR "\|]" -.RB "[\|" \-p\fR\ |\ \fB\-\-preserve\-dates "\|]" -.RB "[\|" \-v\fR\ |\ \fB\-\-verbose "\|]" -.RB "[\|" \-V\fR\ |\ \fB\-\-version "\|]" -.RB "[\|" \-V\fR\ |\ \fB\-\-help "\|]" -.I objfile\c -\&.\|.\|. - -.SH DESCRIPTION -GNU -.B strip -discards all symbols from the object files -.IR objfile . -The list of object files may include archives. +.SH "SYNOPSIS" +strip [ \-F \fIbfdname\fR | --target=\fIbfdname\fR ] + [ \-I \fIbfdname\fR | --input-target=\fIbfdname\fR ] + [ \-O \fIbfdname\fR | --output-target=\fIbfdname\fR ] + [ \-s | --strip-all ] [ \-S | \-g | --strip-debug ] + [ \-K \fIsymbolname\fR | --keep-symbol=\fIsymbolname\fR ] + [ \-N \fIsymbolname\fR | --strip-symbol=\fIsymbolname\fR ] + [ \-x | --discard-all ] [ \-X | --discard-locals ] + [ \-R \fIsectionname\fR | --remove-section=\fIsectionname\fR ] + [ \-o \fIfile\fR ] [ \-p | --preserve-dates ] + [ \-v | --verbose ] [ \-V | --version ] [ --help ] + \fIobjfile\fR... +.SH "DESCRIPTION" +GNU \f(CWstrip\fR discards all symbols from object files +\fIobjfile\fR. The list of object files may include archives. At least one object file must be given. - -.P -.B strip -modifies the files named in its argument, +.PP +\f(CWstrip\fR modifies the files named in its argument, rather than writing modified copies under different names. - -.SH OPTIONS -.TP -.B "\-F \fIbfdname" -.TP -.B "\-\-target=\fIbfdname" -Treat the original \fIobjfile\fP as a file with the object -code format \fIbfdname\fP, and rewrite it in the same format. - -.TP -.B \-\-help -Show a summary of the options to -.B strip -and exit. - -.TP -.B "\-I \fIbfdname -.TP -.B "\-\-input\-target=\fIbfdname" -Treat the original \fIobjfile\fP as a file with the object -code format \fIbfdname\fP. - -.TP -.B "\-O \fIbfdname\fP" -.TP -.B "\-\-output\-target=\fIbfdname" -Replace \fIobjfile\fP with a file in the output format \fIbfdname\fP. - -.TP -.B "\-R \fIsectionname\fP" -.TP -.B "\-\-remove\-section=\fIsectionname" -Remove the named section from the file. This option may be given more -than once. Note that using this option inappropriately may make the -object file unusable. - -.TP -.B \-s -.TP -.B \-\-strip\-all +.SH "OPTIONS" +.Ip "\f(CW-F \fIbfdname\fR\fR" 4 +.Ip "\f(CW--target=\fIbfdname\fR\fR" 4 +Treat the original \fIobjfile\fR as a file with the object +code format \fIbfdname\fR, and rewrite it in the same format. +.Ip "\f(CW--help\fR" 4 +Show a summary of the options to \f(CWstrip\fR and exit. +.Ip "\f(CW-I \fIbfdname\fR \fR" 4 +.Ip "\f(CW--input-target=\fIbfdname\fR\fR" 4 +Treat the original \fIobjfile\fR as a file with the object +code format \fIbfdname\fR. +.Ip "\f(CW-O \fIbfdname\fR\fR" 4 +.Ip "\f(CW--output-target=\fIbfdname\fR\fR" 4 +Replace \fIobjfile\fR with a file in the output format \fIbfdname\fR. +.Ip "\f(CW-R \fIsectionname\fR\fR" 4 +.Ip "\f(CW--remove-section=\fIsectionname\fR\fR" 4 +Remove any section named \fIsectionname\fR from the output file. This +option may be given more than once. Note that using this option +inappropriately may make the output file unusable. +.Ip "\f(CW-s\fR" 4 +.Ip "\f(CW--strip-all\fR" 4 Remove all symbols. - -.TP -.B \-S -.TP -.B \-g -.TP -.B \-\-strip\-debug +.Ip "\f(CW-g\fR" 4 +.Ip "\f(CW-S\fR" 4 +.Ip "\f(CW--strip-debug\fR" 4 Remove debugging symbols only. - -.TP -.B \-\-strip\-unneeded -Strip all symbols that are not needed for relocation processing. - -.TP -.B \-N \fIsymbolname\fR -.TP -.B \-\-strip\-symbol=\fIsymbolname -Remove symbol \fIsymbolname\fP from the source file. This option -may be given more than once, and may be combined with other strip -options. - -.TP -.B \-o \fIfile\fR +.Ip "\f(CW--strip-unneeded\fR" 4 +Remove all symbols that are not needed for relocation processing. +.Ip "\f(CW-K \fIsymbolname\fR\fR" 4 +.Ip "\f(CW--keep-symbol=\fIsymbolname\fR\fR" 4 +Keep only symbol \fIsymbolname\fR from the source file. This option may +be given more than once. +.Ip "\f(CW-N \fIsymbolname\fR\fR" 4 +.Ip "\f(CW--strip-symbol=\fIsymbolname\fR\fR" 4 +Remove symbol \fIsymbolname\fR from the source file. This option may be +given more than once, and may be combined with strip options other than +\f(CW-K\fR. +.Ip "\f(CW-o \fIfile\fR\fR" 4 Put the stripped output in \fIfile\fR, rather than replacing the existing file. When this argument is used, only one \fIobjfile\fR argument may be specified. - -.TP -.B \-p -.TP -.B \-\-preserve-dates +.Ip "\f(CW-p\fR" 4 +.Ip "\f(CW--preserve-dates\fR" 4 Preserve the access and modification dates of the file. - -.TP -.B \-x -.TP -.B \-\-discard\-all +.Ip "\f(CW-x\fR" 4 +.Ip "\f(CW--discard-all\fR" 4 Remove non-global symbols. - -.TP -.B \-X -.TP -.B \-\-discard\-locals +.Ip "\f(CW-X\fR" 4 +.Ip "\f(CW--discard-locals\fR" 4 Remove compiler-generated local symbols. -(These usually start with ``L'' or ``.''.) - -.TP -.B \-K \fIsymbolname\fR, \fB\-\-keep\-symbol=\fIsymbolname -Copy only symbol \fIsymbolname\fP from the source file. This option -may be given more than once. - -.TP -.B \-N \fIsymbolname\fR, \fB\-\-strip\-symbol=\fIsymbolname -Do not copy symbol \fIsymbolname\fP from the source file. This option -may be given more than once, and may be combined with strip options -other than \fB\-K\fR. - -.TP -.B \-v -.TP -.B \-\-verbose +(These usually start with \fBL\fR or \fB.\fR.) +.Ip "\f(CW-V\fR" 4 +.Ip "\f(CW--version\fR" 4 +Show the version number for \f(CWstrip\fR. +.Ip "\f(CW-v\fR" 4 +.Ip "\f(CW--verbose\fR" 4 Verbose output: list all object files modified. In the case of -archives, -.B "strip \-v" -lists all members of the archive. - -.TP -.B \-V -.TP -.B \-\-version -Show the version number for \fBstrip\fP and exit. - +archives, \fBstrip \-v\fR lists all members of the archive. .SH "SEE ALSO" -.RB "`\|" binutils "\|'" -entry in -.BR info ; -.IR "The GNU Binary Utilities" , -Roland H. Pesch (October 1991). - -.SH COPYING -Copyright (c) 1991, 2000 Free Software Foundation, Inc. +the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. .PP -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. - -\" .SH GNU Free Documentation License -\" Version 1.1, March 2000 - -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP - -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP - -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP - -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP - -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP - -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP - -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP - -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". + +.rn }` '' +.IX Title "STRIP.1 1" +.IX Name "strip - Discard symbols from object files." + +.IX Header "NAME" + +.IX Header "SYNOPSIS" + +.IX Header "DESCRIPTION" + +.IX Header "OPTIONS" + +.IX Item "\f(CW-F \fIbfdname\fR\fR" + +.IX Item "\f(CW--target=\fIbfdname\fR\fR" + +.IX Item "\f(CW--help\fR" + +.IX Item "\f(CW-I \fIbfdname\fR \fR" + +.IX Item "\f(CW--input-target=\fIbfdname\fR\fR" + +.IX Item "\f(CW-O \fIbfdname\fR\fR" + +.IX Item "\f(CW--output-target=\fIbfdname\fR\fR" + +.IX Item "\f(CW-R \fIsectionname\fR\fR" + +.IX Item "\f(CW--remove-section=\fIsectionname\fR\fR" + +.IX Item "\f(CW-s\fR" + +.IX Item "\f(CW--strip-all\fR" + +.IX Item "\f(CW-g\fR" + +.IX Item "\f(CW-S\fR" + +.IX Item "\f(CW--strip-debug\fR" + +.IX Item "\f(CW--strip-unneeded\fR" + +.IX Item "\f(CW-K \fIsymbolname\fR\fR" + +.IX Item "\f(CW--keep-symbol=\fIsymbolname\fR\fR" + +.IX Item "\f(CW-N \fIsymbolname\fR\fR" + +.IX Item "\f(CW--strip-symbol=\fIsymbolname\fR\fR" + +.IX Item "\f(CW-o \fIfile\fR\fR" + +.IX Item "\f(CW-p\fR" + +.IX Item "\f(CW--preserve-dates\fR" + +.IX Item "\f(CW-x\fR" + +.IX Item "\f(CW--discard-all\fR" + +.IX Item "\f(CW-X\fR" + +.IX Item "\f(CW--discard-locals\fR" + +.IX Item "\f(CW-V\fR" + +.IX Item "\f(CW--version\fR" + +.IX Item "\f(CW-v\fR" + +.IX Item "\f(CW--verbose\fR" + +.IX Header "SEE ALSO" + +.IX Header "COPYRIGHT" + diff --git a/binutils/windres.1 b/binutils/windres.1 new file mode 100644 index 0000000..998e2ae --- /dev/null +++ b/binutils/windres.1 @@ -0,0 +1,377 @@ +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.1 2001/03/25 20:32:25 nickc +''' Automate generate on man pages +''' +''' +.de Sh +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R + +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH WINDRES.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" +windres \- manipulate Windows resources. +.SH "SYNOPSIS" +windres [options] [input-file] [output-file] +.SH "DESCRIPTION" +\f(CWwindres\fR reads resources from an input file and copies them into +an output file. Either file may be in one of three formats: +.Ip "\f(CWrc\fR" 4 +A text format read by the Resource Compiler. +.Ip "\f(CWres\fR" 4 +A binary format generated by the Resource Compiler. +.Ip "\f(CWcoff\fR" 4 +A \s-1COFF\s0 object or executable. +.PP +The exact description of these different formats is available in +documentation from Microsoft. +.PP +When \f(CWwindres\fR converts from the \f(CWrc\fR format to the \f(CWres\fR +format, it is acting like the Windows Resource Compiler. When +\f(CWwindres\fR converts from the \f(CWres\fR format to the \f(CWcoff\fR +format, it is acting like the Windows \f(CWCVTRES\fR program. +.PP +When \f(CWwindres\fR generates an \f(CWrc\fR file, the output is similar +but not identical to the format expected for the input. When an input +\f(CWrc\fR file refers to an external filename, an output \f(CWrc\fR file +will instead include the file contents. +.PP +If the input or output format is not specified, \f(CWwindres\fR will +guess based on the file name, or, for the input file, the file contents. +A file with an extension of \fI.rc\fR will be treated as an \f(CWrc\fR +file, a file with an extension of \fI.res\fR will be treated as a +\f(CWres\fR file, and a file with an extension of \fI.o\fR or +\&\fI.exe\fR will be treated as a \f(CWcoff\fR file. +.PP +If no output file is specified, \f(CWwindres\fR will print the resources +in \f(CWrc\fR format to standard output. +.PP +The normal use is for you to write an \f(CWrc\fR file, use \f(CWwindres\fR +to convert it to a \s-1COFF\s0 object file, and then link the \s-1COFF\s0 file into +your application. This will make the resources described in the +\f(CWrc\fR file available to Windows. +.SH "OPTIONS" +.Ip "\f(CW-i \fIfilename\fR\fR" 4 +.Ip "\f(CW--input \fIfilename\fR\fR" 4 +The name of the input file. If this option is not used, then +\f(CWwindres\fR will use the first non-option argument as the input file +name. If there are no non-option arguments, then \f(CWwindres\fR will +read from standard input. \f(CWwindres\fR can not read a \s-1COFF\s0 file from +standard input. +.Ip "\f(CW-o \fIfilename\fR\fR" 4 +.Ip "\f(CW--output \fIfilename\fR\fR" 4 +The name of the output file. If this option is not used, then +\f(CWwindres\fR will use the first non-option argument, after any used +for the input file name, as the output file name. If there is no +non-option argument, then \f(CWwindres\fR will write to standard output. +\f(CWwindres\fR can not write a \s-1COFF\s0 file to standard output. +.Ip "\f(CW-I \fIformat\fR\fR" 4 +.Ip "\f(CW--input-format \fIformat\fR\fR" 4 +The input format to read. \fIformat\fR may be \fBres\fR, \fBrc\fR, or +\fBcoff\fR. If no input format is specified, \f(CWwindres\fR will +guess, as described above. +.Ip "\f(CW-O \fIformat\fR\fR" 4 +.Ip "\f(CW--output-format \fIformat\fR\fR" 4 +The output format to generate. \fIformat\fR may be \fBres\fR, +\fBrc\fR, or \fBcoff\fR. If no output format is specified, +\f(CWwindres\fR will guess, as described above. +.Ip "\f(CW-F \fItarget\fR\fR" 4 +.Ip "\f(CW--target \fItarget\fR\fR" 4 +Specify the \s-1BFD\s0 format to use for a \s-1COFF\s0 file as input or output. This +is a \s-1BFD\s0 target name; you can use the \f(CW--help\fR option to see a list +of supported targets. Normally \f(CWwindres\fR will use the default +format, which is the first one listed by the \f(CW--help\fR option. +\f(CW@ref\fR{Target Selection}. +.Ip "\f(CW--preprocessor \fIprogram\fR\fR" 4 +When \f(CWwindres\fR reads an \f(CWrc\fR file, it runs it through the C +preprocessor first. This option may be used to specify the preprocessor +to use, including any leading arguments. The default preprocessor +argument is \f(CWgcc -E -xc-header -DRC_INVOKED\fR. +.Ip "\f(CW--include-dir \fIdirectory\fR\fR" 4 +Specify an include directory to use when reading an \f(CWrc\fR file. +\f(CWwindres\fR will pass this to the preprocessor as an \f(CW-I\fR +option. \f(CWwindres\fR will also search this directory when looking for +files named in the \f(CWrc\fR file. +.Ip "\f(CW-D \fItarget\fR\fR" 4 +.Ip "\f(CW--define \fIsym\fR[=\fIval\fR]\fR" 4 +Specify a \f(CW-D\fR option to pass to the preprocessor when reading an +\f(CWrc\fR file. +.Ip "\f(CW-v\fR" 4 +Enable verbose mode. This tells you what the preprocessor is if you +didn't specify one. +.Ip "\f(CW--language \fIval\fR\fR" 4 +Specify the default language to use when reading an \f(CWrc\fR file. +\fIval\fR should be a hexadecimal language code. The low eight bits are +the language, and the high eight bits are the sublanguage. +.Ip "\f(CW--use-temp-file\fR" 4 +Use a temporary file to instead of using popen to read the output of +the preprocessor. Use this option if the popen implementation is buggy +on the host (eg., certain non-English language versions of Windows 95 and +Windows 98 are known to have buggy popen where the output will instead +go the console). +.Ip "\f(CW--no-use-temp-file\fR" 4 +Use popen, not a temporary file, to read the output of the preprocessor. +This is the default behaviour. +.Ip "\f(CW--help\fR" 4 +Prints a usage summary. +.Ip "\f(CW--version\fR" 4 +Prints the version number for \f(CWwindres\fR. +.Ip "\f(CW--yydebug\fR" 4 +If \f(CWwindres\fR is compiled with \f(CWYYDEBUG\fR defined as \f(CW1\fR, +this will turn on parser debugging. +.SH "SEE ALSO" +the Info entries for \fIbinutils\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. +.PP +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". + +.rn }` '' +.IX Title "WINDRES.1 1" +.IX Name "windres - manipulate Windows resources." + +.IX Header "NAME" + +.IX Header "SYNOPSIS" + +.IX Header "DESCRIPTION" + +.IX Item "\f(CWrc\fR" + +.IX Item "\f(CWres\fR" + +.IX Item "\f(CWcoff\fR" + +.IX Header "OPTIONS" + +.IX Item "\f(CW-i \fIfilename\fR\fR" + +.IX Item "\f(CW--input \fIfilename\fR\fR" + +.IX Item "\f(CW-o \fIfilename\fR\fR" + +.IX Item "\f(CW--output \fIfilename\fR\fR" + +.IX Item "\f(CW-I \fIformat\fR\fR" + +.IX Item "\f(CW--input-format \fIformat\fR\fR" + +.IX Item "\f(CW-O \fIformat\fR\fR" + +.IX Item "\f(CW--output-format \fIformat\fR\fR" + +.IX Item "\f(CW-F \fItarget\fR\fR" + +.IX Item "\f(CW--target \fItarget\fR\fR" + +.IX Item "\f(CW--preprocessor \fIprogram\fR\fR" + +.IX Item "\f(CW--include-dir \fIdirectory\fR\fR" + +.IX Item "\f(CW-D \fItarget\fR\fR" + +.IX Item "\f(CW--define \fIsym\fR[=\fIval\fR]\fR" + +.IX Item "\f(CW-v\fR" + +.IX Item "\f(CW--language \fIval\fR\fR" + +.IX Item "\f(CW--use-temp-file\fR" + +.IX Item "\f(CW--no-use-temp-file\fR" + +.IX Item "\f(CW--help\fR" + +.IX Item "\f(CW--version\fR" + +.IX Item "\f(CW--yydebug\fR" + +.IX Header "SEE ALSO" + +.IX Header "COPYRIGHT" + diff --git a/etc/ChangeLog b/etc/ChangeLog index 0453a3e..788d11c 100644 --- a/etc/ChangeLog +++ b/etc/ChangeLog @@ -1,3 +1,7 @@ +2001-03-25 Stephane Carrez <Stephane.Carrez@worldnet.fr> + + * texi2pod.pl: New file (from gcc/contrib). + 1999-04-01 Jim Blandy <jimb@zwingli.cygnus.com> * add-log.el, add-log.vi: New files. diff --git a/gas/ChangeLog b/gas/ChangeLog index 09a99fb..5bf7135 100644 --- a/gas/ChangeLog +++ b/gas/ChangeLog @@ -1,3 +1,12 @@ +2001-03-23 Stephane Carrez <Stephane.Carrez@worldnet.fr> + + * doc/as.texinfo: Put @c man begin to generate the as man page. + When generating man, define all the variables. Re-organize some + options to obtain better indentation of man page. + * doc/Makefile.am (MANCONF, TEXI2POD, POD2MAN): New variable. + (as.1): Build from as.texinfo. + * doc/Makefile.in: Regenerate.Index: binutils/Makefile.am + 2001-03-25 Alan Modra <alan@linuxcare.com.au> * config/tc-i386.c (i386_scale): Accept an absolute expression for diff --git a/gas/config/tc-arm.c b/gas/config/tc-arm.c index 9843e1f..e5f0c13 100644 --- a/gas/config/tc-arm.c +++ b/gas/config/tc-arm.c @@ -8424,7 +8424,38 @@ arm_frob_label (sym) ARM_SET_INTERWORK (sym, support_interwork); #endif - if (label_is_thumb_function_name) + /* Note - do not allow local symbols (.Lxxx) to be labeled + as Thumb functions. This is because these labels, whilst + they exist inside Thumb code, are not the entry points for + possible ARM->Thumb calls. Also, these labels can be used + as part of a computed goto or switch statement. eg gcc + can generate code that looks like this: + + ldr r2, [pc, .Laaa] + lsl r3, r3, #2 + ldr r2, [r3, r2] + mov pc, r2 + + .Lbbb: .word .Lxxx + .Lccc: .word .Lyyy + ..etc... + .Laaa: .word Lbbb + + The first instruction loads the address of the jump table. + The second instruction converts a table index into a byte offset. + The third instruction gets the jump address out of the table. + The fourth instruction performs the jump. + + If the address stored at .Laaa is that of a symbol which has the + Thumb_Func bit set, then the linker will arrange for this address + to have the bottom bit set, which in turn would mean that the + address computation performed by the third instruction would end + up with the bottom bit set. Since the ARM is capable of unaligned + word loads, the instruction would then load the incorrect address + out of the jump table, and chaos would ensue. */ + if (label_is_thumb_function_name + && (S_GET_NAME (sym)[0] != '.' || S_GET_NAME (sym)[1] != 'L') + && (bfd_get_section_flags (stdoutput, now_seg) & SEC_CODE) != 0) { /* When the address of a Thumb function is taken the bottom bit of that address should be set. This will allow diff --git a/gas/doc/Makefile.am b/gas/doc/Makefile.am index 95b02b7..5cd20f8 100644 --- a/gas/doc/Makefile.am +++ b/gas/doc/Makefile.am @@ -5,6 +5,13 @@ AUTOMAKE_OPTIONS = cygnus # What version of the manual you want; "all" includes everything CONFIG=all +# Options to extract the man page from as.texinfo +MANCONF = -Dman + +TEXI2POD = perl $(top_srcdir)/../etc/texi2pod.pl + +POD2MAN = pod2man --center="GNU" --release="binutils-$(VERSION)" --section=1 + man_MANS = as.1 info_TEXINFOS = as.texinfo gasp.texi @@ -55,3 +62,17 @@ noinst_TEXINFOS = internals.texi DISTCLEANFILES = asconfig.texi MAINTAINERCLEANFILES = gasver.texi + +# Maintenance + +# Build the man page from the texinfo file +# The sed command removes the no-adjust Nroff command so that +# the man output looks standard. +$(srcdir)/as.1: $(srcdir)/as.texinfo + touch $(srcdir)/as.1 + -$(TEXI2POD) $(MANCONF) < $(srcdir)/as.texinfo > as.pod + -($(POD2MAN) as.pod | \ + sed -e '/^.if n .na/d' > $(srcdir)/as.1.T$$$$ && \ + mv -f $(srcdir)/as.1.T$$$$ $(srcdir)/as.1) || \ + (rm -f $(srcdir)/as.1.T$$$$ && exit 1) + diff --git a/gas/doc/Makefile.in b/gas/doc/Makefile.in index a76d109..578f8dc 100644 --- a/gas/doc/Makefile.in +++ b/gas/doc/Makefile.in @@ -121,35 +121,18 @@ AUTOMAKE_OPTIONS = cygnus # What version of the manual you want; "all" includes everything CONFIG = all +# Options to extract the man page from as.texinfo +MANCONF = -Dman + +TEXI2POD = perl $(top_srcdir)/../etc/texi2pod.pl + +POD2MAN = pod2man --center="GNU" --release="binutils-$(VERSION)" --section=1 + man_MANS = as.1 info_TEXINFOS = as.texinfo gasp.texi -CPU_DOCS = \ - c-a29k.texi \ - c-arc.texi \ - c-arm.texi \ - c-d10v.texi \ - c-h8300.texi \ - c-h8500.texi \ - c-hppa.texi \ - c-i370.texi \ - c-i386.texi \ - c-i860.texi \ - c-i960.texi \ - c-m32r.texi \ - c-m68hc11.texi \ - c-m68k.texi \ - c-mips.texi \ - c-ns32k.texi \ - c-pdp11.texi \ - c-pj.texi \ - c-sh.texi \ - c-sparc.texi \ - c-tic54x.texi \ - c-vax.texi \ - c-v850.texi \ - c-z8k.texi +CPU_DOCS = c-a29k.texi c-arc.texi c-arm.texi c-d10v.texi c-h8300.texi c-h8500.texi c-hppa.texi c-i370.texi c-i386.texi c-i860.texi c-i960.texi c-m32r.texi c-m68hc11.texi c-m68k.texi c-mips.texi c-ns32k.texi c-pdp11.texi c-pj.texi c-sh.texi c-sparc.texi c-tic54x.texi c-vax.texi c-v850.texi c-z8k.texi # This one isn't ready for prime time yet. Not even a little bit. @@ -176,7 +159,7 @@ DIST_COMMON = Makefile.am Makefile.in DISTFILES = $(DIST_COMMON) $(SOURCES) $(HEADERS) $(TEXINFOS) $(EXTRA_DIST) -TAR = tar +TAR = gtar GZIP_ENV = --best all: all-redirect .SUFFIXES: @@ -357,7 +340,7 @@ distdir: $(DISTFILES) @for file in $(DISTFILES); do \ if test -f $$file; then d=.; else d=$(srcdir); fi; \ if test -d $$d/$$file; then \ - cp -pr $$d/$$file $(distdir)/$$file; \ + cp -pr $$/$$file $(distdir)/$$file; \ else \ test -f $(distdir)/$$file \ || ln $$d/$$file $(distdir)/$$file 2> /dev/null \ @@ -448,6 +431,19 @@ gasver.texi: Makefile as.info: $(srcdir)/as.texinfo asconfig.texi gasver.texi $(CPU_DOCS) as.dvi: $(srcdir)/as.texinfo asconfig.texi gasver.texi $(CPU_DOCS) +# Maintenance + +# Build the man page from the texinfo file +# The sed command removes the no-adjust Nroff command so that +# the man output looks standard. +$(srcdir)/as.1: $(srcdir)/as.texinfo + touch $(srcdir)/as.1 + -$(TEXI2POD) $(MANCONF) < $(srcdir)/as.texinfo > as.pod + -($(POD2MAN) as.pod | \ + sed -e '/^.if n .na/d' > $(srcdir)/as.1.T$$$$ && \ + mv -f $(srcdir)/as.1.T$$$$ $(srcdir)/as.1) || \ + (rm -f $(srcdir)/as.1.T$$$$ && exit 1) + # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. .NOEXPORT: diff --git a/gas/doc/as.1 b/gas/doc/as.1 index 856000d..01f7666 100644 --- a/gas/doc/as.1 +++ b/gas/doc/as.1 @@ -1,667 +1,890 @@ -.\" Copyright 1991, 1992, 1995, 1996, 1997, 1998, 2000 -.\" Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH as 1 "29 March 1996" "Free Software Foundation" "GNU Development Tools" - -.SH NAME -GNU as \- the portable GNU assembler. - -.SH SYNOPSIS -.na -.B as -.RB "[\|" \-a "[\|" dhlns "\|]" \c -\&[\|\=\c -.I file\c -\&\|]\|] -.RB "[\|" \-D "\|]" -.RB "[\|" \-\-defsym\ SYM=VAL "\|]" -.RB "[\|" \-f "\|]" -.RB "[\|" \-\-gstabs "\|]" -.RB "[\|" \-I -.I path\c -\&\|] -.RB "[\|" \-K "\|]" -.RB "[\|" \-L "\|]" -.RB "[\|" \-M\ |\ \-\-mri "\|]" -.RB "[\|" \-o -.I objfile\c -\&\|] -.RB "[\|" \-R "\|]" -.RB "[\|" \-\-traditional\-format "\|]" -.RB "[\|" \-v "\|]" -.RB "[\|" \-w "\|]" -.RB "[\|" \-\^\- "\ |\ " \c -.I files\c -\&\|.\|.\|.\|] - -.I i960-only options: +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.7 2001/03/25 20:32:29 nickc +''' Automate generate on man pages +''' +''' +.de Sh .br -.RB "[\|" \-ACA "\||\|" \-ACA_A "\||\|" \-ACB\c -.RB "\||\|" \-ACC "\||\|" \-AKA "\||\|" \-AKB\c -.RB "\||\|" \-AKC "\||\|" \-AMC "\|]" -.RB "[\|" \-b "\|]" -.RB "[\|" \-no-relax "\|]" - -.I m680x0-only options: +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip .br -.RB "[\|" \-l "\|]" -.RB "[\|" \-mc68000 "\||\|" \-mc68010 "\||\|" \-mc68020 "\|]" -.ad b - -.SH DESCRIPTION -GNU \c -.B as\c -\& is really a family of assemblers. +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R + +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH AS 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" +AS \- the portable GNU assembler. +.SH "SYNOPSIS" +as [ \-a[cdhlns][=file] ] [ \-D ] [ --defsym \fIsym\fR=\fIval\fR ] + [ \-f ] [ --gstabs ] [ --gdwarf2 ] [ --help ] [ \-I \fIdir\fR ] + [ \-J ] [ \-K ] [ \-L ] + [ --listing\*(--lhs-width=NUM ][ --listing-lhs-width2=NUM ] + [ --listing-rhs-width=NUM ][ --listing-cont-lines=NUM ] + [ --keep-locals ] [ \-o \fIobjfile\fR ] [ \-R ] [ --statistics ] [ \-v ] + [ \-version ] [ --version ] [ \-W ] [ --warn ] [ --fatal-warnings ] + [ \-w ] [ \-x ] [ \-Z ] [ --target-help ] + [ \-marc[5|6|7|8] ] + [ \-EB | \-EL ] + [ \-m[arm]1 | \-m[arm]2 | \-m[arm]250 | \-m[arm]3 | + \-m[arm]6 | \-m[arm]60 | \-m[arm]600 | \-m[arm]610 | + \-m[arm]620 | \-m[arm]7[t][[d]m[i]][fe] | \-m[arm]70 | + \-m[arm]700 | \-m[arm]710[c] | \-m[arm]7100 | + \-m[arm]7500 | \-m[arm]8 | \-m[arm]810 | \-m[arm]9 | + \-m[arm]920 | \-m[arm]920t | \-m[arm]9tdmi | + \-mstrongarm | \-mstrongarm110 | \-mstrongarm1100 ] + [ \-m[arm]v2 | \-m[arm]v2a | \-m[arm]v3 | \-m[arm]v3m | + \-m[arm]v4 | \-m[arm]v4t | \-m[arm]v5 | \-[arm]v5t | + \-[arm]v5te ] + [ \-mthumb | \-mall ] + [ \-mfpa10 | \-mfpa11 | \-mfpe-old | \-mno-fpu ] + [ \-EB | \-EL ] + [ \-mapcs-32 | \-mapcs-26 | \-mapcs-float | + \-mapcs-reentrant ] + [ \-mthumb-interwork ] [ \-moabi ] [ \-k ] + [ \-O ] + [ \-O | \-n | \-N ] + [ \-mb | \-me ] + [ \-Av6 | \-Av7 | \-Av8 | \-Asparclet | \-Asparclite + \-Av8plus | \-Av8plusa | \-Av9 | \-Av9a ] + [ \-xarch=v8plus | \-xarch=v8plusa ] [ \-bump ] + [ \-32 | \-64 ] + [ \-ACA | \-ACA_A | \-ACB | \-ACC | \-AKA | \-AKB | + \-AKC | \-AMC ] + [ \-b ] [ \-no-relax ] + [ --m32rx | --[no-]warn-explicit-parallel-conflicts | + --W[n]p ] + [ \-l ] [ \-m68000 | \-m68010 | \-m68020 | ... ] + [ \-jsri2bsr ] [ \-sifilter ] [ \-relax ] + [ \-mcpu=[210|340] ] + [ \-m68hc11 | \-m68hc12 ] + [ --force-long-branchs ] [ --short-branchs ] + [ --strict-direct-mode ] [ --print-insn-syntax ] + [ --print-opcodes ] [ --generate-example ] + [ \-nocpp ] [ \-EL ] [ \-EB ] [ \-G \fInum\fR ] [ \-mcpu=\fICPU\fR ] + [ \-mips1 ] [ \-mips2 ] [ \-mips3 ] [ \-mips4 ] [ \-mips5 ] + [ \-mips32 ] [ \-mips64 ] + [ \-m4650 ] [ \-no-m4650 ] + [ --trap ] [ --break ] + [ --emulation=\fIname\fR ] + [ -- | \fIfiles\fR ... ] +.SH "DESCRIPTION" +GNU \f(CWas\fR is really a family of assemblers. If you use (or have used) the GNU assembler on one architecture, you should find a fairly similar environment when you use it on another architecture. Each version has much in common with the others, including object file formats, most assembler directives (often called -\c -.I pseudo-ops)\c -\& and assembler syntax. - -For information on the syntax and pseudo-ops used by GNU \c -.B as\c -\&, see `\|\c -.B as\c -\|' entry in \c -.B info \c -(or the manual \c -.I -.I -Using as: The GNU Assembler\c -\&). - -\c -.B as\c -\& is primarily intended to assemble the output of the GNU C -compiler \c -.B gcc\c -\& for use by the linker \c -.B ld\c -\&. Nevertheless, -we've tried to make \c -.B as\c -\& assemble correctly everything that the native -assembler would. -This doesn't mean \c -.B as\c -\& always uses the same syntax as another +\fIpseudo-ops\fR) and assembler syntax. +.PP +\f(CWas\fR is primarily intended to assemble the output of the +GNU C compiler \f(CW\fR for use by the linker +\f(CW\fR. Nevertheless, we've tried to make \f(CWas\fR +assemble correctly everything that other assemblers for the same +machine would assemble. +Any exceptions are documented explicitly. +This doesn't mean \f(CWas\fR always uses the same syntax as another assembler for the same architecture; for example, we know of several incompatible versions of 680x0 assembly language syntax. - -Each time you run \c -.B as\c -\& it assembles exactly one source +.PP +Each time you run \f(CWas\fR it assembles exactly one source program. The source program is made up of one or more files. (The standard input is also a file.) - -If \c -.B as\c -\& is given no file names it attempts to read one input file -from the \c -.B as\c -\& standard input, which is normally your terminal. You -may have to type \c -.B ctl-D\c -\& to tell \c -.B as\c -\& there is no more program -to assemble. Use `\|\c -.B \-\^\-\c -\|' if you need to explicitly name the standard input file +.PP +You give \f(CWas\fR a command line that has zero or more input file +names. The input files are read (from left file name to right). A +command line argument (in any position) that has no special meaning +is taken to be an input file name. +.PP +If you give \f(CWas\fR no file names it attempts to read one input file +from the \f(CWas\fR standard input, which is normally your terminal. You +may have to type \fBctl-D\fR to tell \f(CWas\fR there is no more program +to assemble. +.PP +Use \fB--\fR if you need to explicitly name the standard input file in your command line. - -.B as\c -\& may write warnings and error messages to the standard error -file (usually your terminal). This should not happen when \c -.B as\c -\& is -run automatically by a compiler. Warnings report an assumption made so -that \c -.B as\c -\& could keep assembling a flawed program; errors report a +.PP +If the source is empty, \f(CWas\fR produces a small, empty object +file. +.PP +\f(CWas\fR may write warnings and error messages to the standard error +file (usually your terminal). This should not happen when a compiler +runs \f(CWas\fR automatically. Warnings report an assumption made so +that \f(CWas\fR could keep assembling a flawed program; errors report a grave problem that stops the assembly. - -.SH OPTIONS -.TP -.BR \-a -Turn on assembly listings. There are various suboptions. -.B d -omits debugging directives. -.B h -includes the high level source code; this is only available if the -source file can be found, and the code was compiled with -.B \-g. -.B l -includes an assembly listing. -.B n -omits forms processing. -.B s -includes a symbol listing. -.B = -.I file -sets the listing file name; this must be the last suboption. -The default suboptions are -.B hls. -.TP -.B \-D -This option is accepted only for script compatibility with calls to -other assemblers; it has no effect on \c -.B as\c -\&. -.TP -.B \-\-defsym SYM=VALUE -Define the symbol SYM to be VALUE before assembling the input file. -VALUE must be an integer constant. As in C, a leading 0x indicates a -hexadecimal value, and a leading 0 indicates an octal value. -.TP -.B \-f -``fast''--skip preprocessing (assume source is compiler output). -.TP -.BI "\-I\ " path -Add -.I path -to the search list for -.B .include -directives. -.TP -.B \-\-gstabs +.PP +If you are invoking \f(CWas\fR via the GNU C compiler (version 2), +you can use the \fB\-Wa\fR option to pass arguments through to the assembler. +The assembler arguments must be separated from each other (and the \fB\-Wa\fR) +by commas. For example: +.PP +.Vb 2 +\& +\& gcc -c -g -O -Wa,-alh,-L file.c +.Ve +This passes two options to the assembler: \fB\-alh\fR (emit a listing to +standard output with with high-level and assembly source) and \fB\-L\fR (retain +local symbols in the symbol table). +.PP +Usually you do not need to use this \fB\-Wa\fR mechanism, since many compiler +command-line options are automatically passed to the assembler by the compiler. +(You can call the GNU compiler driver with the \fB\-v\fR option to see +precisely what options it passes to each compilation pass, including the +assembler.) +.SH "OPTIONS" +.Ip "\f(CW-a[cdhlmns]\fR" 4 +Turn on listings, in any of a variety of ways: +.Ip "\f(CW-ac\fR" 8 +omit false conditionals +.Ip "\f(CW-ad\fR" 8 +omit debugging directives +.Ip "\f(CW-ah\fR" 8 +include high-level source +.Ip "\f(CW-al\fR" 8 +include assembly +.Ip "\f(CW-am\fR" 8 +include macro expansions +.Ip "\f(CW-an\fR" 8 +omit forms processing +.Ip "\f(CW-as\fR" 8 +include symbols +.Ip "\f(CW=file\fR" 8 +set the name of the listing file +.Sp +You may combine these options; for example, use \fB\-aln\fR for assembly +listing without forms processing. The \fB=file\fR option, if used, must be +the last one. By itself, \fB\-a\fR defaults to \fB\-ahls\fR. +.Ip "\f(CW-D\fR" 4 +Ignored. This option is accepted for script compatibility with calls to +other assemblers. +.Ip "\f(CW--defsym \fIsym\fR=\fIvalue\fR\fR" 4 +Define the symbol \fIsym\fR to be \fIvalue\fR before assembling the input file. +\fIvalue\fR must be an integer constant. As in C, a leading \fB0x\fR +indicates a hexadecimal value, and a leading \fB0\fR indicates an octal value. +.Ip "\f(CW-f\fR" 4 +``fast'\*(R'---skip whitespace and comment preprocessing (assume source is +compiler output). +.Ip "\f(CW--gstabs\fR" 4 Generate stabs debugging information for each assembler line. This may help debugging assembler code, if the debugger can handle it. -.TP -.B \-K -Issue warnings when difference tables altered for long displacements. -.TP -.B \-L -Keep (in symbol table) local symbols, starting with `\|\c -.B L\c -\|' -.TP -.B \-M, \-\-mri -Assemble in MRI compatibility mode. -.TP -.BI "\-o\ " objfile -Name the object-file output from \c -.B as -.TP -.B \-R -Fold data section into text section -.TP -.B \-\-traditional\-format -Use same format as native assembler, when possible. -.TP -.B \-v -Announce \c -.B as\c -\& version -.TP -.B \-W, \-\-no-warn +.Ip "\f(CW--gdwarf2\fR" 4 +Generate \s-1DWARF2\s0 debugging information for each assembler line. This +may help debugging assembler code, if the debugger can handle it. Note \- this +option is only supported by some targets, not all of them. +.Ip "\f(CW--help\fR" 4 +Print a summary of the command line options and exit. +.Ip "\f(CW--target-help\fR" 4 +Print a summary of all target specific options and exit. +.Ip "\f(CW-I \fIdir\fR\fR" 4 +Add directory \fIdir\fR to the search list for \f(CW.include\fR directives. +.Ip "\f(CW-J\fR" 4 +Don't warn about signed overflow. +.Ip "\f(CW-K\fR" 4 +This option is accepted but has no effect on the \s-1TARGET\s0 family. +.Ip "\f(CW-L\fR" 4 +.Ip "\f(CW--keep-locals\fR" 4 +Keep (in the symbol table) local symbols. On traditional a.out systems +these start with \fBL\fR, but different systems have different local +label prefixes. +.Ip "\f(CW--listing-lhs-width=\fInumber\fR\fR" 4 +Set the maximum width, in words, of the output data column for an assembler +listing to \fInumber\fR. +.Ip "\f(CW--listing-lhs-width2=\fInumber\fR\fR" 4 +Set the maximum width, in words, of the output data column for continuation +lines in an assembler listing to \fInumber\fR. +.Ip "\f(CW--listing-rhs-width=\fInumber\fR\fR" 4 +Set the maximum width of an input source line, as displayed in a listing, to +\fInumber\fR bytes. +.Ip "\f(CW--listing-cont-lines=\fInumber\fR\fR" 4 +Set the maximum number of lines printed in a listing for a single line of input +to \fInumber\fR + 1. +.Ip "\f(CW-o \fIobjfile\fR\fR" 4 +Name the object-file output from \f(CWas\fR \fIobjfile\fR. +.Ip "\f(CW-R\fR" 4 +Fold the data section into the text section. +.Ip "\f(CW--statistics\fR" 4 +Print the maximum space (in bytes) and total time (in seconds) used by +assembly. +.Ip "\f(CW--strip-local-absolute\fR" 4 +Remove local absolute symbols from the outgoing symbol table. +.Ip "\f(CW-v\fR" 4 +.Ip "\f(CW-version\fR" 4 +Print the \f(CWas\fR version. +.Ip "\f(CW--version\fR" 4 +Print the \f(CWas\fR version and exit. +.Ip "\f(CW-W\fR" 4 +.Ip "\f(CW--no-warn\fR" 4 Suppress warning messages. -.TP -.B \-\-fatal\-warnings -Consider warnings to be fatal. -.TP -.B \-\-warn -Just warn on warnings. -.TP -.IR "\-\^\-" "\ |\ " "files\|.\|.\|." -Source files to assemble, or standard input (\c -.BR "\-\^\-" ")" -.TP -.BI \-A var -.I -(When configured for Intel 960.) +.Ip "\f(CW--fatal-warnings\fR" 4 +Treat warnings as errors. +.Ip "\f(CW--warn\fR" 4 +Don't suppress warning messages or treat them as errors. +.Ip "\f(CW-w\fR" 4 +Ignored. +.Ip "\f(CW-x\fR" 4 +Ignored. +.Ip "\f(CW-Z\fR" 4 +Generate an object file even after errors. +.Ip "\f(CW-- | \fIfiles\fR ...\fR" 4 +Standard input, or source files to assemble. +.PP +The following options are available when as is configured for +an \s-1ARC\s0 processor. +.Ip "\f(CW-marc[5|6|7|8]\fR" 4 +This option selects the core processor variant. +.Ip "\f(CW-EB | -EL\fR" 4 +Select either big-endian (\-\s-1EB\s0) or little-endian (\-\s-1EL\s0) output. +.PP +The following options are available when as is configured for the \s-1ARM\s0 +processor family. +.Ip "\f(CW-m[arm][1|2|3|6|7|8|9][...] \fR" 4 +Specify which \s-1ARM\s0 processor variant is the target. +.Ip "\f(CW-m[arm]v[2|2a|3|3m|4|4t|5|5t]\fR" 4 +Specify which \s-1ARM\s0 architecture variant is used by the target. +.Ip "\f(CW-mthumb | -mall\fR" 4 +Enable or disable Thumb only instruction decoding. +.Ip "\f(CW-mfpa10 | -mfpa11 | -mfpe-old | -mno-fpu\fR" 4 +Select which Floating Point architecture is the target. +.Ip "\f(CW-mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant | -moabi\fR" 4 +Select which procedure calling convention is in use. +.Ip "\f(CW-EB | -EL\fR" 4 +Select either big-endian (\-\s-1EB\s0) or little-endian (\-\s-1EL\s0) output. +.Ip "\f(CW-mthumb-interwork\fR" 4 +Specify that the code has been generated with interworking between Thumb and +\s-1ARM\s0 code in mind. +.Ip "\f(CW-k\fR" 4 +Specify that \s-1PIC\s0 code has been generated. +.PP +The following options are available when as is configured for +a D10V processor. +.Ip "\f(CW-O\fR" 4 +Optimize output by parallelizing instructions. +.PP +The following options are available when as is configured for a D30V +processor. +.Ip "\f(CW-O\fR" 4 +Optimize output by parallelizing instructions. +.Ip "\f(CW-n\fR" 4 +Warn when nops are generated. +.Ip "\f(CW-N\fR" 4 +Warn when a nop after a 32-bit multiply instruction is generated. +.PP +The following options are available when as is configured for the +Intel 80960 processor. +.Ip "\f(CW-ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC\fR" 4 Specify which variant of the 960 architecture is the target. -.TP -.B \-b -.I -(When configured for Intel 960.) +.Ip "\f(CW-b\fR" 4 Add code to collect statistics about branches taken. -.TP -.B \-no-relax -.I -(When configured for Intel 960.) +.Ip "\f(CW-no-relax\fR" 4 Do not alter compare-and-branch instructions for long displacements; error if necessary. -.TP -.B \-l -.I -(When configured for Motorola 68000). -.br +.PP +The following options are available when as is configured for the +Mitsubishi M32R series. +.Ip "\f(CW--m32rx\fR" 4 +Specify which processor in the M32R family is the target. The default +is normally the M32R, but this option changes it to the M32RX. +.Ip "\f(CW--warn-explicit-parallel-conflicts or --Wp\fR" 4 +Produce warning messages when questionable parallel constructs are +encountered. +.Ip "\f(CW--no-warn-explicit-parallel-conflicts or --Wnp\fR" 4 +Do not produce warning messages when questionable parallel constructs are +encountered. +.PP +The following options are available when as is configured for the +Motorola 68000 series. +.Ip "\f(CW-l\fR" 4 Shorten references to undefined symbols, to one word instead of two. -.TP -.BR "\-mc68000" "\||\|" "\-mc68010" "\||\|" "\-mc68020" -.I -(When configured for Motorola 68000). -.br -Specify what processor in the 68000 family is the target (default 68020) - +.Ip "\f(CW-m68000 | -m68008 | -m68010 | -m68020 | -m68030\fR" 4 +.Ip "\f(CW| -m68040 | -m68060 | -m68302 | -m68331 | -m68332\fR" 4 +.Ip "\f(CW| -m68333 | -m68340 | -mcpu32 | -m5200\fR" 4 +Specify what processor in the 68000 family is the target. The default +is normally the 68020, but this can be changed at configuration time. +.Ip "\f(CW-m68881 | -m68882 | -mno-68881 | -mno-68882\fR" 4 +The target machine does (or does not) have a floating-point coprocessor. +The default is to assume a coprocessor for 68020, 68030, and cpu32. Although +the basic 68000 is not compatible with the 68881, a combination of the +two can be specified, since it's possible to do emulation of the +coprocessor instructions with the main processor. +.Ip "\f(CW-m68851 | -mno-68851\fR" 4 +The target machine does (or does not) have a memory-management +unit coprocessor. The default is to assume an \s-1MMU\s0 for 68020 and up. .PP -Options may be in any order, and may be -before, after, or between file names. The order of file names is -significant. - -`\|\c -.B \-\^\-\c -\|' (two hyphens) by itself names the standard input file -explicitly, as one of the files for \c -.B as\c -\& to assemble. - -Except for `\|\c -.B \-\^\-\c -\|' any command line argument that begins with a -hyphen (`\|\c -.B \-\c -\|') is an option. Each option changes the behavior of -\c -.B as\c -\&. No option changes the way another option works. An -option is a `\|\c -.B \-\c -\|' followed by one or more letters; the case of -the letter is important. All options are optional. - -The `\|\c -.B \-o\c -\|' option expects exactly one file name to follow. The file -name may either immediately follow the option's letter (compatible -with older assemblers) or it may be the next command argument (GNU -standard). - -These two command lines are equivalent: -.br -.B -as\ \ \-o\ \ my\-object\-file.o\ \ mumble.s -.br -.B -as\ \ \-omy\-object\-file.o\ \ mumble.s - +For details about the \s-1PDP\s0\-11 machine dependent features options, +see \f(CW@ref\fR{\s-1PDP\s0\-11-Options}. +.Ip "\f(CW-mpic | -mno-pic\fR" 4 +Generate position-independent (or position-dependent) code. The +default is \f(CW-mpic\fR. +.Ip "\f(CW-mall\fR" 4 +.Ip "\f(CW-mall-extensions\fR" 4 +Enable all instruction set extensions. This is the default. +.Ip "\f(CW-mno-extensions\fR" 4 +Disable all instruction set extensions. +.Ip "\f(CW-m\fIextension\fR | -mno-\fIextension\fR\fR" 4 +Enable (or disable) a particular instruction set extension. +.Ip "\f(CW-m\fIcpu\fR\fR" 4 +Enable the instruction set extensions supported by a particular \s-1CPU\s0, and +disable all other extensions. +.Ip "\f(CW-m\fImachine\fR\fR" 4 +Enable the instruction set extensions supported by a particular machine +model, and disable all other extensions. +.PP +The following options are available when as is configured for +a picoJava processor. +.Ip "\f(CW-mb\fR" 4 +Generate ``big endian'\*(R' format output. +.Ip "\f(CW-ml\fR" 4 +Generate ``little endian'\*(R' format output. +.PP +The following options are available when as is configured for the +Motorola 68HC11 or 68HC12 series. +.Ip "\f(CW-m68hc11 | -m68hc12\fR" 4 +Specify what processor is the target. The default is +defined by the configuration option when building the assembler. +.Ip "\f(CW--force-long-branchs\fR" 4 +Relative branches are turned into absolute ones. This concerns +conditional branches, unconditional branches and branches to a +sub routine. +.Ip "\f(CW-S | --short-branchs\fR" 4 +Do not turn relative branchs into absolute ones +when the offset is out of range. +.Ip "\f(CW--strict-direct-mode\fR" 4 +Do not turn the direct addressing mode into extended addressing mode +when the instruction does not support direct addressing mode. +.Ip "\f(CW--print-insn-syntax\fR" 4 +Print the syntax of instruction in case of error. +.Ip "\f(CW--print-opcodes\fR" 4 +print the list of instructions with syntax and then exit. +.Ip "\f(CW--generate-example\fR" 4 +print an example of instruction for each possible instruction and then exit. +This option is only useful for testing \f(CWas\fR. +.PP +The following options are available when \f(CWas\fR is configured +for the \s-1SPARC\s0 architecture: +.Ip "\f(CW-Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite\fR" 4 +.Ip "\f(CW-Av8plus | -Av8plusa | -Av9 | -Av9a\fR" 4 +Explicitly select a variant of the \s-1SPARC\s0 architecture. +.Sp +\fB\-Av8plus\fR and \fB\-Av8plusa\fR select a 32 bit environment. +\fB\-Av9\fR and \fB\-Av9a\fR select a 64 bit environment. +.Sp +\fB\-Av8plusa\fR and \fB\-Av9a\fR enable the \s-1SPARC\s0 V9 instruction set with +UltraSPARC extensions. +.Ip "\f(CW-xarch=v8plus | -xarch=v8plusa\fR" 4 +For compatibility with the Solaris v9 assembler. These options are +equivalent to \-Av8plus and \-Av8plusa, respectively. +.Ip "\f(CW-bump\fR" 4 +Warn when the assembler switches to another architecture. +.PP +The following options are available when as is configured for +a \s-1MIPS\s0 processor. +.Ip "\f(CW-G \fInum\fR\fR" 4 +This option sets the largest size of an object that can be referenced +implicitly with the \f(CWgp\fR register. It is only accepted for targets that +use \s-1ECOFF\s0 format, such as a DECstation running Ultrix. The default value is 8. +.Ip "\f(CW-EB\fR" 4 +Generate ``big endian'\*(R' format output. +.Ip "\f(CW-EL\fR" 4 +Generate ``little endian'\*(R' format output. +.Ip "\f(CW-mips1\fR" 4 +.Ip "\f(CW-mips2\fR" 4 +.Ip "\f(CW-mips3\fR" 4 +.Ip "\f(CW-mips4\fR" 4 +.Ip "\f(CW-mips32\fR" 4 +Generate code for a particular \s-1MIPS\s0 Instruction Set Architecture level. +\fB\-mips1\fR corresponds to the R2000 and R3000 processors, +\fB\-mips2\fR to the R6000 processor, and \fB\-mips3\fR to the R4000 +processor. +\fB\-mips5\fR, \fB\-mips32\fR, and \fB\-mips64\fR correspond +to generic \s-1MIPS\s0 V, \s-1MIPS32\s0, and \s-1MIPS64\s0 \s-1ISA\s0 +processors, respectively. +.Ip "\f(CW-m4650\fR" 4 +.Ip "\f(CW-no-m4650\fR" 4 +Generate code for the \s-1MIPS\s0 R4650 chip. This tells the assembler to accept +the \fBmad\fR and \fBmadu\fR instruction, and to not schedule \fBnop\fR +instructions around accesses to the \fB\s-1HI\s0\fR and \fB\s-1LO\s0\fR registers. +\fB\-no-m4650\fR turns off this option. +.Ip "\f(CW-mcpu=\fICPU\fR\fR" 4 +Generate code for a particular \s-1MIPS\s0 cpu. It is exactly equivalent to +\fB\-m\fR\fIcpu\fR, except that there are more value of \fIcpu\fR +understood. +.Ip "\f(CW--emulation=\fIname\fR\fR" 4 +This option causes \f(CWas\fR to emulate \f(CWas\fR configured +for some other target, in all respects, including output format (choosing +between \s-1ELF\s0 and \s-1ECOFF\s0 only), handling of pseudo-opcodes which may generate +debugging information or store symbol table information, and default +endianness. The available configuration names are: \fBmipsecoff\fR, +\fBmipself\fR, \fBmipslecoff\fR, \fBmipsbecoff\fR, \fBmipslelf\fR, +\fBmipsbelf\fR. The first two do not alter the default endianness from that +of the primary target for which the assembler was configured; the others change +the default to little- or big-endian as indicated by the \fBb\fR or \fBl\fR +in the name. Using \fB\-\s-1EB\s0\fR or \fB\-\s-1EL\s0\fR will override the endianness +selection in any case. +.Sp +This option is currently supported only when the primary target +\f(CWas\fR is configured for is a \s-1MIPS\s0 \s-1ELF\s0 or \s-1ECOFF\s0 target. +Furthermore, the primary target or others specified with +\fB--enable-targets=...\fR at configuration time must include support for +the other format, if both are to be available. For example, the Irix 5 +configuration includes support for both. +.Sp +Eventually, this option will support more configurations, with more +fine-grained control over the assembler's behavior, and will be supported for +more processors. +.Ip "\f(CW-nocpp\fR" 4 +\f(CWas\fR ignores this option. It is accepted for compatibility with +the native tools. +.Ip "\f(CW--trap\fR" 4 +.Ip "\f(CW--no-trap\fR" 4 +.Ip "\f(CW--break\fR" 4 +.Ip "\f(CW--no-break\fR" 4 +Control how to deal with multiplication overflow and division by zero. +\fB--trap\fR or \fB--no-break\fR (which are synonyms) take a trap exception +(and only work for Instruction Set Architecture level 2 and higher); +\fB--break\fR or \fB--no-trap\fR (also synonyms, and the default) take a +break exception. +.PP +The following options are available when as is configured for +an MCore processor. +.Ip "\f(CW-jsri2bsr\fR" 4 +.Ip "\f(CW-nojsri2bsr\fR" 4 +Enable or disable the \s-1JSRI\s0 to \s-1BSR\s0 transformation. By default this is enabled. +The command line option \fB\-nojsri2bsr\fR can be used to disable it. +.Ip "\f(CW-sifilter\fR" 4 +.Ip "\f(CW-nosifilter\fR" 4 +Enable or disable the silicon filter behaviour. By default this is disabled. +The default can be overridden by the \fB\-sifilter\fR command line option. +.Ip "\f(CW-relax\fR" 4 +Alter jump instructions for long displacements. +.Ip "\f(CW-mcpu=[210|340]\fR" 4 +Select the cpu type on the target hardware. This controls which instructions +can be assembled. +.Ip "\f(CW-EB\fR" 4 +Assemble for a big endian target. +.Ip "\f(CW-EL\fR" 4 +Assemble for a little endian target. .SH "SEE ALSO" -.RB "`\|" as "\|'" -entry in -.B -info\c -\&; -.I -Using as: The GNU Assembler\c -\&; -.BR gcc "(" 1 ")," -.BR ld "(" 1 ")." - -.SH COPYING -Copyright (c) 1991, 1992, 2000 Free Software Foundation, Inc. +\fIgcc\fR\|(1), \fIld\fR\|(1), and the Info entries for \fIbinutils\fR and \fIld\fR. +.SH "COPYRIGHT" +Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. .PP -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. - -\" GNU Free Documentation License -\" Version 1.1, March 2000 - -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP - -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP - -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP - -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP - -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP - -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP - -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP - -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". + +.rn }` '' +.IX Title "AS 1" +.IX Name "AS - the portable GNU assembler." + +.IX Header "NAME" + +.IX Header "SYNOPSIS" + +.IX Header "DESCRIPTION" + +.IX Header "OPTIONS" + +.IX Item "\f(CW-a[cdhlmns]\fR" + +.IX Item "\f(CW-ac\fR" + +.IX Item "\f(CW-ad\fR" + +.IX Item "\f(CW-ah\fR" + +.IX Item "\f(CW-al\fR" + +.IX Item "\f(CW-am\fR" + +.IX Item "\f(CW-an\fR" + +.IX Item "\f(CW-as\fR" + +.IX Item "\f(CW=file\fR" + +.IX Item "\f(CW-D\fR" + +.IX Item "\f(CW--defsym \fIsym\fR=\fIvalue\fR\fR" + +.IX Item "\f(CW-f\fR" + +.IX Item "\f(CW--gstabs\fR" + +.IX Item "\f(CW--gdwarf2\fR" + +.IX Item "\f(CW--help\fR" + +.IX Item "\f(CW--target-help\fR" + +.IX Item "\f(CW-I \fIdir\fR\fR" + +.IX Item "\f(CW-J\fR" + +.IX Item "\f(CW-K\fR" + +.IX Item "\f(CW-L\fR" + +.IX Item "\f(CW--keep-locals\fR" + +.IX Item "\f(CW--listing-lhs-width=\fInumber\fR\fR" + +.IX Item "\f(CW--listing-lhs-width2=\fInumber\fR\fR" + +.IX Item "\f(CW--listing-rhs-width=\fInumber\fR\fR" + +.IX Item "\f(CW--listing-cont-lines=\fInumber\fR\fR" + +.IX Item "\f(CW-o \fIobjfile\fR\fR" + +.IX Item "\f(CW-R\fR" + +.IX Item "\f(CW--statistics\fR" + +.IX Item "\f(CW--strip-local-absolute\fR" + +.IX Item "\f(CW-v\fR" + +.IX Item "\f(CW-version\fR" + +.IX Item "\f(CW--version\fR" + +.IX Item "\f(CW-W\fR" + +.IX Item "\f(CW--no-warn\fR" + +.IX Item "\f(CW--fatal-warnings\fR" + +.IX Item "\f(CW--warn\fR" + +.IX Item "\f(CW-w\fR" + +.IX Item "\f(CW-x\fR" + +.IX Item "\f(CW-Z\fR" + +.IX Item "\f(CW-- | \fIfiles\fR ...\fR" + +.IX Item "\f(CW-marc[5|6|7|8]\fR" + +.IX Item "\f(CW-EB | -EL\fR" + +.IX Item "\f(CW-m[arm][1|2|3|6|7|8|9][...] \fR" + +.IX Item "\f(CW-m[arm]v[2|2a|3|3m|4|4t|5|5t]\fR" + +.IX Item "\f(CW-mthumb | -mall\fR" + +.IX Item "\f(CW-mfpa10 | -mfpa11 | -mfpe-old | -mno-fpu\fR" + +.IX Item "\f(CW-mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant | -moabi\fR" + +.IX Item "\f(CW-EB | -EL\fR" + +.IX Item "\f(CW-mthumb-interwork\fR" + +.IX Item "\f(CW-k\fR" + +.IX Item "\f(CW-O\fR" + +.IX Item "\f(CW-O\fR" + +.IX Item "\f(CW-n\fR" + +.IX Item "\f(CW-N\fR" + +.IX Item "\f(CW-ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC\fR" + +.IX Item "\f(CW-b\fR" + +.IX Item "\f(CW-no-relax\fR" + +.IX Item "\f(CW--m32rx\fR" + +.IX Item "\f(CW--warn-explicit-parallel-conflicts or --Wp\fR" + +.IX Item "\f(CW--no-warn-explicit-parallel-conflicts or --Wnp\fR" + +.IX Item "\f(CW-l\fR" + +.IX Item "\f(CW-m68000 | -m68008 | -m68010 | -m68020 | -m68030\fR" + +.IX Item "\f(CW| -m68040 | -m68060 | -m68302 | -m68331 | -m68332\fR" + +.IX Item "\f(CW| -m68333 | -m68340 | -mcpu32 | -m5200\fR" + +.IX Item "\f(CW-m68881 | -m68882 | -mno-68881 | -mno-68882\fR" + +.IX Item "\f(CW-m68851 | -mno-68851\fR" + +.IX Item "\f(CW-mpic | -mno-pic\fR" + +.IX Item "\f(CW-mall\fR" + +.IX Item "\f(CW-mall-extensions\fR" + +.IX Item "\f(CW-mno-extensions\fR" + +.IX Item "\f(CW-m\fIextension\fR | -mno-\fIextension\fR\fR" + +.IX Item "\f(CW-m\fIcpu\fR\fR" + +.IX Item "\f(CW-m\fImachine\fR\fR" + +.IX Item "\f(CW-mb\fR" + +.IX Item "\f(CW-ml\fR" + +.IX Item "\f(CW-m68hc11 | -m68hc12\fR" + +.IX Item "\f(CW--force-long-branchs\fR" + +.IX Item "\f(CW-S | --short-branchs\fR" + +.IX Item "\f(CW--strict-direct-mode\fR" + +.IX Item "\f(CW--print-insn-syntax\fR" + +.IX Item "\f(CW--print-opcodes\fR" + +.IX Item "\f(CW--generate-example\fR" + +.IX Item "\f(CW-Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite\fR" + +.IX Item "\f(CW-Av8plus | -Av8plusa | -Av9 | -Av9a\fR" + +.IX Item "\f(CW-xarch=v8plus | -xarch=v8plusa\fR" + +.IX Item "\f(CW-bump\fR" + +.IX Item "\f(CW-G \fInum\fR\fR" + +.IX Item "\f(CW-EB\fR" + +.IX Item "\f(CW-EL\fR" + +.IX Item "\f(CW-mips1\fR" + +.IX Item "\f(CW-mips2\fR" + +.IX Item "\f(CW-mips3\fR" + +.IX Item "\f(CW-mips4\fR" + +.IX Item "\f(CW-mips32\fR" + +.IX Item "\f(CW-m4650\fR" + +.IX Item "\f(CW-no-m4650\fR" + +.IX Item "\f(CW-mcpu=\fICPU\fR\fR" + +.IX Item "\f(CW--emulation=\fIname\fR\fR" + +.IX Item "\f(CW-nocpp\fR" + +.IX Item "\f(CW--trap\fR" + +.IX Item "\f(CW--no-trap\fR" + +.IX Item "\f(CW--break\fR" + +.IX Item "\f(CW--no-break\fR" + +.IX Item "\f(CW-jsri2bsr\fR" + +.IX Item "\f(CW-nojsri2bsr\fR" + +.IX Item "\f(CW-sifilter\fR" + +.IX Item "\f(CW-nosifilter\fR" + +.IX Item "\f(CW-relax\fR" + +.IX Item "\f(CW-mcpu=[210|340]\fR" + +.IX Item "\f(CW-EB\fR" + +.IX Item "\f(CW-EL\fR" + +.IX Header "SEE ALSO" + +.IX Header "COPYRIGHT" + diff --git a/gas/doc/as.texinfo b/gas/doc/as.texinfo index bd831d3..fdf1555 100644 --- a/gas/doc/as.texinfo +++ b/gas/doc/as.texinfo @@ -19,6 +19,38 @@ @include asconfig.texi @include gasver.texi @c --- +@c man begin NAME +@ifset man +@c Configure for the generation of man pages +@set AS as +@set TARGET TARGET +@set GENERIC +@set A29K +@set ARC +@set ARM +@set D10V +@set D30V +@set H8/300 +@set H8/500 +@set HPPA +@set I370 +@set I80386 +@set I860 +@set I960 +@set M32R +@set M68HC11 +@set M680X0 +@set MCORE +@set MIPS +@set PDP11 +@set PJ +@set SH +@set SPARC +@set C54X +@set V850 +@set VAX +@end ifset +@c man end @c common OR combinations of conditions @ifset AOUT @set aout-bout @@ -88,14 +120,17 @@ END-INFO-DIR-ENTRY @ifinfo This file documents the GNU Assembler "@value{AS}". +@c man begin COPYRIGHT Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, with no Front-Cover Texts, and with no - Back-Cover Texts. A copy of the license is included in the - section entitled "GNU Free Documentation License". +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled "GNU Free Documentation License". + +@c man end @ignore Permission is granted to process this file through Tex and print the @@ -197,11 +232,19 @@ code for @value{TARGET} architectures. Here is a brief summary of how to invoke @code{@value{AS}}. For details, @pxref{Invoking,,Comand-Line Options}. +@c man title AS the portable GNU assembler. + +@c man begin SEEALSO +gcc(1), ld(1), and the Info entries for @file{binutils} and @file{ld}. +@c man end + @c We don't use deffn and friends for the following because they seem @c to be limited to one line for the header. @smallexample +@c man begin SYNOPSIS @value{AS} [ -a[cdhlns][=file] ] [ -D ] [ --defsym @var{sym}=@var{val} ] - [ -f ] [ --gstabs ] [ --gdwarf2 ] [ --help ] [ -I @var{dir} ] [ -J ] [ -K ] [ -L ] + [ -f ] [ --gstabs ] [ --gdwarf2 ] [ --help ] [ -I @var{dir} ] + [ -J ] [ -K ] [ -L ] [ --listing--lhs-width=NUM ][ --listing-lhs-width2=NUM ] [ --listing-rhs-width=NUM ][ --listing-cont-lines=NUM ] [ --keep-locals ] [ -o @var{objfile} ] [ -R ] [ --statistics ] [ -v ] @@ -215,20 +258,22 @@ Here is a brief summary of how to invoke @code{@value{AS}}. For details, [ -EB | -EL ] @end ifset @ifset ARM - [ -m[arm]1 | -m[arm]2 | -m[arm]250 | -m[arm]3 | -m[arm]6 | -m[arm]60 | - -m[arm]600 | -m[arm]610 | -m[arm]620 | -m[arm]7[t][[d]m[i]][fe] | -m[arm]70 | - -m[arm]700 | -m[arm]710[c] | -m[arm]7100 | -m[arm]7500 | -m[arm]8 | - -m[arm]810 | -m[arm]9 | -m[arm]920 | -m[arm]920t | -m[arm]9tdmi | + [ -m[arm]1 | -m[arm]2 | -m[arm]250 | -m[arm]3 | + -m[arm]6 | -m[arm]60 | -m[arm]600 | -m[arm]610 | + -m[arm]620 | -m[arm]7[t][[d]m[i]][fe] | -m[arm]70 | + -m[arm]700 | -m[arm]710[c] | -m[arm]7100 | + -m[arm]7500 | -m[arm]8 | -m[arm]810 | -m[arm]9 | + -m[arm]920 | -m[arm]920t | -m[arm]9tdmi | -mstrongarm | -mstrongarm110 | -mstrongarm1100 ] - [ -m[arm]v2 | -m[arm]v2a | -m[arm]v3 | -m[arm]v3m | -m[arm]v4 | -m[arm]v4t | - -m[arm]v5 | -[arm]v5t | -[arm]v5te ] + [ -m[arm]v2 | -m[arm]v2a | -m[arm]v3 | -m[arm]v3m | + -m[arm]v4 | -m[arm]v4t | -m[arm]v5 | -[arm]v5t | + -[arm]v5te ] [ -mthumb | -mall ] [ -mfpa10 | -mfpa11 | -mfpe-old | -mno-fpu ] [ -EB | -EL ] - [ -mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant ] - [ -mthumb-interwork ] - [ -moabi ] - [ -k ] + [ -mapcs-32 | -mapcs-26 | -mapcs-float | + -mapcs-reentrant ] + [ -mthumb-interwork ] [ -moabi ] [ -k ] @end ifset @ifset D10V [ -O ] @@ -249,7 +294,8 @@ Here is a brief summary of how to invoke @code{@value{AS}}. For details, @c The order here is important. See c-sparc.texi. [ -Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite -Av8plus | -Av8plusa | -Av9 | -Av9a ] - [ -xarch=v8plus | -xarch=v8plusa ] [ -bump ] [ -32 | -64 ] + [ -xarch=v8plus | -xarch=v8plusa ] [ -bump ] + [ -32 | -64 ] @end ifset @ifset TIC54X [ -mcpu=54[123589] | -mcpu=54[56]lp ] [ -mfar-mode | -mf ] @@ -260,11 +306,13 @@ Here is a brief summary of how to invoke @code{@value{AS}}. For details, @end ifset @ifset I960 @c see md_parse_option in tc-i960.c - [ -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC ] + [ -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | + -AKC | -AMC ] [ -b ] [ -no-relax ] @end ifset @ifset M32R - [ --m32rx | --[no-]warn-explicit-parallel-conflicts | --W[n]p ] + [ --m32rx | --[no-]warn-explicit-parallel-conflicts | + --W[n]p ] @end ifset @ifset M680X0 [ -l ] [ -m68000 | -m68010 | -m68020 | ... ] @@ -275,8 +323,9 @@ Here is a brief summary of how to invoke @code{@value{AS}}. For details, @end ifset @ifset M68HC11 [ -m68hc11 | -m68hc12 ] - [ --force-long-branchs ] [ --short-branchs ] [ --strict-direct-mode ] - [ --print-insn-syntax ] [ --print-opcodes ] [ --generate-example ] + [ --force-long-branchs ] [ --short-branchs ] + [ --strict-direct-mode ] [ --print-insn-syntax ] + [ --print-opcodes ] [ --generate-example ] @end ifset @ifset MIPS [ -nocpp ] [ -EL ] [ -EB ] [ -G @var{num} ] [ -mcpu=@var{CPU} ] @@ -287,8 +336,11 @@ Here is a brief summary of how to invoke @code{@value{AS}}. For details, [ --emulation=@var{name} ] @end ifset [ -- | @var{files} @dots{} ] +@c man end @end smallexample +@c man begin OPTIONS + @table @code @item -a[cdhlmns] Turn on listings, in any of a variety of ways: @@ -546,8 +598,9 @@ Motorola 68000 series. @item -l Shorten references to undefined symbols, to one word instead of two. -@item -m68000 | -m68008 | -m68010 | -m68020 | -m68030 | -m68040 | -m68060 -@itemx | -m68302 | -m68331 | -m68332 | -m68333 | -m68340 | -mcpu32 | -m5200 +@item -m68000 | -m68008 | -m68010 | -m68020 | -m68030 +@itemx | -m68040 | -m68060 | -m68302 | -m68331 | -m68332 +@itemx | -m68333 | -m68340 | -mcpu32 | -m5200 Specify what processor in the 68000 family is the target. The default is normally the 68020, but this can be changed at configuration time. @@ -810,6 +863,8 @@ Assemble for a little endian target. @end table @end ifset +@c man end + @menu * Manual:: Structure of this Manual * GNU Assembler:: The GNU Assembler @@ -895,6 +950,8 @@ computer-readable series of instructions. Different versions of @node GNU Assembler @section The GNU Assembler +@c man begin DESCRIPTION + @sc{gnu} @code{as} is really a family of assemblers. @ifclear GENERIC This manual describes @code{@value{AS}}, a member of that family which is @@ -923,6 +980,8 @@ assembler for the same architecture; for example, we know of several incompatible versions of 680x0 assembly language syntax. @end ifset +@c man end + Unlike older assemblers, @code{@value{AS}} is designed to assemble a source program in one pass of the source file. This has a subtle impact on the @kbd{.org} directive (@pxref{Org,,@code{.org}}). @@ -960,6 +1019,7 @@ SOM or ELF format object files. @section Command Line @cindex command line conventions + After the program name @code{@value{AS}}, the command line may contain options and file names. Options may appear in any order, and may be before, after, or between file names. The order of file names is @@ -1003,6 +1063,7 @@ doesn't change the meaning of the source. The source program is a concatenation of the text in all the files, in the order specified. +@c man begin DESCRIPTION Each time you run @code{@value{AS}} it assembles exactly one source program. The source program is made up of one or more files. (The standard input is also a file.) @@ -1023,6 +1084,8 @@ in your command line. If the source is empty, @code{@value{AS}} produces a small, empty object file. +@c man end + @subheading Filenames and Line-numbers @cindex input file linenumbers @@ -1080,6 +1143,8 @@ information for the debugger. @node Errors @section Error and Warning Messages +@c man begin DESCRIPTION + @cindex error messages @cindex warning messages @cindex messages from assembler @@ -1089,6 +1154,8 @@ runs @code{@value{AS}} automatically. Warnings report an assumption made so that @code{@value{AS}} could keep assembling a flawed program; errors report a grave problem that stops the assembly. +@c man end + @cindex format of warning messages Warning messages have the format @@ -1139,6 +1206,8 @@ to the @value{TARGET}. to particular machine architectures. @end ifset +@c man begin DESCRIPTION + If you are invoking @code{@value{AS}} via the @sc{gnu} C compiler (version 2), you can use the @samp{-Wa} option to pass arguments through to the assembler. The assembler arguments must be separated from each other (and the @samp{-Wa}) @@ -1159,6 +1228,8 @@ command-line options are automatically passed to the assembler by the compiler. precisely what options it passes to each compilation pass, including the assembler.) +@c man end + @menu * a:: -a[cdhlns] enable listings * D:: -D for compatibility diff --git a/gas/testsuite/gas/mips/mips.exp b/gas/testsuite/gas/mips/mips.exp index 960208d..82207b9 100644 --- a/gas/testsuite/gas/mips/mips.exp +++ b/gas/testsuite/gas/mips/mips.exp @@ -1,7 +1,7 @@ # # Some generic MIPS tests # -if [istarget mips*-*-*] then { +if { [istarget mips*-*-*] } then { set no_mips16 0 set svr4pic [expr [istarget *-*-elf*] || [istarget *-*-irix5*] || [istarget *-*-irix6* ] || [istarget *-*-linux*] ] set empic [expr [istarget *-*-ecoff*] || [istarget *-*-ultrix*] || [istarget *-*-irix\[1-4\]*] ] diff --git a/ld/ChangeLog b/ld/ChangeLog index 9f8c66b..e09cdd0 100644 --- a/ld/ChangeLog +++ b/ld/ChangeLog @@ -1,3 +1,12 @@ +2001-03-25 Stephane Carrez <Stephane.Carrez@worldnet.fr> + + * ld.texinfo: Put @c man indications to generate the ld man page. + When generating man, define all the variables. Define SEEALSO + and SYNOPSIS. Re-organize some lines to avoid the cross references. + * Makefile.am (MANCONF, TEXI2POD, POD2MAN): New variables. + (ld.1): Generate from ld.texinfo. + * Makefile.in: Regenerate. + 2001-03-23 Mark Elbrecht <snowball3@bigfoot.com> * scripttempl/i386go32.sc: Support the GCC flags '-ffunction-sections' diff --git a/ld/Makefile.am b/ld/Makefile.am index 3d5931d..2cdbf78 100644 --- a/ld/Makefile.am +++ b/ld/Makefile.am @@ -41,6 +41,13 @@ MKDEP = gcc -MM # What version of the manual to build DOCVER = gen +# Options to extract the man page from ld.texinfo +MANCONF = -Dman + +TEXI2POD = perl $(BASEDIR)/etc/texi2pod.pl + +POD2MAN = pod2man --center="GNU" --release="binutils-$(VERSION)" --section=1 + #stuff for self hosting (can be overridden in config file). HOSTING_CRT0 = @HOSTING_CRT0@ HOSTING_LIBS = @HOSTING_LIBS@ @@ -900,6 +907,17 @@ ld.dvi: $(srcdir)/ld.texinfo configdoc.texi ldver.texi TEXINPUTS=$(top_srcdir)/../texinfo:$$TEXINPUTS \ MAKEINFO="$(MAKEINFO) -I $(srcdir) -I $(BFDDIR)/doc" $(TEXI2DVI) $(srcdir)/ld.texinfo +# Build the man page from the texinfo file +# The sed command removes the no-adjust Nroff command so that +# the man output looks standard. +$(srcdir)/ld.1: $(srcdir)/ld.texinfo + touch $(srcdir)/ld.1 + -$(TEXI2POD) $(MANCONF) < $(srcdir)/ld.texinfo > ld.pod + -($(POD2MAN) ld.pod | \ + sed -e '/^.if n .na/d' > $(srcdir)/ld.1.T$$$$ && \ + mv -f $(srcdir)/ld.1.T$$$$ $(srcdir)/ld.1) || \ + (rm -f $(srcdir)/ld.1.T$$$$ && exit 1) + MAINTAINERCLEANFILES = ldver.texi # We want to reconfigure if configure.host or configure.tgt changes. diff --git a/ld/Makefile.in b/ld/Makefile.in index 221ac4f..11f1f65 100644 --- a/ld/Makefile.in +++ b/ld/Makefile.in @@ -145,55 +145,32 @@ MKDEP = gcc -MM # What version of the manual to build DOCVER = gen +# Options to extract the man page from ld.texinfo +MANCONF = -Dman + +TEXI2POD = perl $(BASEDIR)/etc/texi2pod.pl + +POD2MAN = pod2man --center="GNU" --release="binutils-$(VERSION)" --section=1 + #stuff for self hosting (can be overridden in config file). HOSTING_CRT0 = @HOSTING_CRT0@ HOSTING_LIBS = @HOSTING_LIBS@ HOSTING_EMU = -m $(EMUL) # Setup the testing framework, if you have one -EXPECT = `if [ -f $$r/../expect/expect ] ; \ - then echo $$r/../expect/expect ; \ - else echo expect ; fi` +EXPECT = `if [ -f $$r/../expect/expect ] ; then echo $$r/../expect/expect ; else echo expect ; fi` -RUNTEST = `if [ -f $${srcroot}/../dejagnu/runtest ] ; \ - then echo $${srcroot}/../dejagnu/runtest ; \ - else echo runtest ; fi` +RUNTEST = `if [ -f $${srcroot}/../dejagnu/runtest ] ; then echo $${srcroot}/../dejagnu/runtest ; else echo runtest ; fi` RUNTESTFLAGS = -CC_FOR_TARGET = ` \ - if [ -f $$r/../gcc/xgcc ] ; then \ - if [ -f $$r/../newlib/Makefile ] ; then \ - echo $$r/../gcc/xgcc -B$$r/../gcc/ -idirafter $$r/../newlib/targ-include -idirafter $${srcroot}/../newlib/libc/include -nostdinc; \ - else \ - echo $$r/../gcc/xgcc -B$$r/../gcc/; \ - fi; \ - else \ - if [ "@host@" = "@target@" ] ; then \ - echo $(CC); \ - else \ - echo gcc | sed '$(transform)'; \ - fi; \ - fi` +CC_FOR_TARGET = ` if [ -f $$r/../gcc/xgcc ] ; then if [ -f $$r/../newlib/Makefile ] ; then echo $$r/../gcc/xgcc -B$$r/../gcc/ -idirafter $$r/../newlib/targ-include -idirafter $${srcroot}/../newlib/libc/include -nostdinc; else echo $$r/../gcc/xgcc -B$$r/../gcc/; fi; else if [ "@host@" = "@target@" ] ; then echo $(CC); else echo gcc | sed '$(transform)'; fi; fi` CXX = gcc -CXX_FOR_TARGET = ` \ - if [ -f $$r/../gcc/xgcc ] ; then \ - if [ -f $$r/../newlib/Makefile ] ; then \ - echo $$r/../gcc/xgcc -B$$r/../gcc/ -idirafter $$r/../newlib/targ-include -idirafter $${srcroot}/../newlib/libc/include -nostdinc; \ - else \ - echo $$r/../gcc/xgcc -B$$r/../gcc/; \ - fi; \ - else \ - if [ "@host@" = "@target@" ] ; then \ - echo $(CXX); \ - else \ - echo gcc | sed '$(transform)'; \ - fi; \ - fi` +CXX_FOR_TARGET = ` if [ -f $$r/../gcc/xgcc ] ; then if [ -f $$r/../newlib/Makefile ] ; then echo $$r/../gcc/xgcc -B$$r/../gcc/ -idirafter $$r/../newlib/targ-include -idirafter $${srcroot}/../newlib/libc/include -nostdinc; else echo $$r/../gcc/xgcc -B$$r/../gcc/; fi; else if [ "@host@" = "@target@" ] ; then echo $(CXX); else echo gcc | sed '$(transform)'; fi; fi` noinst_PROGRAMS = ld-new @@ -206,182 +183,25 @@ INCLUDES = -D_GNU_SOURCE -I. -I$(srcdir) -I../bfd -I$(BFDDIR) -I$(INCDIR) -I$(to BFDLIB = ../bfd/libbfd.la LIBIBERTY = ../libiberty/libiberty.a -ALL_EMULATIONS = \ - ea29k.o \ - eaixppc.o \ - eaixrs6.o \ - ealpha.o \ - earcelf.o \ - earm_epoc_pe.o \ - earmaoutb.o \ - earmaoutl.o \ - earmcoff.o \ - earmelf.o \ - earmelf_linux.o \ - earmelf_oabi.o \ - earmnbsd.o \ - earmpe.o \ - eavr1200.o \ - eavr23xx.o \ - eavr4433.o \ - eavr44x4.o \ - eavr85xx.o \ - eavrmega103.o \ - eavrmega161.o \ - eavrmega603.o \ - ecoff_sparc.o \ - ecrisaout.o \ - ecriself.o \ - ecrislinux.o \ - ed10velf.o \ - ed30v_e.o \ - ed30v_o.o \ - ed30velf.o \ - edelta68.o \ - eebmon29k.o \ - eelf32_i960.o \ - eelf32_i860.o \ - eelf32_sparc.o \ - eelf32b4300.o \ - eelf32bmip.o \ - eelf32bmipn32.o \ - eelf32btsmip.o \ - eelf32ebmip.o \ - eelf32elmip.o \ - eelf32fr30.o \ - eelf32i370.o \ - eelf32l4300.o \ - eelf32lmip.o \ - eelf32lppc.o \ - eelf32lppcsim.o \ - eelf32mcore.o \ - eelf32ppc.o \ - eelf32ppclinux.o \ - eelf32ppcsim.o \ - eelf_i386.o \ - eelf_i386_be.o \ - eelf_i386_chaos.o \ - eelf_s390.o \ - egld960.o \ - egld960coff.o \ - eh8300.o \ - eh8300h.o \ - eh8300s.o \ - eh8500.o \ - eh8500b.o \ - eh8500c.o \ - eh8500m.o \ - eh8500s.o \ - ehp300bsd.o \ - ehp3hpux.o \ - ehppaelf.o \ - ehppalinux.o \ - ei386aout.o \ - ei386beos.o \ - ei386bsd.o \ - ei386coff.o \ - ei386go32.o \ - ei386linux.o \ - ei386lynx.o \ - ei386mach.o \ - ei386moss.o \ - ei386msdos.o \ - ei386nbsd.o \ - ei386nw.o \ - ei386pe.o \ - ei386pe_posix.o \ - elnk960.o \ - em68hc11elf.o \ - em68hc11elfb.o \ - em68hc12elf.o \ - em68hc12elfb.o \ - em68k4knbsd.o \ - em68kaout.o \ - em68kaux.o \ - em68kcoff.o \ - em68kelf.o \ - em68klinux.o \ - em68klynx.o \ - em68knbsd.o \ - em68kpsos.o \ - em88kbcs.o \ - emcorepe.o \ - emipsbig.o \ - emipsbsd.o \ - emipsidt.o \ - emipsidtl.o \ - emipslit.o \ - emipslnews.o \ - emipspe.o \ - enews.o \ - ens32knbsd.o \ - epc532macha.o \ - epdp11.o \ - epjelf.o \ - epjlelf.o \ - eppcmacos.o \ - eppcnw.o \ - eppcpe.o \ - eriscix.o \ - esa29200.o \ - esh.o \ - eshelf.o \ - eshelf_linux.o \ - eshlelf_linux.o \ - eshl.o \ - eshlelf.o \ - eshpe.o \ - esparcaout.o \ - esparclinux.o \ - esparclynx.o \ - esparcnbsd.o \ - est2000.o \ - esun3.o \ - esun4.o \ - etic30aout.o \ - etic30coff.o \ - etic54xcoff.o \ - etic80coff.o \ - evanilla.o \ - evax.o \ - evsta.o \ - ew65.o \ - ez8001.o \ - ez8002.o - - -ALL_64_EMULATIONS = \ - eelf64_aix.o \ - eelf64_ia64.o \ - eelf_x86_64.o \ - eelf64_s390.o \ - eelf64_sparc.o \ - eelf64alpha.o \ - eelf64bmip.o \ - eelf64hppa.o - - -ALL_EMUL_EXTRA_OFILES = \ - deffilep.o \ - pe-dll.o - - -CFILES = ldctor.c ldemul.c ldexp.c ldfile.c ldlang.c \ - ldmain.c ldmisc.c ldver.c ldwrite.c lexsup.c \ - mri.c ldcref.c pe-dll.c - - -HFILES = ld.h ldctor.h ldemul.h ldexp.h ldfile.h \ - ldlang.h ldlex.h ldmain.h ldmisc.h ldver.h \ - ldwrite.h mri.h deffile.h pe-dll.h +ALL_EMULATIONS = ea29k.o eaixppc.o eaixrs6.o ealpha.o earcelf.o earm_epoc_pe.o earmaoutb.o earmaoutl.o earmcoff.o earmelf.o earmelf_linux.o earmelf_oabi.o earmnbsd.o earmpe.o eavr1200.o eavr23xx.o eavr4433.o eavr44x4.o eavr85xx.o eavrmega103.o eavrmega161.o eavrmega603.o ecoff_sparc.o ecrisaout.o ecriself.o ecrislinux.o ed10velf.o ed30v_e.o ed30v_o.o ed30velf.o edelta68.o eebmon29k.o eelf32_i960.o eelf32_i860.o eelf32_sparc.o eelf32b4300.o eelf32bmip.o eelf32bmipn32.o eelf32btsmip.o eelf32ebmip.o eelf32elmip.o eelf32fr30.o eelf32i370.o eelf32l4300.o eelf32lmip.o eelf32lppc.o eelf32lppcsim.o eelf32mcore.o eelf32ppc.o eelf32ppclinux.o eelf32ppcsim.o eelf_i386.o eelf_i386_be.o eelf_i386_chaos.o eelf_s390.o egld960.o egld960coff.o eh8300.o eh8300h.o eh8300s.o eh8500.o eh8500b.o eh8500c.o eh8500m.o eh8500s.o ehp300bsd.o ehp3hpux.o ehppaelf.o ehppalinux.o ei386aout.o ei386beos.o ei386bsd.o ei386coff.o ei386go32.o ei386linux.o ei386lynx.o ei386mach.o ei386moss.o ei386msdos.o ei386nbsd.o ei386nw.o ei386pe.o ei386pe_posix.o elnk960.o em68hc11elf.o em68hc11elfb.o em68hc12elf.o em68hc12elfb.o em68k4knbsd.o em68kaout.o em68kaux.o em68kcoff.o em68kelf.o em68klinux.o em68klynx.o em68knbsd.o em68kpsos.o em88kbcs.o emcorepe.o emipsbig.o emipsbsd.o emipsidt.o emipsidtl.o emipslit.o emipslnews.o emipspe.o enews.o ens32knbsd.o epc532macha.o epdp11.o epjelf.o epjlelf.o eppcmacos.o eppcnw.o eppcpe.o eriscix.o esa29200.o esh.o eshelf.o eshelf_linux.o eshlelf_linux.o eshl.o eshlelf.o eshpe.o esparcaout.o esparclinux.o esparclynx.o esparcnbsd.o est2000.o esun3.o esun4.o etic30aout.o etic30coff.o etic54xcoff.o etic80coff.o evanilla.o evax.o evsta.o ew65.o ez8001.o ez8002.o + + +ALL_64_EMULATIONS = eelf64_aix.o eelf64_ia64.o eelf_x86_64.o eelf64_s390.o eelf64_sparc.o eelf64alpha.o eelf64bmip.o eelf64hppa.o + + +ALL_EMUL_EXTRA_OFILES = deffilep.o pe-dll.o + + +CFILES = ldctor.c ldemul.c ldexp.c ldfile.c ldlang.c ldmain.c ldmisc.c ldver.c ldwrite.c lexsup.c mri.c ldcref.c pe-dll.c + + +HFILES = ld.h ldctor.h ldemul.h ldexp.h ldfile.h ldlang.h ldlex.h ldmain.h ldmisc.h ldver.h ldwrite.h mri.h deffile.h pe-dll.h GENERATED_CFILES = ldgram.c ldlex.c deffilep.c GENERATED_HFILES = ldgram.h ldemul-list.h deffilep.h -OFILES = ldgram.o ldlex.o lexsup.o ldlang.o mri.o ldctor.o ldmain.o \ - ldwrite.o ldexp.o ldemul.o ldver.o ldmisc.o \ - ldfile.o ldcref.o ${EMULATION_OFILES} ${EMUL_EXTRA_OFILES} +OFILES = ldgram.o ldlex.o lexsup.o ldlang.o mri.o ldctor.o ldmain.o ldwrite.o ldexp.o ldemul.o ldver.o ldmisc.o ldfile.o ldcref.o ${EMULATION_OFILES} ${EMUL_EXTRA_OFILES} STAGESTUFF = *.o ldscripts/* e*.c @@ -400,8 +220,7 @@ GEN_DEPENDS = $(srcdir)/genscripts.sh stringify.sed # We need this for automake to use YLWRAP. EXTRA_ld_new_SOURCES = deffilep.y -ld_new_SOURCES = ldgram.y ldlex.l lexsup.c ldlang.c mri.c ldctor.c ldmain.c \ - ldwrite.c ldexp.c ldemul.c ldver.c ldmisc.c ldfile.c ldcref.c +ld_new_SOURCES = ldgram.y ldlex.l lexsup.c ldlang.c mri.c ldctor.c ldmain.c ldwrite.c ldexp.c ldemul.c ldver.c ldmisc.c ldfile.c ldcref.c ld_new_DEPENDENCIES = $(EMULATION_OFILES) $(EMUL_EXTRA_OFILES) $(BFDLIB) $(LIBIBERTY) $(INTLDEPS) ld_new_LDADD = $(EMULATION_OFILES) $(EMUL_EXTRA_OFILES) $(BFDLIB) $(LIBIBERTY) $(INTLLIBS) @@ -411,8 +230,7 @@ TESTBFDLIB = @TESTBFDLIB@ MAINTAINERCLEANFILES = ldver.texi -MOSTLYCLEANFILES = $(STAGESTUFF) ld1$(EXEEXT) ld2$(EXEEXT) ld3$(EXEEXT) \ - ldemul-list.h crtbegin.o crtend.o ld.log ld.sum +MOSTLYCLEANFILES = $(STAGESTUFF) ld1$(EXEEXT) ld2$(EXEEXT) ld3$(EXEEXT) ldemul-list.h crtbegin.o crtend.o ld.log ld.sum CLEANFILES = dep.sed DEP DEPA DEP1 DEP2 @@ -854,7 +672,7 @@ distdir: $(DISTFILES) @for file in $(DISTFILES); do \ if test -f $$file; then d=.; else d=$(srcdir); fi; \ if test -d $$d/$$file; then \ - cp -pr $$d/$$file $(distdir)/$$file; \ + cp -pr $$/$$file $(distdir)/$$file; \ else \ test -f $(distdir)/$$file \ || ln $$d/$$file $(distdir)/$$file 2> /dev/null \ @@ -1603,6 +1421,17 @@ ld.dvi: $(srcdir)/ld.texinfo configdoc.texi ldver.texi TEXINPUTS=$(top_srcdir)/../texinfo:$$TEXINPUTS \ MAKEINFO="$(MAKEINFO) -I $(srcdir) -I $(BFDDIR)/doc" $(TEXI2DVI) $(srcdir)/ld.texinfo +# Build the man page from the texinfo file +# The sed command removes the no-adjust Nroff command so that +# the man output looks standard. +$(srcdir)/ld.1: $(srcdir)/ld.texinfo + touch $(srcdir)/ld.1 + -$(TEXI2POD) $(MANCONF) < $(srcdir)/ld.texinfo > ld.pod + -($(POD2MAN) ld.pod | \ + sed -e '/^.if n .na/d' > $(srcdir)/ld.1.T$$$$ && \ + mv -f $(srcdir)/ld.1.T$$$$ $(srcdir)/ld.1) || \ + (rm -f $(srcdir)/ld.1.T$$$$ && exit 1) + # We want to reconfigure if configure.host or configure.tgt changes. config.status: $(srcdir)/configure $(srcdir)/configure.host $(srcdir)/configure.tgt $(SHELL) ./config.status --recheck @@ -1,1508 +1,1668 @@ -.\" Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, -.\" 2001 Free Software Foundation, Inc. -.\" See section COPYING for conditions for redistribution -.TH ld 1 "" "Free Software Foundation" "GNU Development Tools" -.de BP -.sp -.ti \-.2i -\(** -.. - -.SH NAME -ld \- the GNU linker - -.SH SYNOPSIS -.hy 0 -.na -.TP -.B ld -.RB "[\|" \-o " -.I output\c -\&\|] \c -.I objfile\c -\&.\|.\|. +.rn '' }` +''' $RCSfile$$Revision$$Date$ +''' +''' $Log$ +''' Revision 1.9 2001/03/25 20:32:31 nickc +''' Automate generate on man pages +''' +''' +.de Sh .br -.RB "[\|" \-A\c -.I architecture\c -\&\|] -.RB "[\|" "\-b\ "\c -.I input-format\c -\&\|] -.RB "[\|" \-Bstatic "\|]" -.RB "[\|" \-Bgroup "\|]" -.RB "[\|" \-Bdynamic "\|]" -.RB "[\|" \-Bsymbolic "\|]" -.RB "[\|" "\-c\ "\c -.I commandfile\c -\&\|] -.RB "[\|" \-\-cref "\|]" -.RB "[\|" \-d | \-dc | \-dp\c -\|] +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp +.if t .sp .5v +.if n .sp +.. +.de Ip .br -.RB "[\|" "\-defsym\ "\c -.I symbol\c -\&=\c -.I expression\c -\&\|] -.RB "[\|" \-\-demangle "\|]" -.RB "[\|" \-\-no\-demangle "\|]" -.RB "[\|" "\-e\ "\c -.I entry\c -\&\|] -.RB "[\|" \-embedded\-relocs "\|]" -.RB "[\|" \-E "\|]" -.RB "[\|" \-export\-dynamic "\|]" -.RB "[\|" "\-f\ "\c -.I name\c -\&\|] -.RB "[\|" "\-\-auxiliary\ "\c -.I name\c -\&\|] -.RB "[\|" "\-F\ "\c -.I name\c -\&\|] -.RB "[\|" "\-\-filter\ "\c -.I name\c -\&\|] -.RB "[\|" "\-format\ "\c -.I input-format\c -\&\|] -.RB "[\|" \-g "\|]" -.RB "[\|" \-G -.I size\c -\&\|] -.RB "[\|" "\-h\ "\c -.I name\c -\&\|] -.RB "[\|" "\-soname\ "\c -.I name\c -\&\|] -.RB "[\|" \-\-help "\|]" -.RB "[\|" \-i "\|]" -.RB "[\|" \-l\c -.I ar\c -\&\|] -.RB "[\|" \-L\c -.I searchdir\c -\&\|] -.RB "[\|" \-M "\|]" -.RB "[\|" \-Map -.I mapfile\c -\&\|] -.RB "[\|" \-m -.I emulation\c -\&\|] -.RB "[\|" \-n | \-N "\|]" -.RB "[\|" \-noinhibit-exec "\|]" -.RB "[\|" \-no\-keep\-memory "\|]" -.RB "[\|" \-no\-warn\-mismatch "\|]" -.RB "[\|" \-O\c -.I level\c -\&\|] -.RB "[\|" "\--oformat\ "\c -.I output-format\c -\&\|] -.RB "[\|" "\-R\ "\c -.I filename\c -\&\|] -.RB "[\|" \-relax "\|]" -.RB "[\|" \-r | \-Ur "\|]" -.RB "[\|" "\-rpath\ "\c -.I directory\c -\&\|] -.RB "[\|" "\-rpath\-link\ "\c -.I directory\c -\&\|] -.RB "[\|" \-S "\|]" -.RB "[\|" \-s "\|]" -.RB "[\|" \-shared "\|]" -.RB "[\|" \-sort\-common "\|]" -.RB "[\|" "\-split\-by\-reloc\ "\c -.I count\c -\&\|] -.RB "[\|" \-split\-by\-file "\|]" -.RB "[\|" "\-T\ "\c -.I commandfile\c -\&\|] -.RB "[\|" "\-\-section\-start\ "\c -.I sectionname\c -\&=\c -.I sectionorg\c -\&\|] -.RB "[\|" "\-Ttext\ "\c -.I textorg\c -\&\|] -.RB "[\|" "\-Tdata\ "\c -.I dataorg\c -\&\|] -.RB "[\|" "\-Tbss\ "\c -.I bssorg\c -\&\|] -.RB "[\|" \-t "\|]" -.RB "[\|" "\-u\ "\c -.I sym\c -\&] -.RB "[\|" \-V "\|]" -.RB "[\|" \-v "\|]" -.RB "[\|" \-\-verbose "\|]" -.RB "[\|" \-\-version "\|]" -.RB "[\|" \-warn\-common "\|]" -.RB "[\|" \-warn\-constructors "\|]" -.RB "[\|" \-warn\-multiple\-gp "\|]" -.RB "[\|" \-warn\-once "\|]" -.RB "[\|" \-warn\-section\-align "\|]" -.RB "[\|" \-\-whole\-archive "\|]" -.RB "[\|" \-\-no\-whole\-archive "\|]" -.RB "[\|" "\-\-wrap\ "\c -.I symbol\c -\&\|] -.RB "[\|" \-X "\|]" -.RB "[\|" \-x "\|]" -.ad b -.hy 1 -.SH DESCRIPTION -\c -.B ld\c -\& combines a number of object and archive files, relocates -their data and ties up symbol references. Often the last step in -building a new compiled program to run is a call to \c -.B ld\c -\&. - -\c -.B ld\c -\& accepts Linker Command Language files -to provide explicit and total control over the linking process. -This man page does not describe the command language; see the `\|\c -.B ld\c -\|' entry in `\|\c -.B info\c -\|', or the manual -.I -ld: the GNU linker -\&, for full details on the command language and on other aspects of -the GNU linker. - -This version of \c -.B ld\c -\& uses the general purpose BFD libraries -to operate on object files. This allows \c -.B ld\c -\& to read, combine, and -write object files in many different formats\(em\&for example, COFF or -\c -.B a.out\c -\&. Different formats may be linked together to produce any -available kind of object file. You can use `\|\c -.B objdump \-i\c -\|' to get a list of formats supported on various architectures; see -.BR objdump ( 1 ). +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb +.ft CW +.nf +.ne \\$1 +.. +.de Ve +.ft R +.fi +.. +''' +''' +''' Set up \*(-- to give an unbreakable dash; +''' string Tr holds user defined translation string. +''' Bell System Logo is used as a dummy character. +''' +.tr \(*W-|\(bv\*(Tr +.ie n \{\ +.ds -- \(*W- +.ds PI pi +.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +.ds L" "" +.ds R" "" +''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of +''' \*(L" and \*(R", except that they are used on ".xx" lines, +''' such as .IP and .SH, which do another additional levels of +''' double-quote interpretation +.ds M" """ +.ds S" """ +.ds N" """"" +.ds T" """"" +.ds L' ' +.ds R' ' +.ds M' ' +.ds S' ' +.ds N' ' +.ds T' ' +'br\} +.el\{\ +.ds -- \(em\| +.tr \*(Tr +.ds L" `` +.ds R" '' +.ds M" `` +.ds S" '' +.ds N" `` +.ds T" '' +.ds L' ` +.ds R' ' +.ds M' ` +.ds S' ' +.ds N' ` +.ds T' ' +.ds PI \(*p +'br\} +.\" If the F register is turned on, we'll generate +.\" index entries out stderr for the following things: +.\" TH Title +.\" SH Header +.\" Sh Subsection +.\" Ip Item +.\" X<> Xref (embedded +.\" Of course, you have to process the output yourself +.\" in some meaninful fashion. +.if \nF \{ +.de IX +.tm Index:\\$1\t\\n%\t"\\$2" +.. +.nr % 0 +.rr F +.\} +.TH LD 1 "binutils-2.11.90" "23/Mar/101" "GNU" +.UC +.if n .hy 0 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.de CQ \" put $1 in typewriter font +.ft CW +'if n "\c +'if t \\&\\$1\c +'if n \\&\\$1\c +'if n \&" +\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 +'.ft R +.. +.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 +. \" AM - accent mark definitions +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds ? ? +. ds ! ! +. ds / +. ds q +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' +. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] +.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' +.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' +.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +.ds oe o\h'-(\w'o'u*4/10)'e +.ds Oe O\h'-(\w'O'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds v \h'-1'\o'\(aa\(ga' +. ds _ \h'-1'^ +. ds . \h'-1'. +. ds 3 3 +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +. ds oe oe +. ds Oe OE +.\} +.rm #[ #] #H #V #F C +.SH "NAME" +ld \- Using LD, the GNU linker +.SH "SYNOPSIS" +ld [ options ] objfile... +.SH "DESCRIPTION" +\f(CWld\fR combines a number of object and archive files, relocates +their data and ties up symbol references. Usually the last step in +compiling a program is to run \f(CWld\fR. +.PP +\f(CWld\fR accepts Linker Command Language files written in +a superset of AT&T's Link Editor Command Language syntax, +to provide explicit and total control over the linking process. +.PP +This man page does not describe the command language; see the +\f(CWld\fR entry in \f(CWinfo\fR, or the manual +ld: the GNU linker, for full details on the command language and +on other aspects of the GNU linker. +.PP +This version of \f(CWld\fR uses the general purpose BFD libraries +to operate on object files. This allows \f(CWld\fR to read, combine, and +write object files in many different formats---for example, COFF or +\f(CWa.out\fR. Different formats may be linked together to produce any +available kind of object file. +.PP Aside from its flexibility, the GNU linker is more helpful than other linkers in providing diagnostic information. Many linkers abandon execution immediately upon encountering an error; whenever possible, -\c -.B ld\c -\& continues executing, allowing you to identify other errors +\f(CWld\fR continues executing, allowing you to identify other errors (or, in some cases, to get an output file in spite of the error). - -The GNU linker \c -.B ld\c -\& is meant to cover a broad range of situations, +.PP +The GNU linker \f(CWld\fR is meant to cover a broad range of situations, and to be as compatible as possible with other linkers. As a result, -you have many choices to control its behavior through the command line, -and through environment variables. - -.SH OPTIONS -The plethora of command-line options may seem intimidating, but in -actual practice few of them are used in any particular context. -For instance, a frequent use of \c -.B ld\c -\& is to link standard Unix +you have many choices to control its behavior. +.SH "OPTIONS" +The linker supports a plethora of command-line options, but in actual +practice few of them are used in any particular context. +For instance, a frequent use of \f(CWld\fR is to link standard Unix object files on a standard, supported Unix system. On such a system, to -link a file \c -.B hello.o\c -\&: -.sp -.br -$\ ld\ \-o\ output\ /lib/crt0.o\ hello.o\ \-lc -.br -.sp -This tells \c -.B ld\c -\& to produce a file called \c -.B output\c -\& as the -result of linking the file \c -.B /lib/crt0.o\c -\& with \c -.B hello.o\c -\& and -the library \c -.B libc.a\c -\& which will come from the standard search -directories. - -The command-line options to \c -.B ld\c -\& may be specified in any order, and -may be repeated at will. For the most part, repeating an option with a +link a file \f(CWhello.o\fR: +.PP +.Vb 2 +\& +\& ld -o I<output> /lib/crt0.o hello.o -lc +.Ve +This tells \f(CWld\fR to produce a file called \fIoutput\fR as the +result of linking the file \f(CW/lib/crt0.o\fR with \f(CWhello.o\fR and +the library \f(CWlibc.a\fR, which will come from the standard search +directories. (See the discussion of the \fB\-l\fR option below.) +.PP +Some of the command-line options to \f(CWld\fR may be specified at any +point in the command line. However, options which refer to files, such +as \fB\-l\fR or \fB\-T\fR, cause the file to be read at the point at +which the option appears in the command line, relative to the object +files and other file options. Repeating non-file options with a different argument will either have no further effect, or override prior -occurrences (those further to the left on the command line) of an -option. - -The exceptions\(em\&which may meaningfully be used more than once\(em\&are -\c -.B \-A\c -\&, \c -.B \-b\c -\& (or its synonym \c -.B \-format\c -\&), \c -.B \-defsym\c -\&, \c -.B \-\-section\-start\c -\&, \c -.B \-L\c -\&, \c -.B \-l\c -\&, \c -.B \-R\c -\&, and \c -.B \-u\c -\&. - -The list of object files to be linked together, shown as \c -.I objfile\c -\&, -may follow, precede, or be mixed in with command-line options; save that -an \c -.I objfile\c -\& argument may not be placed between an option flag and -its argument. - -Usually the linker is invoked with at least one object file, but other -forms of binary input files can also be specified with \c -.B \-l\c -\&, -\c -.B \-R\c -\&, and the script command language. If \c -.I no\c -\& binary input -files at all are specified, the linker does not produce any output, and -issues the message `\|\c -.B No input files\c -\|'. - -Option arguments must either follow the option letter without intervening +occurrences (those further to the left on the command line) of that +option. Options which may be meaningfully specified more than once are +noted in the descriptions below. +.PP +Non-option arguments are object files or archives which are to be linked +together. They may follow, precede, or be mixed in with command-line +options, except that an object file argument may not be placed between +an option and its argument. +.PP +Usually the linker is invoked with at least one object file, but you can +specify other forms of binary input files using \fB\-l\fR, \fB\-R\fR, +and the script command language. If \fIno\fR binary input files at all +are specified, the linker does not produce any output, and issues the +message \fBNo input files\fR. +.PP +If the linker can not recognize the format of an object file, it will +assume that it is a linker script. A script specified in this way +augments the main linker script used for the link (either the default +linker script or the one specified by using \fB\-T\fR). This feature +permits the linker to link against a file which appears to be an object +or an archive, but actually merely defines some symbol values, or uses +\f(CWINPUT\fR or \f(CWGROUP\fR to load other objects. Note that +specifying a script in this way should only be used to augment the main +linker script; if you want to use some command that logically can only +appear once, such as the \f(CWSECTIONS\fR or \f(CWMEMORY\fR command, you +must replace the default linker script using the \fB\-T\fR option. +.PP +For options whose names are a single letter, +option arguments must either follow the option letter without intervening whitespace, or be given as separate arguments immediately following the option that requires them. - -.TP -.BI "-A" "architecture" -In the current release of \c -.B ld\c -\&, this option is useful only for the -Intel 960 family of architectures. In that \c -.B ld\c -\& configuration, the -\c -.I architecture\c -\& argument is one of the two-letter names identifying -members of the 960 family; the option specifies the desired output -target, and warns of any incompatible instructions in the input files. -It also modifies the linker's search strategy for archive libraries, to -support the use of libraries specific to each particular -architecture, by including in the search loop names suffixed with the -string identifying the architecture. - -For example, if your \c -.B ld\c -\& command line included `\|\c -.B \-ACA\c -\|' as -well as `\|\c -.B \-ltry\c -\|', the linker would look (in its built-in search -paths, and in any paths you specify with \c -.B \-L\c -\&) for a library with -the names -.sp -.br -try -.br -libtry.a -.br -tryca -.br -libtryca.a -.br -.sp - -The first two possibilities would be considered in any event; the last -two are due to the use of `\|\c -.B \-ACA\c -\|'. - -Future releases of \c -.B ld\c -\& may support similar functionality for +.PP +For options whose names are multiple letters, either one dash or two can +precede the option name; for example, \fB\-trace-symbol\fR and +\fB--trace-symbol\fR are equivalent. Note \- there is one exception to +this rule. Multiple letter options that start with a lower case \*(L'o\*(R' can +only be preceeded by two dashes. This is to reduce confusion with the +\fB\-o\fR option. So for example \fB\-omagic\fR sets the output file +name to \fBmagic\fR whereas \fB--omagic\fR sets the NMAGIC flag on the +output. +.PP +Arguments to multiple-letter options must either be separated from the +option name by an equals sign, or be given as separate arguments +immediately following the option that requires them. For example, +\fB--trace-symbol foo\fR and \fB--trace-symbol=foo\fR are equivalent. +Unique abbreviations of the names of multiple-letter options are +accepted. +.PP +Note \- if the linker is being invoked indirectly, via a compiler driver +(eg \fBgcc\fR) then all the linker command line options should be +prefixed by \fB\-Wl,\fR (or whatever is appropriate for the particular +compiler driver) like this: +.PP +.Vb 2 +\& +\& gcc -Wl,--startgroup foo.o bar.o -Wl,--endgroup +.Ve +This is important, because otherwise the compiler driver program may +silently drop the linker options, resulting in a bad link. +.PP +Here is a table of the generic command line switches accepted by the GNU +linker: +.Ip "\f(CW-a\fIkeyword\fR\fR" 4 +This option is supported for \s-1HP/UX\s0 compatibility. The \fIkeyword\fR +argument must be one of the strings \fBarchive\fR, \fBshared\fR, or +\fBdefault\fR. \fB\-aarchive\fR is functionally equivalent to +\fB\-Bstatic\fR, and the other two keywords are functionally equivalent +to \fB\-Bdynamic\fR. This option may be used any number of times. +.Ip "\f(CW-A\fIarchitecture\fR\fR" 4 +.Ip "\f(CW--architecture=\fIarchitecture\fR\fR" 4 +In the current release of \f(CWld\fR, this option is useful only for the +Intel 960 family of architectures. In that \f(CWld\fR configuration, the +\fIarchitecture\fR argument identifies the particular architecture in +the 960 family, enabling some safeguards and modifying the +archive-library search path. +.Sp +Future releases of \f(CWld\fR may support similar functionality for other architecture families. - -You can meaningfully use \c -.B \-A\c -\& more than once on a command line, if -an architecture family allows combination of target architectures; each -use will add another pair of name variants to search for when \c -.B \-l -specifies a library. - -.TP -.BI "\-b " "input-format" -Specify the binary format for input object files that follow this option -on the command line. You don't usually need to specify this, as -\c -.B ld\c -\& is configured to expect as a default input format the most -usual format on each machine. \c -.I input-format\c -\& is a text string, the -name of a particular format supported by the BFD libraries. -\c -.B \-format \c -.I input-format\c -\&\c -\& has the same effect, as does the script command -.BR TARGET . - +.Ip "\f(CW-b \fIinput-format\fR\fR" 4 +.Ip "\f(CW--format=\fIinput-format\fR\fR" 4 +\f(CWld\fR may be configured to support more than one kind of object +file. If your \f(CWld\fR is configured this way, you can use the +\fB\-b\fR option to specify the binary format for input object files +that follow this option on the command line. Even when \f(CWld\fR is +configured to support alternative object formats, you don't usually need +to specify this, as \f(CWld\fR should be configured to expect as a +default input format the most usual format on each machine. +\fIinput-format\fR is a text string, the name of a particular format +supported by the \s-1BFD\s0 libraries. (You can list the available binary +formats with \fBobjdump \-i\fR.) +.Sp You may want to use this option if you are linking files with an unusual -binary format. You can also use \c -.B \-b\c -\& to switch formats explicitly (when +binary format. You can also use \fB\-b\fR to switch formats explicitly (when linking object files of different formats), by including -\c -.B \-b \c -.I input-format\c -\&\c -\& before each group of object files in a -particular format. - +\fB\-b\fR \fIinput-format\fR before each group of object files in a +particular format. +.Sp The default format is taken from the environment variable -.B GNUTARGET\c -\&. You can also define the input -format from a script, using the command \c -.B TARGET\c -\&. - -.TP -.B \-Bstatic -Do not link against shared libraries. This is only meaningful on -platforms for which shared libraries are supported. - -.TP -.B \-Bdynamic +\f(CWGNUTARGET\fR. +.Sp +You can also define the input format from a script, using the command +\f(CWTARGET\fR; +.Ip "\f(CW-c \fIMRI-commandfile\fR\fR" 4 +.Ip "\f(CW--mri-script=\fIMRI-commandfile\fR\fR" 4 +For compatibility with linkers produced by \s-1MRI\s0, \f(CWld\fR accepts script +files written in an alternate, restricted command language, described in +the \s-1MRI\s0 Compatible Script Files section of \s-1GNU\s0 ld documentation. +Introduce \s-1MRI\s0 script files with +the option \fB\-c\fR; use the \fB\-T\fR option to run linker +scripts written in the general-purpose \f(CWld\fR scripting language. +If \fI\s-1MRI\s0\-cmdfile\fR does not exist, \f(CWld\fR looks for it in the directories +specified by any \fB\-L\fR options. +.Ip "\f(CW-d\fR" 4 +.Ip "\f(CW-dc\fR" 4 +.Ip "\f(CW-dp\fR" 4 +These three options are equivalent; multiple forms are supported for +compatibility with other linkers. They assign space to common symbols +even if a relocatable output file is specified (with \fB\-r\fR). The +script command \f(CWFORCE_COMMON_ALLOCATION\fR has the same effect. +.Ip "\f(CW-e \fIentry\fR\fR" 4 +.Ip "\f(CW--entry=\fIentry\fR\fR" 4 +Use \fIentry\fR as the explicit symbol for beginning execution of your +program, rather than the default entry point. If there is no symbol +named \fIentry\fR, the linker will try to parse \fIentry\fR as a number, +and use that as the entry address (the number will be interpreted in +base 10; you may use a leading \fB0x\fR for base 16, or a leading +\fB0\fR for base 8). +.Ip "\f(CW-E\fR" 4 +.Ip "\f(CW--export-dynamic\fR" 4 +When creating a dynamically linked executable, add all symbols to the +dynamic symbol table. The dynamic symbol table is the set of symbols +which are visible from dynamic objects at run time. +.Sp +If you do not use this option, the dynamic symbol table will normally +contain only those symbols which are referenced by some dynamic object +mentioned in the link. +.Sp +If you use \f(CWdlopen\fR to load a dynamic object which needs to refer +back to the symbols defined by the program, rather than some other +dynamic object, then you will probably need to use this option when +linking the program itself. +.Ip "\f(CW-EB\fR" 4 +Link big-endian objects. This affects the default output format. +.Ip "\f(CW-EL\fR" 4 +Link little-endian objects. This affects the default output format. +.Ip "\f(CW-f\fR" 4 +.Ip "\f(CW--auxiliary \fIname\fR\fR" 4 +When creating an \s-1ELF\s0 shared object, set the internal \s-1DT_AUXILIARY\s0 field +to the specified name. This tells the dynamic linker that the symbol +table of the shared object should be used as an auxiliary filter on the +symbol table of the shared object \fIname\fR. +.Sp +If you later link a program against this filter object, then, when you +run the program, the dynamic linker will see the \s-1DT_AUXILIARY\s0 field. If +the dynamic linker resolves any symbols from the filter object, it will +first check whether there is a definition in the shared object +\fIname\fR. If there is one, it will be used instead of the definition +in the filter object. The shared object \fIname\fR need not exist. +Thus the shared object \fIname\fR may be used to provide an alternative +implementation of certain functions, perhaps for debugging or for +machine specific performance. +.Sp +This option may be specified more than once. The \s-1DT_AUXILIARY\s0 entries +will be created in the order in which they appear on the command line. +.Ip "\f(CW-F \fIname\fR\fR" 4 +.Ip "\f(CW--filter \fIname\fR\fR" 4 +When creating an \s-1ELF\s0 shared object, set the internal \s-1DT_FILTER\s0 field to +the specified name. This tells the dynamic linker that the symbol table +of the shared object which is being created should be used as a filter +on the symbol table of the shared object \fIname\fR. +.Sp +If you later link a program against this filter object, then, when you +run the program, the dynamic linker will see the \s-1DT_FILTER\s0 field. The +dynamic linker will resolve symbols according to the symbol table of the +filter object as usual, but it will actually link to the definitions +found in the shared object \fIname\fR. Thus the filter object can be +used to select a subset of the symbols provided by the object +\fIname\fR. +.Sp +Some older linkers used the \f(CW-F\fR option throughout a compilation +toolchain for specifying object-file format for both input and output +object files. The \s-1GNU\s0 linker uses other mechanisms for this +purpose: the \f(CW-b\fR, \f(CW--format\fR, \f(CW--oformat\fR options, the +\f(CWTARGET\fR command in linker scripts, and the \f(CWGNUTARGET\fR +environment variable. The \s-1GNU\s0 linker will ignore the \f(CW-F\fR +option when not creating an \s-1ELF\s0 shared object. +.Ip "\f(CW-fini \fIname\fR\fR" 4 +When creating an \s-1ELF\s0 executable or shared object, call \s-1NAME\s0 when the +executable or shared object is unloaded, by setting \s-1DT_FINI\s0 to the +address of the function. By default, the linker uses \f(CW_fini\fR as +the function to call. +.Ip "\f(CW-g\fR" 4 +Ignored. Provided for compatibility with other tools. +.Ip "\f(CW-G\fIvalue\fR\fR" 4 +.Ip "\f(CW--gpsize=\fIvalue\fR\fR" 4 +Set the maximum size of objects to be optimized using the \s-1GP\s0 register to +\fIsize\fR. This is only meaningful for object file formats such as +\s-1MIPS\s0 \s-1ECOFF\s0 which supports putting large and small objects into different +sections. This is ignored for other object file formats. +.Ip "\f(CW-h\fIname\fR\fR" 4 +.Ip "\f(CW-soname=\fIname\fR\fR" 4 +When creating an \s-1ELF\s0 shared object, set the internal \s-1DT_SONAME\s0 field to +the specified name. When an executable is linked with a shared object +which has a \s-1DT_SONAME\s0 field, then when the executable is run the dynamic +linker will attempt to load the shared object specified by the \s-1DT_SONAME\s0 +field rather than the using the file name given to the linker. +.Ip "\f(CW-i\fR" 4 +Perform an incremental link (same as option \fB\-r\fR). +.Ip "\f(CW-init \fIname\fR\fR" 4 +When creating an \s-1ELF\s0 executable or shared object, call \s-1NAME\s0 when the +executable or shared object is loaded, by setting \s-1DT_INIT\s0 to the address +of the function. By default, the linker uses \f(CW_init\fR as the +function to call. +.Ip "\f(CW-l\fIarchive\fR\fR" 4 +.Ip "\f(CW--library=\fIarchive\fR\fR" 4 +Add archive file \fIarchive\fR to the list of files to link. This +option may be used any number of times. \f(CWld\fR will search its +path-list for occurrences of \f(CWlib\fIarchive\fR.a\fR for every +\fIarchive\fR specified. +.Sp +On systems which support shared libraries, \f(CWld\fR may also search for +libraries with extensions other than \f(CW.a\fR. Specifically, on \s-1ELF\s0 +and SunOS systems, \f(CWld\fR will search a directory for a library with +an extension of \f(CW.so\fR before searching for one with an extension of +\&\f(CW.a\fR. By convention, a \f(CW.so\fR extension indicates a shared +library. +.Sp +The linker will search an archive only once, at the location where it is +specified on the command line. If the archive defines a symbol which +was undefined in some object which appeared before the archive on the +command line, the linker will include the appropriate \fIfile\fR\|(s) from the +archive. However, an undefined symbol in an object appearing later on +the command line will not cause the linker to search the archive again. +.Sp +See the \f(CW-(\fR option for a way to force the linker to search +archives multiple times. +.Sp +You may list the same archive multiple times on the command line. +.Sp +This type of archive searching is standard for Unix linkers. However, +if you are using \f(CWld\fR on \s-1AIX\s0, note that it is different from the +behaviour of the \s-1AIX\s0 linker. +.Ip "\f(CW-L\fIsearchdir\fR\fR" 4 +.Ip "\f(CW--library-path=\fIsearchdir\fR\fR" 4 +Add path \fIsearchdir\fR to the list of paths that \f(CWld\fR will search +for archive libraries and \f(CWld\fR control scripts. You may use this +option any number of times. The directories are searched in the order +in which they are specified on the command line. Directories specified +on the command line are searched before the default directories. All +\f(CW-L\fR options apply to all \f(CW-l\fR options, regardless of the +order in which the options appear. +.Sp +The default set of paths searched (without being specified with +\fB\-L\fR) depends on which emulation mode \f(CWld\fR is using, and in +some cases also on how it was configured. +.Sp +The paths can also be specified in a link script with the +\f(CWSEARCH_DIR\fR command. Directories specified this way are searched +at the point in which the linker script appears in the command line. +.Ip "\f(CW-m\fIemulation\fR\fR" 4 +Emulate the \fIemulation\fR linker. You can list the available +emulations with the \fB--verbose\fR or \fB\-V\fR options. +.Sp +If the \fB\-m\fR option is not used, the emulation is taken from the +\f(CWLDEMULATION\fR environment variable, if that is defined. +.Sp +Otherwise, the default emulation depends upon how the linker was +configured. +.Ip "\f(CW-M\fR" 4 +.Ip "\f(CW--print-map\fR" 4 +Print a link map to the standard output. A link map provides +information about the link, including the following: +.Ip "\(bu" 8 +Where object files and symbols are mapped into memory. +.Ip "\(bu" 8 +How common symbols are allocated. +.Ip "\(bu" 8 +All archive members included in the link, with a mention of the symbol +which caused the archive member to be brought in. +.Ip "\f(CW-n\fR" 4 +.Ip "\f(CW--nmagic\fR" 4 +Turn off page alignment of sections, and mark the output as +\f(CWNMAGIC\fR if possible. +.Ip "\f(CW-N\fR" 4 +.Ip "\f(CW--omagic\fR" 4 +Set the text and data sections to be readable and writable. Also, do +not page-align the data segment. If the output format supports Unix +style magic numbers, mark the output as \f(CWOMAGIC\fR. +.Ip "\f(CW-o \fIoutput\fR\fR" 4 +.Ip "\f(CW--output=\fIoutput\fR\fR" 4 +Use \fIoutput\fR as the name for the program produced by \f(CWld\fR; if this +option is not specified, the name \fIa.out\fR is used by default. The +script command \f(CWOUTPUT\fR can also specify the output file name. +.Ip "\f(CW-O \fIlevel\fR\fR" 4 +If \fIlevel\fR is a numeric values greater than zero \f(CWld\fR optimizes +the output. This might take significantly longer and therefore probably +should only be enabled for the final binary. +.Ip "\f(CW-q\fR" 4 +.Ip "\f(CW--emit-relocs\fR" 4 +Leave relocation sections and contents in fully linked exececutables. +Post link analysis and optimization tools may need this information in +order to perform correct modifications of executables. This results +in larger executables. +.Ip "\f(CW-r\fR" 4 +.Ip "\f(CW--relocateable\fR" 4 +Generate relocatable output---i.e., generate an output file that can in +turn serve as input to \f(CWld\fR. This is often called \fIpartial +linking\fR. As a side effect, in environments that support standard Unix +magic numbers, this option also sets the output file's magic number to +\f(CWOMAGIC\fR. +If this option is not specified, an absolute file is produced. When +linking \*(C+ programs, this option \fIwill not\fR resolve references to +constructors; to do that, use \fB\-Ur\fR. +.Sp +This option does the same thing as \fB\-i\fR. +.Ip "\f(CW-R \fIfilename\fR\fR" 4 +.Ip "\f(CW--just-symbols=\fIfilename\fR\fR" 4 +Read symbol names and their addresses from \fIfilename\fR, but do not +relocate it or include it in the output. This allows your output file +to refer symbolically to absolute locations of memory defined in other +programs. You may use this option more than once. +.Sp +For compatibility with other \s-1ELF\s0 linkers, if the \f(CW-R\fR option is +followed by a directory name, rather than a file name, it is treated as +the \f(CW-rpath\fR option. +.Ip "\f(CW-s\fR" 4 +.Ip "\f(CW--strip-all\fR" 4 +Omit all symbol information from the output file. +.Ip "\f(CW-S\fR" 4 +.Ip "\f(CW--strip-debug\fR" 4 +Omit debugger symbol information (but not all symbols) from the output file. +.Ip "\f(CW-t\fR" 4 +.Ip "\f(CW--trace\fR" 4 +Print the names of the input files as \f(CWld\fR processes them. +.Ip "\f(CW-T \fIscriptfile\fR\fR" 4 +.Ip "\f(CW--script=\fIscriptfile\fR\fR" 4 +Use \fIscriptfile\fR as the linker script. This script replaces +\f(CWld\fR's default linker script (rather than adding to it), so +\fIcommandfile\fR must specify everything necessary to describe the +output file. You must use this option if you want to use a command +which can only appear once in a linker script, such as the +\f(CWSECTIONS\fR or \f(CWMEMORY\fR command. If +\fIscriptfile\fR does not exist in the current directory, \f(CWld\fR +looks for it in the directories specified by any preceding \fB\-L\fR +options. Multiple \fB\-T\fR options accumulate. +.Ip "\f(CW-u \fIsymbol\fR\fR" 4 +.Ip "\f(CW--undefined=\fIsymbol\fR\fR" 4 +Force \fIsymbol\fR to be entered in the output file as an undefined +symbol. Doing this may, for example, trigger linking of additional +modules from standard libraries. \fB\-u\fR may be repeated with +different option arguments to enter additional undefined symbols. This +option is equivalent to the \f(CWEXTERN\fR linker script command. +.Ip "\f(CW-Ur\fR" 4 +For anything other than \*(C+ programs, this option is equivalent to +\fB\-r\fR: it generates relocatable output---i.e., an output file that can in +turn serve as input to \f(CWld\fR. When linking \*(C+ programs, \fB\-Ur\fR +\fIdoes\fR resolve references to constructors, unlike \fB\-r\fR. +It does not work to use \fB\-Ur\fR on files that were themselves linked +with \fB\-Ur\fR; once the constructor table has been built, it cannot +be added to. Use \fB\-Ur\fR only for the last partial link, and +\fB\-r\fR for the others. +.Ip "\f(CW--unique[=\fISECTION\fR]\fR" 4 +Creates a separate output section for every input section matching +\fI\s-1SECTION\s0\fR, or if the optional wildcard \fI\s-1SECTION\s0\fR argument is +missing, for every orphan input section. An orphan section is one not +specifically mentioned in a linker script. You may use this option +multiple times on the command line; It prevents the normal merging of +input sections with the same name, overriding output section assignments +in a linker script. +.Ip "\f(CW-v\fR" 4 +.Ip "\f(CW--version\fR" 4 +.Ip "\f(CW-V\fR" 4 +Display the version number for \f(CWld\fR. The \f(CW-V\fR option also +lists the supported emulations. +.Ip "\f(CW-x\fR" 4 +.Ip "\f(CW--discard-all\fR" 4 +Delete all local symbols. +.Ip "\f(CW-X\fR" 4 +.Ip "\f(CW--discard-locals\fR" 4 +Delete all temporary local symbols. For most targets, this is all local +symbols whose names begin with \fBL\fR. +.Ip "\f(CW-y \fIsymbol\fR\fR" 4 +.Ip "\f(CW--trace-symbol=\fIsymbol\fR\fR" 4 +Print the name of each linked file in which \fIsymbol\fR appears. This +option may be given any number of times. On many systems it is necessary +to prepend an underscore. +.Sp +This option is useful when you have an undefined symbol in your link but +don't know where the reference is coming from. +.Ip "\f(CW-Y \fIpath\fR\fR" 4 +Add \fIpath\fR to the default library search path. This option exists +for Solaris compatibility. +.Ip "\f(CW-z \fIkeyword\fR\fR" 4 +The recognized keywords are \f(CWinitfirst\fR, \f(CWinterpose\fR, +\f(CWloadfltr\fR, \f(CWnodefaultlib\fR, \f(CWnodelete\fR, \f(CWnodlopen\fR, +\f(CWnodump\fR, \f(CWnow\fR and \f(CWorigin\fR. The other keywords are +ignored for Solaris compatibility. \f(CWinitfirst\fR marks the object +to be initialized first at runtime before any other objects. +\f(CWinterpose\fR marks the object that its symbol table interposes +before all symbols but the primary executable. \f(CWloadfltr\fR marks +the object that its filtees be processed immediately at runtime. +\f(CWnodefaultlib\fR marks the object that the search for dependencies +of this object will ignore any default library search paths. +\f(CWnodelete\fR marks the object shouldn't be unloaded at runtime. +\f(CWnodlopen\fR marks the object not available to \f(CWdlopen\fR. +\f(CWnodump\fR marks the object can not be dumped by \f(CWdldump\fR. +\f(CWnow\fR marks the object with the non-lazy runtime binding. +\f(CWorigin\fR marks the object may contain \f(CW$ORIGIN\fR. +\f(CWdefs\fR disallows undefined symbols. +.Ip "\f(CW-( \fIarchives\fR -)\fR" 4 +.Ip "\f(CW--start-group \fIarchives\fR --end-group\fR" 4 +The \fIarchives\fR should be a list of archive files. They may be +either explicit file names, or \fB\-l\fR options. +.Sp +The specified archives are searched repeatedly until no new undefined +references are created. Normally, an archive is searched only once in +the order that it is specified on the command line. If a symbol in that +archive is needed to resolve an undefined symbol referred to by an +object in an archive that appears later on the command line, the linker +would not be able to resolve that reference. By grouping the archives, +they all be searched repeatedly until all possible references are +resolved. +.Sp +Using this option has a significant performance cost. It is best to use +it only when there are unavoidable circular references between two or +more archives. +.Ip "\f(CW-assert \fIkeyword\fR\fR" 4 +This option is ignored for SunOS compatibility. +.Ip "\f(CW-Bdynamic\fR" 4 +.Ip "\f(CW-dy\fR" 4 +.Ip "\f(CW-call_shared\fR" 4 Link against dynamic libraries. This is only meaningful on platforms for which shared libraries are supported. This option is normally the -default on such platforms. - -.TP -.B \-Bgroup -Set the \c -.B DF_1_GROUP -\c -flag in the \c -.B DT_FLAGS_1 -\c -entry in the dynamic section. This causes the runtime linker to handle -lookups in this object and its dependencies to be performed only inside -the group. No undefined symbols are allowed. This option is only -meaningful on ELF platforms which support shared libraries. - -.TP -.B \-Bsymbolic -When creating a shared library, bind references to global symbols to -the definition within the shared library, if any. Normally, it is -possible for a program linked against a shared library to override the -definition within the shared library. This option is only meaningful -on ELF platforms which support shared libraries. - -.TP -.BI "\-c " "commandfile" -Directs \c -.B ld\c -\& to read link commands from the file -\c -.I commandfile\c -\&. These commands will completely override \c -.B ld\c -\&'s -default link format (rather than adding to it); \c -.I commandfile\c -\& must -specify everything necessary to describe the target format. - - -You may also include a script of link commands directly in the command -line by bracketing it between `\|\c -.B {\c -\|' and `\|\c -.B }\c -\|' characters. - -.TP -.B \-\-cref +default on such platforms. The different variants of this option are +for compatibility with various systems. You may use this option +multiple times on the command line: it affects library searching for +\f(CW-l\fR options which follow it. +.Ip "\f(CW-Bgroup\fR" 4 +Set the \f(CWDF_1_GROUP\fR flag in the \f(CWDT_FLAGS_1\fR entry in the dynamic +section. This causes the runtime linker to handle lookups in this +object and its dependencies to be performed only inside the group. +\f(CW--no-undefined\fR is implied. This option is only meaningful on \s-1ELF\s0 +platforms which support shared libraries. +.Ip "\f(CW-Bstatic\fR" 4 +.Ip "\f(CW-dn\fR" 4 +.Ip "\f(CW-non_shared\fR" 4 +.Ip "\f(CW-static\fR" 4 +Do not link against shared libraries. This is only meaningful on +platforms for which shared libraries are supported. The different +variants of this option are for compatibility with various systems. You +may use this option multiple times on the command line: it affects +library searching for \f(CW-l\fR options which follow it. +.Ip "\f(CW-Bsymbolic\fR" 4 +When creating a shared library, bind references to global symbols to the +definition within the shared library, if any. Normally, it is possible +for a program linked against a shared library to override the definition +within the shared library. This option is only meaningful on \s-1ELF\s0 +platforms which support shared libraries. +.Ip "\f(CW--check-sections\fR" 4 +.Ip "\f(CW--no-check-sections\fR" 4 +Asks the linker \fInot\fR to check section addresses after they have +been assigned to see if there any overlaps. Normally the linker will +perform this check, and if it finds any overlaps it will produce +suitable error messages. The linker does know about, and does make +allowances for sections in overlays. The default behaviour can be +restored by using the command line switch \fB--check-sections\fR. +.Ip "\f(CW--cref\fR" 4 Output a cross reference table. If a linker map file is being generated, the cross reference table is printed to the map file. Otherwise, it is printed on the standard output. - -.TP -.B \-d -.TP -.B \-dc -.TP -.B \-dp -These three options are equivalent; multiple forms are supported for -compatibility with other linkers. Use any of them to make \c -.B ld -assign space to common symbols even if a relocatable output file is -specified (\c -.B \-r\c -\&). The script command -\c -.B FORCE_COMMON_ALLOCATION\c -\& has the same effect. - -.TP -.BI "-defsym " "symbol" "\fR=\fP" expression +.Sp +The format of the table is intentionally simple, so that it may be +easily processed by a script if necessary. The symbols are printed out, +sorted by name. For each symbol, a list of file names is given. If the +symbol is defined, the first file listed is the location of the +definition. The remaining files contain references to the symbol. +.Ip "\f(CW--defsym \fIsymbol\fR=\fIexpression\fR\fR" 4 Create a global symbol in the output file, containing the absolute -address given by \c -.I expression\c -\&. You may use this option as many +address given by \fIexpression\fR. You may use this option as many times as necessary to define multiple symbols in the command line. A -limited form of arithmetic is supported for the \c -.I expression\c -\& in this +limited form of arithmetic is supported for the \fIexpression\fR in this context: you may give a hexadecimal constant or the name of an existing -symbol, or use \c -.B +\c -\& and \c -.B \-\c -\& to add or subtract hexadecimal +symbol, or use \f(CW+\fR and \f(CW-\fR to add or subtract hexadecimal constants or symbols. If you need more elaborate expressions, consider -using the linker command language from a script. - -.TP -.B \-\-demangle -.TP -.B \-\-no\-demangle -These options control whether to demangle symbol names in error -messages and other output. When the linker is told to demangle, it -tries to present symbol names in a readable fashion: it strips leading -underscores if they are used by the object file format, and converts -C++ mangled symbol names into user readable names. The linker will -demangle by default unless the environment variable -.B COLLECT_NO_DEMANGLE +using the linker command language from a script. \fINote:\fR there should be no white +space between \fIsymbol\fR, the equals sign (``\fB=\fR''), and +\fIexpression\fR. +.Ip "\f(CW--demangle[=\fIstyle\fR]\fR" 4 +.Ip "\f(CW--no-demangle\fR" 4 +These options control whether to demangle symbol names in error messages +and other output. When the linker is told to demangle, it tries to +present symbol names in a readable fashion: it strips leading +underscores if they are used by the object file format, and converts \*(C+ +mangled symbol names into user readable names. Different compilers have +different mangling styles. The optional demangling style argument can be used +to choose an appropriate demangling style for your compiler. The linker will +demangle by default unless the environment variable \fB\s-1COLLECT_NO_DEMANGLE\s0\fR is set. These options may be used to override the default. - -.TP -.BI "-e " "entry"\c -\& -Use \c -.I entry\c -\& as the explicit symbol for beginning execution of your -program, rather than the default entry point. See the `\|\c -.B ld\c -\|' entry in `\|\c -.B info\c -\|' for a -discussion of defaults and other ways of specifying the -entry point. - -.TP -.B \-embedded\-relocs -This option is only meaningful when linking MIPS embedded PIC code, -generated by the -.B \-membedded\-pic -option to the GNU compiler and assembler. It causes the linker to -create a table which may be used at runtime to relocate any data which -was statically initialized to pointer values. See the code in -testsuite/ld-empic for details. - -.TP -.B \-E -.TP -.B \-export\-dynamic -When creating an ELF file, add all symbols to the dynamic symbol table. -Normally, the dynamic symbol table contains only symbols which are used -by a dynamic object. This option is needed for some uses of -.I dlopen. - -.TP -.BI "-f " "name" -.TP -.BI "--auxiliary " "name" -When creating an ELF shared object, set the internal DT_AUXILIARY field -to the specified name. This tells the dynamic linker that the symbol -table of the shared object should be used as an auxiliary filter on the -symbol table of the shared object -.I name. - -.TP -.BI "-F " "name" -.TP -.BI "--filter " "name" -When creating an ELF shared object, set the internal DT_FILTER field to -the specified name. This tells the dynamic linker that the symbol table -of the shared object should be used as a filter on the symbol table of -the shared object -.I name. - -.TP -.BI "\-format " "input\-format" -Synonym for \c -.B \-b\c -\& \c -.I input\-format\c -\&. - -.TP -.B \-g -Accepted, but ignored; provided for compatibility with other tools. - -.TP -.BI "\-G " "size"\c -Set the maximum size of objects to be optimized using the GP register -to -.I size -under MIPS ECOFF. Ignored for other object file formats. - -.TP -.BI "-h " "name" -.TP -.BI "-soname " "name" -When creating an ELF shared object, set the internal DT_SONAME field to -the specified name. When an executable is linked with a shared object -which has a DT_SONAME field, then when the executable is run the dynamic -linker will attempt to load the shared object specified by the DT_SONAME -field rather than the using the file name given to the linker. - -.TP -.B \-\-help +.Ip "\f(CW--dynamic-linker \fIfile\fR\fR" 4 +Set the name of the dynamic linker. This is only meaningful when +generating dynamically linked \s-1ELF\s0 executables. The default dynamic +linker is normally correct; don't use this unless you know what you are +doing. +.Ip "\f(CW--embedded-relocs\fR" 4 +This option is only meaningful when linking \s-1MIPS\s0 embedded \s-1PIC\s0 code, +generated by the \-membedded-pic option to the \s-1GNU\s0 compiler and +assembler. It causes the linker to create a table which may be used at +runtime to relocate any data which was statically initialized to pointer +values. See the code in testsuite/ld-empic for details. +.Ip "\f(CW--force-exe-suffix\fR" 4 +Make sure that an output file has a .exe suffix. +.Sp +If a successfully built fully linked output file does not have a +\&\f(CW.exe\fR or \f(CW.dll\fR suffix, this option forces the linker to copy +the output file to one of the same name with a \f(CW.exe\fR suffix. This +option is useful when using unmodified Unix makefiles on a Microsoft +Windows host, since some versions of Windows won't run an image unless +it ends in a \f(CW.exe\fR suffix. +.Ip "\f(CW--no-gc-sections\fR" 4 +.Ip "\f(CW--gc-sections\fR" 4 +Enable garbage collection of unused input sections. It is ignored on +targets that do not support this option. This option is not compatible +with \fB\-r\fR, nor should it be used with dynamic linking. The default +behaviour (of not performing this garbage collection) can be restored by +specifying \fB--no-gc-sections\fR on the command line. +.Ip "\f(CW--help\fR" 4 Print a summary of the command-line options on the standard output and exit. -This option and -.B \-\-version -begin with two dashes instead of one -for compatibility with other GNU programs. The other options start with -only one dash for compatibility with other linkers. - -.TP -.B \-i -Perform an incremental link (same as option \c -.B \-r\c -\&). - -.TP -.BI "\-l" "ar"\c -\& -Add an archive file \c -.I ar\c -\& to the list of files to link. This -option may be used any number of times. \c -.B ld\c -\& will search its -path-list for occurrences of \c -.B lib\c -.I ar\c -\&.a\c -\& for every \c -.I ar -specified. - -.TP -.BI "\-L" "searchdir" -This command adds path \c -.I searchdir\c -\& to the list of paths that -\c -.B ld\c -\& will search for archive libraries. You may use this option -any number of times. - -The default set of paths searched (without being specified with -\c -.B \-L\c -\&) depends on what emulation mode \c -.B ld\c -\& is using, and in -some cases also on how it was configured. The -paths can also be specified in a link script with the \c -.B SEARCH_DIR -command. - -.TP -.B \-M -Print (to the standard output file) a link map\(em\&diagnostic information -about where symbols are mapped by \c -.B ld\c -\&, and information on global -common storage allocation. - -.TP -.BI "\-Map " "mapfile"\c -Print to the file -.I mapfile -a link map\(em\&diagnostic information -about where symbols are mapped by \c -.B ld\c -\&, and information on global -common storage allocation. - -.TP -.BI "\-m " "emulation"\c -Emulate the -.I emulation -linker. You can list the available emulations with the -.I \-\-verbose -or -.I \-V -options. This option overrides the compiled-in default, which is the -system for which you configured -.BR ld . - -.TP -.B \-N -specifies readable and writable \c -.B text\c -\& and \c -.B data\c -\& sections. If -the output format supports Unix style magic numbers, the output is -marked as \c -.B OMAGIC\c -\&. - -When you use the `\|\c -.B \-N\c -\&\|' option, the linker does not page-align the -data segment. - -.TP -.B \-n -sets the text segment to be read only, and \c -.B NMAGIC\c -\& is written -if possible. - -.TP -.B \-noinhibit\-exec +.Ip "\f(CW--target-help\fR" 4 +Print a summary of all target specific options on the standard output and exit. +.Ip "\f(CW-Map \fImapfile\fR\fR" 4 +Print a link map to the file \fImapfile\fR. See the description of the +\fB\-M\fR option, above. +.Ip "\f(CW--no-keep-memory\fR" 4 +\f(CWld\fR normally optimizes for speed over memory usage by caching the +symbol tables of input files in memory. This option tells \f(CWld\fR to +instead optimize for memory usage, by rereading the symbol tables as +necessary. This may be required if \f(CWld\fR runs out of memory space +while linking a large executable. +.Ip "\f(CW--no-undefined\fR" 4 +.Ip "\f(CW-z defs\fR" 4 +Normally when creating a non-symbolic shared library, undefined symbols +are allowed and left to be resolved by the runtime loader. These options +disallows such undefined symbols. +.Ip "\f(CW--allow-shlib-undefined\fR" 4 +Allow undefined symbols in shared objects even when --no-undefined is +set. The net result will be that undefined symbols in regular objects +will still trigger an error, but undefined symbols in shared objects +will be ignored. The implementation of no_undefined makes the +assumption that the runtime linker will choke on undefined symbols. +However there is at least one system (BeOS) where undefined symbols in +shared libraries is normal since the kernel patches them at load time to +select which function is most appropriate for the current architecture. +I.E. dynamically select an appropriate memset function. Apparently it +is also normal for \s-1HPPA\s0 shared libraries to have undefined symbols. +.Ip "\f(CW--no-warn-mismatch\fR" 4 +Normally \f(CWld\fR will give an error if you try to link together input +files that are mismatched for some reason, perhaps because they have +been compiled for different processors or for different endiannesses. +This option tells \f(CWld\fR that it should silently permit such possible +errors. This option should only be used with care, in cases when you +have taken some special action that ensures that the linker errors are +inappropriate. +.Ip "\f(CW--no-whole-archive\fR" 4 +Turn off the effect of the \f(CW--whole-archive\fR option for subsequent +archive files. +.Ip "\f(CW--noinhibit-exec\fR" 4 +Retain the executable output file whenever it is still usable. Normally, the linker will not produce an output file if it encounters -errors during the link process. With this flag, you can specify that -you wish the output file retained even after non-fatal errors. - -.TP -.B \-no\-keep\-memory -The linker normally optimizes for speed over memory usage by caching -the symbol tables of input files in memory. This option tells the -linker to instead optimize for memory usage, by rereading the symbol -tables as necessary. This may be required if the linker runs out of -memory space while linking a large executable. - -.TP -.B \-no\-warn\-mismatch -Normally the linker will give an error if you try to link together -input files that are mismatched for some reason, perhaps because they -have been compiled for different processors or for different -endiannesses. This option tells the linker that it should silently -permit such possible errors. This option should only be used with -care, in cases when you have taken some special action that ensures -that the linker errors are inappropriate. - -.TP -.BI "\-o " "output" -.I output\c -\& is a name for the program produced by \c -.B ld\c -\&; if this -option is not specified, the name `\|\c -.B a.out\c -\|' is used by default. The -script command \c -.B OUTPUT\c -\& can also specify the output file name. - -.TP -.BI "\-O" "level" -Generate optimized output files. This might use significantly more -time and therefore probably should be enabled only for generating the -final binary. -\c -.I level\c -\& is supposed to be a numeric value. Any value greater than zero enables -the optimizations. - -.TP -.BI "\--oformat " "output\-format" -Specify the binary format for the output object file. -You don't usually need to specify this, as -\c -.B ld\c -\& is configured to produce as a default output format the most -usual format on each machine. \c -.I output-format\c -\& is a text string, the -name of a particular format supported by the BFD libraries. -The script command -.B OUTPUT_FORMAT -can also specify the output format, but this option overrides it. - -.TP -.BI "\-R " "filename" -Read symbol names and their addresses from \c -.I filename\c -\&, but do not -relocate it or include it in the output. This allows your output file -to refer symbolically to absolute locations of memory defined in other -programs. - -.TP -.B \-relax -An option with machine dependent effects. Currently this option is only -supported on the H8/300. - -On some platforms, use this option to perform global optimizations that -become possible when the linker resolves addressing in your program, such -as relaxing address modes and synthesizing new instructions in the -output object file. - -On platforms where this is not supported, `\|\c -.B \-relax\c -\&\|' is accepted, but has no effect. - -.TP -.B \-r -Generates relocatable output\(em\&i.e., generate an output file that can in -turn serve as input to \c -.B ld\c -\&. This is often called \c -.I partial -linking\c -\&. As a side effect, in environments that support standard Unix -magic numbers, this option also sets the output file's magic number to -\c -.B OMAGIC\c -\&. -If this option is not specified, an absolute file is produced. When -linking C++ programs, this option \c -.I will not\c -\& resolve references to -constructors; \c -.B \-Ur\c -\& is an alternative. - -This option does the same as \c -.B \-i\c -\&. - -.TP -.B \-rpath\ \fIdirectory +errors during the link process; it exits without writing an output file +when it issues any error whatsoever. +.Ip "\f(CW--oformat \fIoutput-format\fR\fR" 4 +\f(CWld\fR may be configured to support more than one kind of object +file. If your \f(CWld\fR is configured this way, you can use the +\fB--oformat\fR option to specify the binary format for the output +object file. Even when \f(CWld\fR is configured to support alternative +object formats, you don't usually need to specify this, as \f(CWld\fR +should be configured to produce as a default output format the most +usual format on each machine. \fIoutput-format\fR is a text string, the +name of a particular format supported by the \s-1BFD\s0 libraries. (You can +list the available binary formats with \fBobjdump \-i\fR.) The script +command \f(CWOUTPUT_FORMAT\fR can also specify the output format, but +this option overrides it. +.Ip "\f(CW-qmagic\fR" 4 +This option is ignored for Linux compatibility. +.Ip "\f(CW-Qy\fR" 4 +This option is ignored for \s-1SVR4\s0 compatibility. +.Ip "\f(CW--relax\fR" 4 +An option with machine dependent effects. +This option is only supported on a few targets. +.Sp +On some platforms, the \fB--relax\fR option performs global +optimizations that become possible when the linker resolves addressing +in the program, such as relaxing address modes and synthesizing new +instructions in the output object file. +.Sp +On some platforms these link time global optimizations may make symbolic +debugging of the resulting executable impossible. +This is known to be +the case for the Matsushita \s-1MN10200\s0 and \s-1MN10300\s0 family of processors. +.Sp +On platforms where this is not supported, \fB--relax\fR is accepted, +but ignored. +.Ip "\f(CW--retain-symbols-file \fIfilename\fR\fR" 4 +Retain \fIonly\fR the symbols listed in the file \fIfilename\fR, +discarding all others. \fIfilename\fR is simply a flat file, with one +symbol name per line. This option is especially useful in environments +(such as VxWorks) +where a large global symbol table is accumulated gradually, to conserve +run-time memory. +.Sp +\fB--retain-symbols-file\fR does \fInot\fR discard undefined symbols, +or symbols needed for relocations. +.Sp +You may only specify \fB--retain-symbols-file\fR once in the command +line. It overrides \fB\-s\fR and \fB\-S\fR. +.Ip "\f(CW-rpath \fIdir\fR\fR" 4 Add a directory to the runtime library search path. This is used when -linking an ELF executable with shared objects. All -.B \-rpath +linking an \s-1ELF\s0 executable with shared objects. All \f(CW-rpath\fR arguments are concatenated and passed to the runtime linker, which uses -them to locate shared objects at runtime. The -.B \-rpath -option is also used when locating shared objects which are needed by -shared objects explicitly included in the link; see the description of -the -.B \-rpath\-link -option. If -.B \-rpath -is not used when linking an ELF executable, the contents of the -environment variable -.B LD_RUN_PATH -will be used if it is defined. - -The -.B \-rpath -option may also be used on SunOS. By default, on SunOS, the linker -will form a runtime search path out of all the -.B \-L -options it is given. If a -.B \-rpath -option is used, the runtime search path will be formed exclusively -using the -.B \-rpath -options, ignoring -the -.B \-L -options. This can be useful when using gcc, which adds many -.B \-L -options which may be on NFS mounted filesystems. - -.TP -.B \-rpath\-link\ \fIdirectory -When using ELF or SunOS, one shared library may require another. This -happens when an -.B ld\ \-shared -link includes a shared library as one of the input files. - +them to locate shared objects at runtime. The \f(CW-rpath\fR option is +also used when locating shared objects which are needed by shared +objects explicitly included in the link; see the description of the +\f(CW-rpath-link\fR option. If \f(CW-rpath\fR is not used when linking an +\s-1ELF\s0 executable, the contents of the environment variable +\f(CWLD_RUN_PATH\fR will be used if it is defined. +.Sp +The \f(CW-rpath\fR option may also be used on SunOS. By default, on +SunOS, the linker will form a runtime search patch out of all the +\f(CW-L\fR options it is given. If a \f(CW-rpath\fR option is used, the +runtime search path will be formed exclusively using the \f(CW-rpath\fR +options, ignoring the \f(CW-L\fR options. This can be useful when using +gcc, which adds many \f(CW-L\fR options which may be on \s-1NFS\s0 mounted +filesystems. +.Sp +For compatibility with other \s-1ELF\s0 linkers, if the \f(CW-R\fR option is +followed by a directory name, rather than a file name, it is treated as +the \f(CW-rpath\fR option. +.Ip "\f(CW-rpath-link \fIDIR\fR\fR" 4 +When using \s-1ELF\s0 or SunOS, one shared library may require another. This +happens when an \f(CWld -shared\fR link includes a shared library as one +of the input files. +.Sp When the linker encounters such a dependency when doing a non-shared, -non-relocateable link, it will automatically try to locate the required +non-relocatable link, it will automatically try to locate the required shared library and include it in the link, if it is not included -explicitly. In such a case, the -.B \-rpath\-link -option specifies the first set of directories to search. The -.B \-rpath\-link -option may specify a sequence of directory names either by specifying -a list of names separated by colons, or by appearing multiple times. - +explicitly. In such a case, the \f(CW-rpath-link\fR option +specifies the first set of directories to search. The +\f(CW-rpath-link\fR option may specify a sequence of directory names +either by specifying a list of names separated by colons, or by +appearing multiple times. +.Sp +This option should be used with caution as it overrides the search path +that may have been hard compiled into a shared library. In such a case it +is possible to use unintentionally a different search path than the +runtime linker would do. +.Sp +The linker uses the following search paths to locate required shared +libraries. +.Ip "1." 8 +Any directories specified by \f(CW-rpath-link\fR options. +.Ip "2." 8 +Any directories specified by \f(CW-rpath\fR options. The difference +between \f(CW-rpath\fR and \f(CW-rpath-link\fR is that directories +specified by \f(CW-rpath\fR options are included in the executable and +used at runtime, whereas the \f(CW-rpath-link\fR option is only effective +at link time. It is for the native linker only. +.Ip "3." 8 +On an \s-1ELF\s0 system, if the \f(CW-rpath\fR and \f(CWrpath-link\fR options +were not used, search the contents of the environment variable +\f(CWLD_RUN_PATH\fR. It is for the native linker only. +.Ip "4." 8 +On SunOS, if the \f(CW-rpath\fR option was not used, search any +directories specified using \f(CW-L\fR options. +.Ip "5." 8 +For a native linker, the contents of the environment variable +\f(CWLD_LIBRARY_PATH\fR. +.Ip "6." 8 +For a native \s-1ELF\s0 linker, the directories in \f(CWDT_RUNPATH\fR or +\f(CWDT_RPATH\fR of a shared library are searched for shared +libraries needed by it. The \f(CWDT_RPATH\fR entries are ignored if +\f(CWDT_RUNPATH\fR entries exist. +.Ip "7." 8 +The default directories, normally \fI/lib\fR and \fI/usr/lib\fR. +.Ip "8." 8 +For a native linker on an \s-1ELF\s0 system, if the file \fI/etc/ld.so.conf\fR +exists, the list of directories found in that file. +.Sp If the required shared library is not found, the linker will issue a warning and continue with the link. - -.TP -.B \-S -Omits debugger symbol information (but not all symbols) from the output file. - -.TP -.B \-s -Omits all symbol information from the output file. - -.TP -.B \-shared -Create a shared library. This is currently only supported on ELF and -SunOS platforms (on SunOS it is not required, as the linker will -automatically create a shared library when there are undefined symbols -and the -.B \-e -option is not used). - -.TP -.B \-sort\-common -Normally, when -.B ld -places the global common symbols in the appropriate output sections, -it sorts them by size. First come all the one byte symbols, then all -the two bytes, then all the four bytes, and then everything else. -This is to prevent gaps between symbols due to -alignment constraints. This option disables that sorting. - -.TP -.B \-split\-by\-reloc\ \fIcount -Trys to creates extra sections in the output file so that no single -output section in the file contains more than -.I count -relocations. -This is useful when generating huge relocatable for downloading into -certain real time kernels with the COFF object file format; since COFF -cannot represent more than 65535 relocations in a single section. -Note that this will fail to work with object file formats which do not +.Ip "\f(CW-shared\fR" 4 +.Ip "\f(CW-Bshareable\fR" 4 +Create a shared library. This is currently only supported on \s-1ELF\s0, \s-1XCOFF\s0 +and SunOS platforms. On SunOS, the linker will automatically create a +shared library if the \f(CW-e\fR option is not used and there are +undefined symbols in the link. +.Ip "\f(CW--sort-common\fR" 4 +This option tells \f(CWld\fR to sort the common symbols by size when it +places them in the appropriate output sections. First come all the one +byte symbols, then all the two bytes, then all the four bytes, and then +everything else. This is to prevent gaps between symbols due to +alignment constraints. +.Ip "\f(CW--split-by-file [\fIsize\fR]\fR" 4 +Similar to \f(CW--split-by-reloc\fR but creates a new output section for +each input file when \fIsize\fR is reached. \fIsize\fR defaults to a +size of 1 if not given. +.Ip "\f(CW--split-by-reloc [\fIcount\fR]\fR" 4 +Tries to creates extra sections in the output file so that no single +output section in the file contains more than \fIcount\fR relocations. +This is useful when generating huge relocatable files for downloading into +certain real time kernels with the \s-1COFF\s0 object file format; since \s-1COFF\s0 +cannot represent more than 65535 relocations in a single section. Note +that this will fail to work with object file formats which do not support arbitrary sections. The linker will not split up individual -input sections for redistribution, so if a single input section -contains more than -.I count -relocations one output section will contain that many relocations. - -.TP -.B \-split\-by\-file -Similar to -.B \-split\-by\-reloc -but creates a new output section for each input file. - -.TP -.BI "--section-start " "sectionname" "\fR=\fP"org +input sections for redistribution, so if a single input section contains +more than \fIcount\fR relocations one output section will contain that +many relocations. \fIcount\fR defaults to a value of 32768. +.Ip "\f(CW--stats\fR" 4 +Compute and display statistics about the operation of the linker, such +as execution time and memory usage. +.Ip "\f(CW--traditional-format\fR" 4 +For some targets, the output of \f(CWld\fR is different in some ways from +the output of some existing linker. This switch requests \f(CWld\fR to +use the traditional format instead. +.Sp +For example, on SunOS, \f(CWld\fR combines duplicate entries in the +symbol string table. This can reduce the size of an output file with +full debugging information by over 30 percent. Unfortunately, the SunOS +\f(CWdbx\fR program can not read the resulting program (\f(CWgdb\fR has no +trouble). The \fB--traditional-format\fR switch tells \f(CWld\fR to not +combine duplicate entries. +.Ip "\f(CW--section-start \fIsectionname\fR=\fIorg\fR\fR" 4 Locate a section in the output file at the absolute -address given by \c -.I org\c -\&. \c -\c -.I org\c -\& must be a hexadecimal integer. -You may use this option as many +address given by \fIorg\fR. You may use this option as many times as necessary to locate multiple sections in the command -line. If you need more elaborate expressions, consider -using the linker command language from a script. - -.TP -.BI "\-Tbss " "org"\c -.TP -.BI "\-Tdata " "org"\c -.TP -.BI "\-Ttext " "org"\c -Use \c -.I org\c -\& as the starting address for\(em\&respectively\(em\&the -\c -.B bss\c -\&, \c -.B data\c -\&, or the \c -.B text\c -\& segment of the output file. -\c -.I org\c -\& must be a hexadecimal integer. - -.TP -.BI "\-T " "commandfile" -Equivalent to \c -.B \-c \c -.I commandfile\c -\&\c -\&; supported for compatibility with -other tools. - -.TP -.B \-t -Prints names of input files as \c -.B ld\c -\& processes them. - -.TP -.BI "\-u " "sym" -Forces \c -.I sym\c -\& to be entered in the output file as an undefined symbol. -This may, for example, trigger linking of additional modules from -standard libraries. \c -.B \-u\c -\& may be repeated with different option -arguments to enter additional undefined symbols. - -.TP -.B \-Ur -For anything other than C++ programs, this option is equivalent to -\c -.B \-r\c -\&: it generates relocatable output\(em\&i.e., an output file that can in -turn serve as input to \c -.B ld\c -\&. When linking C++ programs, \c -.B \-Ur -.I will\c -\& resolve references to constructors, unlike \c -.B \-r\c -\&. - -.TP -.B \-\-verbose -Display the version number for \c -.B ld -and list the supported emulations. -Display which input files can and can not be opened. - -.TP -.B \-v, \-V -Display the version number for \c -.B ld\c -\&. -The -.B \-V -option also lists the supported emulations. - -.TP -.B \-\-version -Display the version number for \c -.B ld -and exit. - -.TP -.B \-warn\-common +line. +\fIorg\fR must be a single hexadecimal integer; +for compatibility with other linkers, you may omit the leading +\fB0x\fR usually associated with hexadecimal values. \fINote:\fR there +should be no white space between \fIsectionname\fR, the equals +sign (``\fB=\fR''), and \fIorg\fR. +.Ip "\f(CW-Tbss \fIorg\fR\fR" 4 +.Ip "\f(CW-Tdata \fIorg\fR\fR" 4 +.Ip "\f(CW-Ttext \fIorg\fR\fR" 4 +Use \fIorg\fR as the starting address for---respectively---the +\f(CWbss\fR, \f(CWdata\fR, or the \f(CWtext\fR segment of the output file. +\fIorg\fR must be a single hexadecimal integer; +for compatibility with other linkers, you may omit the leading +\fB0x\fR usually associated with hexadecimal values. +.Ip "\f(CW--dll-verbose\fR" 4 +.Ip "\f(CW--verbose\fR" 4 +Display the version number for \f(CWld\fR and list the linker emulations +supported. Display which input files can and cannot be opened. Display +the linker script if using a default builtin script. +.Ip "\f(CW--version-script=\fIversion-scriptfile\fR\fR" 4 +Specify the name of a version script to the linker. This is typically +used when creating shared libraries to specify additional information +about the version heirarchy for the library being created. This option +is only meaningful on \s-1ELF\s0 platforms which support shared libraries. +.Ip "\f(CW--warn-common\fR" 4 Warn when a common symbol is combined with another common symbol or with a symbol definition. Unix linkers allow this somewhat sloppy practice, but linkers on some other operating systems do not. This option allows you to find potential problems from combining global symbols. - -.TP -.B \-warn\-constructors -Warn if any global constructors are used. This is only useful for a -few object file formats. For formats like COFF or ELF, the linker can -not detect the use of global constructors. - -.TP -.B \-warn\-multiple\-gp -Warn if the output file requires multiple global-pointer values. This -option is only meaningful for certain processors, such as the Alpha. - -.TP -.B \-warn\-once +Unfortunately, some C libraries use this practice, so you may get some +warnings about symbols in the libraries as well as in your programs. +.Sp +There are three kinds of global symbols, illustrated here by C examples: +.Ip "\fBint i = 1;\fR" 8 +A definition, which goes in the initialized data section of the output +file. +.Ip "\fBextern int i;\fR" 8 +An undefined reference, which does not allocate space. +There must be either a definition or a common symbol for the +variable somewhere. +.Ip "\fBint i;\fR" 8 +A common symbol. If there are only (one or more) common symbols for a +variable, it goes in the uninitialized data area of the output file. +The linker merges multiple common symbols for the same variable into a +single symbol. If they are of different sizes, it picks the largest +size. The linker turns a common symbol into a declaration, if there is +a definition of the same variable. +.Sp +The \fB--warn-common\fR option can produce five kinds of warnings. +Each warning consists of a pair of lines: the first describes the symbol +just encountered, and the second describes the previous symbol +encountered with the same name. One or both of the two symbols will be +a common symbol. +.Ip "1." 8 +Turning a common symbol into a reference, because there is already a +definition for the symbol. + + \fIfile\fR(\fIsection\fR): warning: common of `\fIsymbol\fR\*(R' + overridden by definition + \fIfile\fR(\fIsection\fR): warning: defined here +.Ip "2." 8 +Turning a common symbol into a reference, because a later definition for +the symbol is encountered. This is the same as the previous case, +except that the symbols are encountered in a different order. + + \fIfile\fR(\fIsection\fR): warning: definition of `\fIsymbol\fR\*(R' + overriding common + \fIfile\fR(\fIsection\fR): warning: common is here +.Ip "3." 8 +Merging a common symbol with a previous same-sized common symbol. + + \fIfile\fR(\fIsection\fR): warning: multiple common + of `\fIsymbol\fR\*(R' + \fIfile\fR(\fIsection\fR): warning: previous common is here +.Ip "4." 8 +Merging a common symbol with a previous larger common symbol. + + \fIfile\fR(\fIsection\fR): warning: common of `\fIsymbol\fR\*(R' + overridden by larger common + \fIfile\fR(\fIsection\fR): warning: larger common is here +.Ip "5." 8 +Merging a common symbol with a previous smaller common symbol. This is +the same as the previous case, except that the symbols are +encountered in a different order. + + \fIfile\fR(\fIsection\fR): warning: common of `\fIsymbol\fR\*(R' + overriding smaller common + \fIfile\fR(\fIsection\fR): warning: smaller common is here +.Ip "\f(CW--warn-constructors\fR" 4 +Warn if any global constructors are used. This is only useful for a few +object file formats. For formats like \s-1COFF\s0 or \s-1ELF\s0, the linker can not +detect the use of global constructors. +.Ip "\f(CW--warn-multiple-gp\fR" 4 +Warn if multiple global pointer values are required in the output file. +This is only meaningful for certain processors, such as the Alpha. +Specifically, some processors put large-valued constants in a special +section. A special register (the global pointer) points into the middle +of this section, so that constants can be loaded efficiently via a +base-register relative addressing mode. Since the offset in +base-register relative mode is fixed and relatively small (e.g., 16 +bits), this limits the maximum size of the constant pool. Thus, in +large programs, it is often necessary to use multiple global pointer +values in order to be able to address all possible constants. This +option causes a warning to be issued whenever this case occurs. +.Ip "\f(CW--warn-once\fR" 4 Only warn once for each undefined symbol, rather than once per module which refers to it. - -.TP -.B \-warn\-section\-align +.Ip "\f(CW--warn-section-align\fR" 4 Warn if the address of an output section is changed because of alignment. Typically, the alignment will be set by an input section. The address will only be changed if it not explicitly specified; that -is, if the SECTIONS command does not specify a start address for the -section. - -.TP -.B \-\-whole\-archive +is, if the \f(CWSECTIONS\fR command does not specify a start address for +the section. +.Ip "\f(CW--whole-archive\fR" 4 For each archive mentioned on the command line after the -.B \-\-whole\-archive -option, include every object file in the archive in the link, rather -than searching the archive for the required object files. This is -normally used to turn an archive file into a shared library, forcing -every object to be included in the resulting shared library. - -.TP -.B \-\-no\-whole\-archive -Turn off the effect of the -.B \-\-whole\-archive -option for archives which appear later on the command line. - -.TP -.BI "--wrap " "symbol" -Use a wrapper function for -.I symbol. -Any undefined reference to -.I symbol -will be resolved to -.BI "__wrap_" "symbol". -Any undefined reference to -.BI "__real_" "symbol" -will be resolved to -.I symbol. - -.TP -.B \-X -Delete all temporary local symbols. For most targets, this is all local -symbols whose names begin with `\|\c -.B L\c -\|'. +\f(CW--whole-archive\fR option, include every object file in the archive +in the link, rather than searching the archive for the required object +files. This is normally used to turn an archive file into a shared +library, forcing every object to be included in the resulting shared +library. This option may be used more than once. +.Sp +Two notes when using this option from gcc: First, gcc doesn't know +about this option, so you have to use \f(CW-Wl,-whole-archive\fR. +Second, don't forget to use \f(CW-Wl,-no-whole-archive\fR after your +list of archives, because gcc will add its own list of archives to +your link and you may not want this flag to affect those as well. +.Ip "\f(CW--wrap \fIsymbol\fR\fR" 4 +Use a wrapper function for \fIsymbol\fR. Any undefined reference to +\fIsymbol\fR will be resolved to \f(CW__wrap_\fIsymbol\fR\fR. Any +undefined reference to \f(CW__real_\fIsymbol\fR\fR will be resolved to +\fIsymbol\fR. +.Sp +This can be used to provide a wrapper for a system function. The +wrapper function should be called \f(CW__wrap_\fIsymbol\fR\fR. If it +wishes to call the system function, it should call +\f(CW__real_\fIsymbol\fR\fR. +.Sp +Here is a trivial example: +.Sp +.Vb 7 +\& +\& void * +\& __wrap_malloc (int c) +\& { +\& printf ("malloc called with %ld\en", c); +\& return __real_malloc (c); +\& } +.Ve +If you link other code with this file using \f(CW--wrap malloc\fR, then +all calls to \f(CWmalloc\fR will call the function \f(CW__wrap_malloc\fR +instead. The call to \f(CW__real_malloc\fR in \f(CW__wrap_malloc\fR will +call the real \f(CWmalloc\fR function. +.Sp +You may wish to provide a \f(CW__real_malloc\fR function as well, so that +links without the \f(CW--wrap\fR option will succeed. If you do this, +you should not put the definition of \f(CW__real_malloc\fR in the same +file as \f(CW__wrap_malloc\fR; if you do, the assembler may resolve the +call before the linker has a chance to wrap it to \f(CWmalloc\fR. +.Ip "\f(CW--enable-new-dtags\fR" 4 +.Ip "\f(CW--disable-new-dtags\fR" 4 +This linker can create the new dynamic tags in \s-1ELF\s0. But the older \s-1ELF\s0 +systems may not understand them. If you specify +\f(CW--enable-new-dtags\fR, the dynamic tags will be created as needed. +If you specify \f(CW--disable-new-dtags\fR, no new dynamic tags will be +created. By default, the new dynamic tags are not created. Note that +those options are only available for \s-1ELF\s0 systems. +.PP +The i386 \s-1PE\s0 linker supports the \f(CW-shared\fR option, which causes +the output to be a dynamically linked library (\s-1DLL\s0) instead of a +normal executable. You should name the output \f(CW*.dll\fR when you +use this option. In addition, the linker fully supports the standard +\f(CW*.def\fR files, which may be specified on the linker command line +like an object file (in fact, it should precede archives it exports +symbols from, to ensure that they get linked in, just like a normal +object file). +.PP +In addition to the options common to all targets, the i386 \s-1PE\s0 linker +support additional command line options that are specific to the i386 +\s-1PE\s0 target. Options that take values may be separated from their +values by either a space or an equals sign. +.Ip "\f(CW--add-stdcall-alias\fR" 4 +If given, symbols with a stdcall suffix (@\fInn\fR) will be exported +as-is and also with the suffix stripped. +.Ip "\f(CW--base-file \fIfile\fR\fR" 4 +Use \fIfile\fR as the name of a file in which to save the base +addresses of all the relocations needed for generating DLLs with +\fIdlltool\fR. +.Ip "\f(CW--dll\fR" 4 +Create a \s-1DLL\s0 instead of a regular executable. You may also use +\f(CW-shared\fR or specify a \f(CWLIBRARY\fR in a given \f(CW.def\fR +file. +.Ip "\f(CW--enable-stdcall-fixup\fR" 4 +.Ip "\f(CW--disable-stdcall-fixup\fR" 4 +If the link finds a symbol that it cannot resolve, it will attempt to +do \*(L"fuzzy linking\*(R" by looking for another defined symbol that differs +only in the format of the symbol name (cdecl vs stdcall) and will +resolve that symbol by linking to the match. For example, the +undefined symbol \f(CW_foo\fR might be linked to the function +\f(CW_foo@12\fR, or the undefined symbol \f(CW_bar@16\fR might be linked +to the function \f(CW_bar\fR. When the linker does this, it prints a +warning, since it normally should have failed to link, but sometimes +import libraries generated from third-party dlls may need this feature +to be usable. If you specify \f(CW--enable-stdcall-fixup\fR, this +feature is fully enabled and warnings are not printed. If you specify +\f(CW--disable-stdcall-fixup\fR, this feature is disabled and such +mismatches are considered to be errors. +.Ip "\f(CW--export-all-symbols\fR" 4 +If given, all global symbols in the objects used to build a \s-1DLL\s0 will +be exported by the \s-1DLL\s0. Note that this is the default if there +otherwise wouldn't be any exported symbols. When symbols are +explicitly exported via \s-1DEF\s0 files or implicitly exported via function +attributes, the default is to not export anything else unless this +option is given. Note that the symbols \f(CWDllMain@12\fR, +\f(CWDllEntryPoint@0\fR, and \f(CWimpure_ptr\fR will not be automatically +exported. +.Ip "\f(CW--exclude-symbols \fIsymbol\fR,\fIsymbol\fR,...\fR" 4 +Specifies a list of symbols which should not be automatically +exported. The symbol names may be delimited by commas or colons. +.Ip "\f(CW--file-alignment\fR" 4 +Specify the file alignment. Sections in the file will always begin at +file offsets which are multiples of this number. This defaults to +512. +.Ip "\f(CW--heap \fIreserve\fR\fR" 4 +.Ip "\f(CW--heap \fIreserve\fR,\fIcommit\fR\fR" 4 +Specify the amount of memory to reserve (and optionally commit) to be +used as heap for this program. The default is 1Mb reserved, 4K +committed. +.Ip "\f(CW--image-base \fIvalue\fR\fR" 4 +Use \fIvalue\fR as the base address of your program or dll. This is +the lowest memory location that will be used when your program or dll +is loaded. To reduce the need to relocate and improve performance of +your dlls, each should have a unique base address and not overlap any +other dlls. The default is 0x400000 for executables, and 0x10000000 +for dlls. +.Ip "\f(CW--kill-at\fR" 4 +If given, the stdcall suffixes (@\fInn\fR) will be stripped from +symbols before they are exported. +.Ip "\f(CW--major-image-version \fIvalue\fR\fR" 4 +Sets the major number of the \*(L"image version\*(R". Defaults to 1. +.Ip "\f(CW--major-os-version \fIvalue\fR\fR" 4 +Sets the major number of the \*(L"os version\*(R". Defaults to 4. +.Ip "\f(CW--major-subsystem-version \fIvalue\fR\fR" 4 +Sets the major number of the \*(L"subsystem version\*(R". Defaults to 4. +.Ip "\f(CW--minor-image-version \fIvalue\fR\fR" 4 +Sets the minor number of the \*(L"image version\*(R". Defaults to 0. +.Ip "\f(CW--minor-os-version \fIvalue\fR\fR" 4 +Sets the minor number of the \*(L"os version\*(R". Defaults to 0. +.Ip "\f(CW--minor-subsystem-version \fIvalue\fR\fR" 4 +Sets the minor number of the \*(L"subsystem version\*(R". Defaults to 0. +.Ip "\f(CW--output-def \fIfile\fR\fR" 4 +The linker will create the file \fIfile\fR which will contain a \s-1DEF\s0 +file corresponding to the \s-1DLL\s0 the linker is generating. This \s-1DEF\s0 file +(which should be called \f(CW*.def\fR) may be used to create an import +library with \f(CWdlltool\fR or may be used as a reference to +automatically or implicitly exported symbols. +.Ip "\f(CW--section-alignment\fR" 4 +Sets the section alignment. Sections in memory will always begin at +addresses which are a multiple of this number. Defaults to 0x1000. +.Ip "\f(CW--stack \fIreserve\fR\fR" 4 +.Ip "\f(CW--stack \fIreserve\fR,\fIcommit\fR\fR" 4 +Specify the amount of memory to reserve (and optionally commit) to be +used as stack for this program. The default is 32Mb reserved, 4K +committed. +.Ip "\f(CW--subsystem \fIwhich\fR\fR" 4 +.Ip "\f(CW--subsystem \fIwhich\fR:\fImajor\fR\fR" 4 +.Ip "\f(CW--subsystem \fIwhich\fR:\fImajor\fR.\fIminor\fR\fR" 4 +Specifies the subsystem under which your program will execute. The +legal values for \fIwhich\fR are \f(CWnative\fR, \f(CWwindows\fR, +\f(CWconsole\fR, and \f(CWposix\fR. You may optionally set the +subsystem version also. +.SH "ENVIRONMENT" +You can change the behavior of \f(CWld\fR with the environment variables +\f(CWGNUTARGET\fR, \f(CWLDEMULATION\fR, and \f(CWCOLLECT_NO_DEMANGLE\fR. +.PP +\f(CWGNUTARGET\fR determines the input-file object format if you don't +use \fB\-b\fR (or its synonym \fB--format\fR). Its value should be one +of the BFD names for an input format. If there is no +\f(CWGNUTARGET\fR in the environment, \f(CWld\fR uses the natural format +of the target. If \f(CWGNUTARGET\fR is set to \f(CWdefault\fR then BFD +attempts to discover the input format by examining binary input files; +this method often succeeds, but there are potential ambiguities, since +there is no method of ensuring that the magic number used to specify +object-file formats is unique. However, the configuration procedure for +BFD on each system places the conventional format for that system first +in the search-list, so ambiguities are resolved in favor of convention. +.PP +\f(CWLDEMULATION\fR determines the default emulation if you don't use the +\fB\-m\fR option. The emulation can affect various aspects of linker +behaviour, particularly the default linker script. You can list the +available emulations with the \fB--verbose\fR or \fB\-V\fR options. If +the \fB\-m\fR option is not used, and the \f(CWLDEMULATION\fR environment +variable is not defined, the default emulation depends upon how the +linker was configured. +.PP +Normally, the linker will default to demangling symbols. However, if +\f(CWCOLLECT_NO_DEMANGLE\fR is set in the environment, then it will +default to not demangling symbols. This environment variable is used in +a similar fashion by the \f(CWgcc\fR linker wrapper program. The default +may be overridden by the \fB--demangle\fR and \fB--no-demangle\fR +options. +.SH "SEE ALSO" +\fIar\fR\|(1), \fInm\fR\|(1), \fIobjcopy\fR\|(1), \fIobjdump\fR\|(1), \fIreadelf\fR\|(1) and +the Info entries for \fIbinutils\fR and +\fIld\fR. +.SH "COPYRIGHT" +Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000 Free Software Foundation, Inc. +.PP +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled \*(L"GNU Free Documentation License\*(R". -.TP -.B \-x -Delete all local symbols. +.rn }` '' +.IX Title "LD 1" +.IX Name "ld - Using LD, the GNU linker" -.PP +.IX Header "NAME" -.SH ENVIRONMENT -\c -You can change the behavior of -.B ld\c -\& with the environment variable \c -.B GNUTARGET\c -\&. - -\c -.B GNUTARGET\c -\& determines the input-file object format if you don't -use \c -.B \-b\c -\& (or its synonym \c -.B \-format\c -\&). Its value should be one -of the BFD names for an input format. If there is no -\c -.B GNUTARGET\c -\& in the environment, \c -.B ld\c -\& uses the natural format -of the host. If \c -.B GNUTARGET\c -\& is set to \c -.B default\c -\& then BFD attempts to discover the -input format by examining binary input files; this method often -succeeds, but there are potential ambiguities, since there is no method -of ensuring that the magic number used to flag object-file formats is -unique. However, the configuration procedure for BFD on each system -places the conventional format for that system first in the search-list, -so ambiguities are resolved in favor of convention. +.IX Header "SYNOPSIS" -.PP +.IX Header "DESCRIPTION" -.SH "SEE ALSO" +.IX Header "OPTIONS" + +.IX Item "\f(CW-a\fIkeyword\fR\fR" + +.IX Item "\f(CW-A\fIarchitecture\fR\fR" + +.IX Item "\f(CW--architecture=\fIarchitecture\fR\fR" + +.IX Item "\f(CW-b \fIinput-format\fR\fR" + +.IX Item "\f(CW--format=\fIinput-format\fR\fR" + +.IX Item "\f(CW-c \fIMRI-commandfile\fR\fR" + +.IX Item "\f(CW--mri-script=\fIMRI-commandfile\fR\fR" + +.IX Item "\f(CW-d\fR" + +.IX Item "\f(CW-dc\fR" + +.IX Item "\f(CW-dp\fR" + +.IX Item "\f(CW-e \fIentry\fR\fR" + +.IX Item "\f(CW--entry=\fIentry\fR\fR" + +.IX Item "\f(CW-E\fR" + +.IX Item "\f(CW--export-dynamic\fR" + +.IX Item "\f(CW-EB\fR" + +.IX Item "\f(CW-EL\fR" + +.IX Item "\f(CW-f\fR" + +.IX Item "\f(CW--auxiliary \fIname\fR\fR" + +.IX Item "\f(CW-F \fIname\fR\fR" + +.IX Item "\f(CW--filter \fIname\fR\fR" + +.IX Item "\f(CW-fini \fIname\fR\fR" + +.IX Item "\f(CW-g\fR" + +.IX Item "\f(CW-G\fIvalue\fR\fR" + +.IX Item "\f(CW--gpsize=\fIvalue\fR\fR" + +.IX Item "\f(CW-h\fIname\fR\fR" + +.IX Item "\f(CW-soname=\fIname\fR\fR" + +.IX Item "\f(CW-i\fR" + +.IX Item "\f(CW-init \fIname\fR\fR" + +.IX Item "\f(CW-l\fIarchive\fR\fR" + +.IX Item "\f(CW--library=\fIarchive\fR\fR" + +.IX Item "\f(CW-L\fIsearchdir\fR\fR" + +.IX Item "\f(CW--library-path=\fIsearchdir\fR\fR" + +.IX Item "\f(CW-m\fIemulation\fR\fR" + +.IX Item "\f(CW-M\fR" + +.IX Item "\f(CW--print-map\fR" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\f(CW-n\fR" + +.IX Item "\f(CW--nmagic\fR" + +.IX Item "\f(CW-N\fR" + +.IX Item "\f(CW--omagic\fR" + +.IX Item "\f(CW-o \fIoutput\fR\fR" + +.IX Item "\f(CW--output=\fIoutput\fR\fR" + +.IX Item "\f(CW-O \fIlevel\fR\fR" + +.IX Item "\f(CW-q\fR" + +.IX Item "\f(CW--emit-relocs\fR" + +.IX Item "\f(CW-r\fR" + +.IX Item "\f(CW--relocateable\fR" + +.IX Item "\f(CW-R \fIfilename\fR\fR" + +.IX Item "\f(CW--just-symbols=\fIfilename\fR\fR" + +.IX Item "\f(CW-s\fR" + +.IX Item "\f(CW--strip-all\fR" + +.IX Item "\f(CW-S\fR" + +.IX Item "\f(CW--strip-debug\fR" + +.IX Item "\f(CW-t\fR" + +.IX Item "\f(CW--trace\fR" + +.IX Item "\f(CW-T \fIscriptfile\fR\fR" + +.IX Item "\f(CW--script=\fIscriptfile\fR\fR" + +.IX Item "\f(CW-u \fIsymbol\fR\fR" + +.IX Item "\f(CW--undefined=\fIsymbol\fR\fR" + +.IX Item "\f(CW-Ur\fR" + +.IX Item "\f(CW--unique[=\fISECTION\fR]\fR" + +.IX Item "\f(CW-v\fR" + +.IX Item "\f(CW--version\fR" + +.IX Item "\f(CW-V\fR" + +.IX Item "\f(CW-x\fR" + +.IX Item "\f(CW--discard-all\fR" + +.IX Item "\f(CW-X\fR" + +.IX Item "\f(CW--discard-locals\fR" + +.IX Item "\f(CW-y \fIsymbol\fR\fR" + +.IX Item "\f(CW--trace-symbol=\fIsymbol\fR\fR" + +.IX Item "\f(CW-Y \fIpath\fR\fR" + +.IX Item "\f(CW-z \fIkeyword\fR\fR" + +.IX Item "\f(CW-( \fIarchives\fR -)\fR" + +.IX Item "\f(CW--start-group \fIarchives\fR --end-group\fR" + +.IX Item "\f(CW-assert \fIkeyword\fR\fR" + +.IX Item "\f(CW-Bdynamic\fR" + +.IX Item "\f(CW-dy\fR" + +.IX Item "\f(CW-call_shared\fR" + +.IX Item "\f(CW-Bgroup\fR" + +.IX Item "\f(CW-Bstatic\fR" + +.IX Item "\f(CW-dn\fR" + +.IX Item "\f(CW-non_shared\fR" + +.IX Item "\f(CW-static\fR" + +.IX Item "\f(CW-Bsymbolic\fR" + +.IX Item "\f(CW--check-sections\fR" + +.IX Item "\f(CW--no-check-sections\fR" + +.IX Item "\f(CW--cref\fR" + +.IX Item "\f(CW--defsym \fIsymbol\fR=\fIexpression\fR\fR" + +.IX Item "\f(CW--demangle[=\fIstyle\fR]\fR" + +.IX Item "\f(CW--no-demangle\fR" + +.IX Item "\f(CW--dynamic-linker \fIfile\fR\fR" + +.IX Item "\f(CW--embedded-relocs\fR" + +.IX Item "\f(CW--force-exe-suffix\fR" + +.IX Item "\f(CW--no-gc-sections\fR" + +.IX Item "\f(CW--gc-sections\fR" + +.IX Item "\f(CW--help\fR" + +.IX Item "\f(CW--target-help\fR" + +.IX Item "\f(CW-Map \fImapfile\fR\fR" + +.IX Item "\f(CW--no-keep-memory\fR" + +.IX Item "\f(CW--no-undefined\fR" + +.IX Item "\f(CW-z defs\fR" + +.IX Item "\f(CW--allow-shlib-undefined\fR" + +.IX Item "\f(CW--no-warn-mismatch\fR" + +.IX Item "\f(CW--no-whole-archive\fR" + +.IX Item "\f(CW--noinhibit-exec\fR" + +.IX Item "\f(CW--oformat \fIoutput-format\fR\fR" + +.IX Item "\f(CW-qmagic\fR" + +.IX Item "\f(CW-Qy\fR" + +.IX Item "\f(CW--relax\fR" + +.IX Item "\f(CW--retain-symbols-file \fIfilename\fR\fR" + +.IX Item "\f(CW-rpath \fIdir\fR\fR" + +.IX Item "\f(CW-rpath-link \fIDIR\fR\fR" + +.IX Item "1." + +.IX Item "2." + +.IX Item "3." + +.IX Item "4." + +.IX Item "5." + +.IX Item "6." + +.IX Item "7." + +.IX Item "8." + +.IX Item "\f(CW-shared\fR" + +.IX Item "\f(CW-Bshareable\fR" + +.IX Item "\f(CW--sort-common\fR" + +.IX Item "\f(CW--split-by-file [\fIsize\fR]\fR" + +.IX Item "\f(CW--split-by-reloc [\fIcount\fR]\fR" + +.IX Item "\f(CW--stats\fR" + +.IX Item "\f(CW--traditional-format\fR" + +.IX Item "\f(CW--section-start \fIsectionname\fR=\fIorg\fR\fR" + +.IX Item "\f(CW-Tbss \fIorg\fR\fR" + +.IX Item "\f(CW-Tdata \fIorg\fR\fR" + +.IX Item "\f(CW-Ttext \fIorg\fR\fR" + +.IX Item "\f(CW--dll-verbose\fR" + +.IX Item "\f(CW--verbose\fR" + +.IX Item "\f(CW--version-script=\fIversion-scriptfile\fR\fR" + +.IX Item "\f(CW--warn-common\fR" + +.IX Item "\fBint i = 1;\fR" + +.IX Item "\fBextern int i;\fR" + +.IX Item "\fBint i;\fR" + +.IX Item "1." + +.IX Item "2." + +.IX Item "3." + +.IX Item "4." + +.IX Item "5." + +.IX Item "\f(CW--warn-constructors\fR" + +.IX Item "\f(CW--warn-multiple-gp\fR" + +.IX Item "\f(CW--warn-once\fR" + +.IX Item "\f(CW--warn-section-align\fR" + +.IX Item "\f(CW--whole-archive\fR" + +.IX Item "\f(CW--wrap \fIsymbol\fR\fR" + +.IX Item "\f(CW--enable-new-dtags\fR" + +.IX Item "\f(CW--disable-new-dtags\fR" + +.IX Item "\f(CW--add-stdcall-alias\fR" + +.IX Item "\f(CW--base-file \fIfile\fR\fR" + +.IX Item "\f(CW--dll\fR" + +.IX Item "\f(CW--enable-stdcall-fixup\fR" + +.IX Item "\f(CW--disable-stdcall-fixup\fR" + +.IX Item "\f(CW--export-all-symbols\fR" + +.IX Item "\f(CW--exclude-symbols \fIsymbol\fR,\fIsymbol\fR,...\fR" + +.IX Item "\f(CW--file-alignment\fR" + +.IX Item "\f(CW--heap \fIreserve\fR\fR" + +.IX Item "\f(CW--heap \fIreserve\fR,\fIcommit\fR\fR" + +.IX Item "\f(CW--image-base \fIvalue\fR\fR" + +.IX Item "\f(CW--kill-at\fR" + +.IX Item "\f(CW--major-image-version \fIvalue\fR\fR" + +.IX Item "\f(CW--major-os-version \fIvalue\fR\fR" + +.IX Item "\f(CW--major-subsystem-version \fIvalue\fR\fR" + +.IX Item "\f(CW--minor-image-version \fIvalue\fR\fR" + +.IX Item "\f(CW--minor-os-version \fIvalue\fR\fR" + +.IX Item "\f(CW--minor-subsystem-version \fIvalue\fR\fR" + +.IX Item "\f(CW--output-def \fIfile\fR\fR" + +.IX Item "\f(CW--section-alignment\fR" + +.IX Item "\f(CW--stack \fIreserve\fR\fR" + +.IX Item "\f(CW--stack \fIreserve\fR,\fIcommit\fR\fR" + +.IX Item "\f(CW--subsystem \fIwhich\fR\fR" + +.IX Item "\f(CW--subsystem \fIwhich\fR:\fImajor\fR\fR" + +.IX Item "\f(CW--subsystem \fIwhich\fR:\fImajor\fR.\fIminor\fR\fR" + +.IX Header "ENVIRONMENT" + +.IX Header "SEE ALSO" + +.IX Header "COPYRIGHT" -.BR objdump ( 1 ) -.br -.br -.RB "`\|" ld "\|' and `\|" binutils "\|'" -entries in -.B info\c -.br -.I -ld: the GNU linker\c -, Steve Chamberlain and Roland Pesch; -.I -The GNU Binary Utilities\c -, Roland H. Pesch. - -.SH COPYING -Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 1998, 2000 Free Software Foundation, Inc. -.PP -This document is distributed under the terms of the GNU Free -Documentation License, version 1.1. That license is described in the -sources for this manual page, but it is not displayed here in order to -make this manual more consise. Copies of this license can also be -obtained from: http://www.gnu.org/copyleft/. - -\" .SH GNU Free Documentation License -\" Version 1.1, March 2000 - -\" Copyright (C) 2000 Free Software Foundation, Inc. -\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -\" Everyone is permitted to copy and distribute verbatim -\" copies of this license document, but changing it is -\" not allowed. -\" .PP -\" 0. PREAMBLE -\" .PP -\" The purpose of this License is to make a manual, textbook, or other -\" written document "free" in the sense of freedom: to assure everyone -\" the effective freedom to copy and redistribute it, with or without -\" modifying it, either commercially or noncommercially. Secondarily, -\" this License preserves for the author and publisher a way to get -\" credit for their work, while not being considered responsible for -\" modifications made by others. -\" .PP -\" This License is a kind of "copyleft", which means that derivative -\" works of the document must themselves be free in the same sense. It -\" complements the GNU General Public License, which is a copyleft -\" license designed for free software. -\" .PP -\" We have designed this License in order to use it for manuals for free -\" software, because free software needs free documentation: a free -\" program should come with manuals providing the same freedoms that the -\" software does. But this License is not limited to software manuals; -\" it can be used for any textual work, regardless of subject matter or -\" whether it is published as a printed book. We recommend this License -\" principally for works whose purpose is instruction or reference. -\" .PP -\" 1. APPLICABILITY AND DEFINITIONS -\" .PP -\" This License applies to any manual or other work that contains a -\" notice placed by the copyright holder saying it can be distributed -\" under the terms of this License. The "Document", below, refers to any -\" such manual or work. Any member of the public is a licensee, and is -\" addressed as "you". -\" .PP -\" A "Modified Version" of the Document means any work containing the -\" Document or a portion of it, either copied verbatim, or with -\" modifications and/or translated into another language. -\" .PP -\" A "Secondary Section" is a named appendix or a front-matter section of -\" the Document that deals exclusively with the relationship of the -\" publishers or authors of the Document to the Document's overall subject -\" (or to related matters) and contains nothing that could fall directly -\" within that overall subject. (For example, if the Document is in part a -\" textbook of mathematics, a Secondary Section may not explain any -\" mathematics.) The relationship could be a matter of historical -\" connection with the subject or with related matters, or of legal, -\" commercial, philosophical, ethical or political position regarding -\" them. -\" .PP -\" The "Invariant Sections" are certain Secondary Sections whose titles -\" are designated, as being those of Invariant Sections, in the notice -\" that says that the Document is released under this License. -\" .PP -\" The "Cover Texts" are certain short passages of text that are listed, -\" as Front-Cover Texts or Back-Cover Texts, in the notice that says that -\" the Document is released under this License. -\" .PP -\" A "Transparent" copy of the Document means a machine-readable copy, -\" represented in a format whose specification is available to the -\" general public, whose contents can be viewed and edited directly and -\" straightforwardly with generic text editors or (for images composed of -\" pixels) generic paint programs or (for drawings) some widely available -\" drawing editor, and that is suitable for input to text formatters or -\" for automatic translation to a variety of formats suitable for input -\" to text formatters. A copy made in an otherwise Transparent file -\" format whose markup has been designed to thwart or discourage -\" subsequent modification by readers is not Transparent. A copy that is -\" not "Transparent" is called "Opaque". -\" .PP -\" Examples of suitable formats for Transparent copies include plain -\" ASCII without markup, Texinfo input format, LaTeX input format, SGML -\" or XML using a publicly available DTD, and standard-conforming simple -\" HTML designed for human modification. Opaque formats include -\" PostScript, PDF, proprietary formats that can be read and edited only -\" by proprietary word processors, SGML or XML for which the DTD and/or -\" processing tools are not generally available, and the -\" machine-generated HTML produced by some word processors for output -\" purposes only. -\" .PP -\" The "Title Page" means, for a printed book, the title page itself, -\" plus such following pages as are needed to hold, legibly, the material -\" this License requires to appear in the title page. For works in -\" formats which do not have any title page as such, "Title Page" means -\" the text near the most prominent appearance of the work's title, -\" preceding the beginning of the body of the text. -\" .PP -\" 2. VERBATIM COPYING -\" .PP -\" You may copy and distribute the Document in any medium, either -\" commercially or noncommercially, provided that this License, the -\" copyright notices, and the license notice saying this License applies -\" to the Document are reproduced in all copies, and that you add no other -\" conditions whatsoever to those of this License. You may not use -\" technical measures to obstruct or control the reading or further -\" copying of the copies you make or distribute. However, you may accept -\" compensation in exchange for copies. If you distribute a large enough -\" number of copies you must also follow the conditions in section 3. -\" .PP -\" You may also lend copies, under the same conditions stated above, and -\" you may publicly display copies. -\" .PP -\" 3. COPYING IN QUANTITY -\" .PP -\" If you publish printed copies of the Document numbering more than 100, -\" and the Document's license notice requires Cover Texts, you must enclose -\" the copies in covers that carry, clearly and legibly, all these Cover -\" Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -\" the back cover. Both covers must also clearly and legibly identify -\" you as the publisher of these copies. The front cover must present -\" the full title with all words of the title equally prominent and -\" visible. You may add other material on the covers in addition. -\" Copying with changes limited to the covers, as long as they preserve -\" the title of the Document and satisfy these conditions, can be treated -\" as verbatim copying in other respects. -\" .PP -\" If the required texts for either cover are too voluminous to fit -\" legibly, you should put the first ones listed (as many as fit -\" reasonably) on the actual cover, and continue the rest onto adjacent -\" pages. -\" .PP -\" If you publish or distribute Opaque copies of the Document numbering -\" more than 100, you must either include a machine-readable Transparent -\" copy along with each Opaque copy, or state in or with each Opaque copy -\" a publicly-accessible computer-network location containing a complete -\" Transparent copy of the Document, free of added material, which the -\" general network-using public has access to download anonymously at no -\" charge using public-standard network protocols. If you use the latter -\" option, you must take reasonably prudent steps, when you begin -\" distribution of Opaque copies in quantity, to ensure that this -\" Transparent copy will remain thus accessible at the stated location -\" until at least one year after the last time you distribute an Opaque -\" copy (directly or through your agents or retailers) of that edition to -\" the public. -\" .PP -\" It is requested, but not required, that you contact the authors of the -\" Document well before redistributing any large number of copies, to give -\" them a chance to provide you with an updated version of the Document. -\" .PP -\" 4. MODIFICATIONS -\" .PP -\" You may copy and distribute a Modified Version of the Document under -\" the conditions of sections 2 and 3 above, provided that you release -\" the Modified Version under precisely this License, with the Modified -\" Version filling the role of the Document, thus licensing distribution -\" and modification of the Modified Version to whoever possesses a copy -\" of it. In addition, you must do these things in the Modified Version: -\" .PP -\" A. Use in the Title Page (and on the covers, if any) a title distinct -\" from that of the Document, and from those of previous versions -\" (which should, if there were any, be listed in the History section -\" of the Document). You may use the same title as a previous version -\" if the original publisher of that version gives permission. -\" .PP -\" B. List on the Title Page, as authors, one or more persons or entities -\" responsible for authorship of the modifications in the Modified -\" Version, together with at least five of the principal authors of the -\" Document (all of its principal authors, if it has less than five). -\" .PP -\" C. State on the Title page the name of the publisher of the -\" Modified Version, as the publisher. -\" .PP -\" D. Preserve all the copyright notices of the Document. -\" .PP -\" E. Add an appropriate copyright notice for your modifications -\" adjacent to the other copyright notices. -\" .PP -\" F. Include, immediately after the copyright notices, a license notice -\" giving the public permission to use the Modified Version under the -\" terms of this License, in the form shown in the Addendum below. -\" Preserve in that license notice the full lists of Invariant Sections -\" and required Cover Texts given in the Document's license notice. -\" .PP -\" H. Include an unaltered copy of this License. -\" .PP -\" I. Preserve the section entitled "History", and its title, and add to -\" it an item stating at least the title, year, new authors, and -\" publisher of the Modified Version as given on the Title Page. If -\" there is no section entitled "History" in the Document, create one -\" stating the title, year, authors, and publisher of the Document as -\" given on its Title Page, then add an item describing the Modified -\" Version as stated in the previous sentence. -\" .PP -\" J. Preserve the network location, if any, given in the Document for -\" public access to a Transparent copy of the Document, and likewise -\" the network locations given in the Document for previous versions -\" it was based on. These may be placed in the "History" section. -\" You may omit a network location for a work that was published at -\" least four years before the Document itself, or if the original -\" publisher of the version it refers to gives permission. -\" .PP -\" K. In any section entitled "Acknowledgements" or "Dedications", -\" preserve the section's title, and preserve in the section all the -\" substance and tone of each of the contributor acknowledgements -\" and/or dedications given therein. -\" .PP -\" L. Preserve all the Invariant Sections of the Document, -\" unaltered in their text and in their titles. Section numbers -\" or the equivalent are not considered part of the section titles. -\" .PP -\" M. Delete any section entitled "Endorsements". Such a section -\" may not be included in the Modified Version. -\" .PP -\" N. Do not retitle any existing section as "Endorsements" -\" or to conflict in title with any Invariant Section. -\" .PP -\" If the Modified Version includes new front-matter sections or -\" appendices that qualify as Secondary Sections and contain no material -\" copied from the Document, you may at your option designate some or all -\" of these sections as invariant. To do this, add their titles to the -\" list of Invariant Sections in the Modified Version's license notice. -\" These titles must be distinct from any other section titles. -\" .PP -\" You may add a section entitled "Endorsements", provided it contains -\" nothing but endorsements of your Modified Version by various -\" parties--for example, statements of peer review or that the text has -\" been approved by an organization as the authoritative definition of a -\" standard. -\" .PP -\" You may add a passage of up to five words as a Front-Cover Text, and a -\" passage of up to 25 words as a Back-Cover Text, to the end of the list -\" of Cover Texts in the Modified Version. Only one passage of -\" Front-Cover Text and one of Back-Cover Text may be added by (or -\" through arrangements made by) any one entity. If the Document already -\" includes a cover text for the same cover, previously added by you or -\" by arrangement made by the same entity you are acting on behalf of, -\" you may not add another; but you may replace the old one, on explicit -\" permission from the previous publisher that added the old one. -\" .PP -\" The author(s) and publisher(s) of the Document do not by this License -\" give permission to use their names for publicity for or to assert or -\" imply endorsement of any Modified Version. -\" .PP - -\" 5. COMBINING DOCUMENTS -\" .PP -\" You may combine the Document with other documents released under this -\" License, under the terms defined in section 4 above for modified -\" versions, provided that you include in the combination all of the -\" Invariant Sections of all of the original documents, unmodified, and -\" list them all as Invariant Sections of your combined work in its -\" license notice. -\" .PP -\" The combined work need only contain one copy of this License, and -\" multiple identical Invariant Sections may be replaced with a single -\" copy. If there are multiple Invariant Sections with the same name but -\" different contents, make the title of each such section unique by -\" adding at the end of it, in parentheses, the name of the original -\" author or publisher of that section if known, or else a unique number. -\" Make the same adjustment to the section titles in the list of -\" Invariant Sections in the license notice of the combined work. -\" .PP -\" In the combination, you must combine any sections entitled "History" -\" in the various original documents, forming one section entitled -\" "History"; likewise combine any sections entitled "Acknowledgements", -\" and any sections entitled "Dedications". You must delete all sections -\" entitled "Endorsements." -\" .PP - -\" 6. COLLECTIONS OF DOCUMENTS -\" .PP -\" You may make a collection consisting of the Document and other documents -\" released under this License, and replace the individual copies of this -\" License in the various documents with a single copy that is included in -\" the collection, provided that you follow the rules of this License for -\" verbatim copying of each of the documents in all other respects. -\" .PP -\" You may extract a single document from such a collection, and distribute -\" it individually under this License, provided you insert a copy of this -\" License into the extracted document, and follow this License in all -\" other respects regarding verbatim copying of that document. -\" .PP - -\" 7. AGGREGATION WITH INDEPENDENT WORKS -\" .PP -\" A compilation of the Document or its derivatives with other separate -\" and independent documents or works, in or on a volume of a storage or -\" distribution medium, does not as a whole count as a Modified Version -\" of the Document, provided no compilation copyright is claimed for the -\" compilation. Such a compilation is called an "aggregate", and this -\" License does not apply to the other self-contained works thus compiled -\" with the Document, on account of their being thus compiled, if they -\" are not themselves derivative works of the Document. -\" .PP -\" If the Cover Text requirement of section 3 is applicable to these -\" copies of the Document, then if the Document is less than one quarter -\" of the entire aggregate, the Document's Cover Texts may be placed on -\" covers that surround only the Document within the aggregate. -\" Otherwise they must appear on covers around the whole aggregate. -\" .PP - -\" 8. TRANSLATION -\" .PP -\" Translation is considered a kind of modification, so you may -\" distribute translations of the Document under the terms of section 4. -\" Replacing Invariant Sections with translations requires special -\" permission from their copyright holders, but you may include -\" translations of some or all Invariant Sections in addition to the -\" original versions of these Invariant Sections. You may include a -\" translation of this License provided that you also include the -\" original English version of this License. In case of a disagreement -\" between the translation and the original English version of this -\" License, the original English version will prevail. -\" .PP - -\" 9. TERMINATION -\" .PP -\" You may not copy, modify, sublicense, or distribute the Document except -\" as expressly provided for under this License. Any other attempt to -\" copy, modify, sublicense or distribute the Document is void, and will -\" automatically terminate your rights under this License. However, -\" parties who have received copies, or rights, from you under this -\" License will not have their licenses terminated so long as such -\" parties remain in full compliance. -\" .PP - -\" 10. FUTURE REVISIONS OF THIS LICENSE -\" .PP -\" The Free Software Foundation may publish new, revised versions -\" of the GNU Free Documentation License from time to time. Such new -\" versions will be similar in spirit to the present version, but may -\" differ in detail to address new problems or concerns. See -\" http://www.gnu.org/copyleft/. -\" .PP -\" Each version of the License is given a distinguishing version number. -\" If the Document specifies that a particular numbered version of this -\" License "or any later version" applies to it, you have the option of -\" following the terms and conditions either of that specified version or -\" of any later version that has been published (not as a draft) by the -\" Free Software Foundation. If the Document does not specify a version -\" number of this License, you may choose any version ever published (not -\" as a draft) by the Free Software Foundation. -\" .PP - -\" ADDENDUM: How to use this License for your documents -\" .PP -\" To use this License in a document you have written, include a copy of -\" the License in the document and put the following copyright and -\" license notices just after the title page: -\" .PP -\" Copyright (c) YEAR YOUR NAME. -\" Permission is granted to copy, distribute and/or -\" modify this document under the terms of the GNU -\" Free Documentation License, Version 1.1 or any later -\" version published by the Free Software Foundation; -\" with the Invariant Sections being LIST THEIR TITLES, -\" with the Front-Cover Texts being LIST, and with the -\" Back-Cover Texts being LIST. A copy of the license -\" is included in the section entitled "GNU Free -\" Documentation License". -\" .PP -\" If you have no Invariant Sections, write "with no Invariant Sections" -\" instead of saying which ones are invariant. If you have no -\" Front-Cover Texts, write "no Front-Cover Texts" instead of -\" "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. -\" .PP -\" If your document contains nontrivial examples of program code, we -\" recommend releasing these examples in parallel under your choice of -\" free software license, such as the GNU General Public License, -\" to permit their use in free software. diff --git a/ld/ld.texinfo b/ld/ld.texinfo index 552d4aa..010b82e 100644 --- a/ld/ld.texinfo +++ b/ld/ld.texinfo @@ -9,6 +9,38 @@ @c @smallbook +@c man begin NAME +@ifset man +@c Configure for the generation of man pages +@set UsesEnvVars +@set GENERIC +@set A29K +@set ARC +@set ARM +@set D10V +@set D30V +@set H8/300 +@set H8/500 +@set HPPA +@set I370 +@set I80386 +@set I860 +@set I960 +@set M32R +@set M68HC11 +@set M680X0 +@set MCORE +@set MIPS +@set PDP11 +@set PJ +@set SH +@set SPARC +@set C54X +@set V850 +@set VAX +@end ifset +@c man end + @ifinfo @format START-INFO-DIR-ENTRY @@ -63,14 +95,16 @@ notice identical to this one except for the removal of this paragraph @end tex @vskip 0pt plus 1filll +@c man begin COPYRIGHT Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000 Free Software Foundation, Inc. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, with no Front-Cover Texts, and with no - Back-Cover Texts. A copy of the license is included in the - section entitled "GNU Free Documentation License". +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with no Invariant Sections, with no Front-Cover Texts, and with no +Back-Cover Texts. A copy of the license is included in the +section entitled "GNU Free Documentation License". +@c man end @end titlepage @end iftex @@ -123,6 +157,21 @@ section entitled "GNU Free Documentation License". @cindex @sc{gnu} linker @cindex what is this? + +@ifsef man +@c man begin SYNOPSIS +ld [ options ] objfile... +@c man end + +@c man begin SEEALSO +ar(1), nm(1), objcopy(1), objdump(1), readelf(1) and +the Info entries for @file{binutils} and +@file{ld}. +@c man end +@end ifset + +@c man begin DESCRIPTION + @code{ld} combines a number of object and archive files, relocates their data and ties up symbol references. Usually the last step in compiling a program is to run @code{ld}. @@ -131,6 +180,14 @@ compiling a program is to run @code{ld}. a superset of AT&T's Link Editor Command Language syntax, to provide explicit and total control over the linking process. +@ifset man +@c For the man only +This man page does not describe the command language; see the +@code{ld} entry in @code{info}, or the manual +ld: the GNU linker, for full details on the command language and +on other aspects of the GNU linker. +@end ifset + @ifclear SingleFormat This version of @code{ld} uses the general purpose BFD libraries to operate on object files. This allows @code{ld} to read, combine, and @@ -145,13 +202,19 @@ execution immediately upon encountering an error; whenever possible, @code{ld} continues executing, allowing you to identify other errors (or, in some cases, to get an output file in spite of the error). +@c man end + @node Invocation @chapter Invocation +@c man begin DESCRIPTION + The @sc{gnu} linker @code{ld} is meant to cover a broad range of situations, and to be as compatible as possible with other linkers. As a result, you have many choices to control its behavior. +@c man end + @ifset UsesEnvVars @menu * Options:: Command Line Options @@ -164,6 +227,9 @@ you have many choices to control its behavior. @cindex command line @cindex options + +@c man begin OPTIONS + The linker supports a plethora of command-line options, but in actual practice few of them are used in any particular context. @cindex standard Unix system @@ -309,7 +375,10 @@ The default format is taken from the environment variable @xref{Environment}. @end ifset You can also define the input format from a script, using the command -@code{TARGET}; see @ref{Format Commands}. +@code{TARGET}; +@ifclear man +see @ref{Format Commands}. +@end ifclear @end ifclear @kindex -c @var{MRI-cmdfile} @@ -319,7 +388,13 @@ You can also define the input format from a script, using the command @itemx --mri-script=@var{MRI-commandfile} For compatibility with linkers produced by MRI, @code{ld} accepts script files written in an alternate, restricted command language, described in -@ref{MRI,,MRI Compatible Script Files}. Introduce MRI script files with +@ifclear man +@ref{MRI,,MRI Compatible Script Files}. +@end ifclear +@ifset man +the MRI Compatible Script Files section of GNU ld documentation. +@end ifset +Introduce MRI script files with the option @samp{-c}; use the @samp{-T} option to run linker scripts written in the general-purpose @code{ld} scripting language. If @var{MRI-cmdfile} does not exist, @code{ld} looks for it in the directories @@ -1443,8 +1518,12 @@ those options are only available for ELF systems. @end table +@c man end + @subsection Options specific to i386 PE targets +@c man begin OPTIONS + The i386 PE linker supports the @code{-shared} option, which causes the output to be a dynamically linked library (DLL) instead of a normal executable. You should name the output @code{*.dll} when you @@ -1600,10 +1679,14 @@ subsystem version also. @end table +@c man end + @ifset UsesEnvVars @node Environment @section Environment Variables +@c man begin ENVIRONMENT + You can change the behavior of @code{ld} with the environment variables @code{GNUTARGET}, @code{LDEMULATION}, and @code{COLLECT_NO_DEMANGLE}. @@ -1631,7 +1714,6 @@ available emulations with the @samp{--verbose} or @samp{-V} options. If the @samp{-m} option is not used, and the @code{LDEMULATION} environment variable is not defined, the default emulation depends upon how the linker was configured. -@end ifset @kindex COLLECT_NO_DEMANGLE @cindex demangling, default @@ -1642,6 +1724,9 @@ a similar fashion by the @code{gcc} linker wrapper program. The default may be overridden by the @samp{--demangle} and @samp{--no-demangle} options. +@c man end +@end ifset + @node Scripts @chapter Linker Scripts |