]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blobdiff - binutils/nlmconv.1
Add command line switches to objcopy to provide lists of symbols in files
[thirdparty/binutils-gdb.git] / binutils / nlmconv.1
index 7590b66de5eb3fce0e1d823d8358d2d2d78383d2..ecd8bfef0b790f752a91f733c81c4e941a7f2061 100644 (file)
@@ -1,12 +1,9 @@
-.rn '' }`
-''' $RCSfile$$Revision$$Date$
-'''
-''' $Log$
-''' Revision 1.5  2001/03/25 20:32:25  nickc
-''' Automate generate on man pages
-'''
-'''
-.de Sh
+.\" Automatically generated by Pod::Man version 1.02
+.\" Wed May 30 12:24:27 2001
+.\"
+.\" Standard preamble:
+.\" ======================================================================
+.de Sh \" Subsection heading
 .br
 .if t .Sp
 .ne 5
 \fB\\$1\fR
 .PP
 ..
-.de Sp
+.de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
 ..
-.de Ip
+.de Ip \" List item
 .br
 .ie \\n(.$>=3 .ne \\$3
 .el .ne 3
 .IP "\\$1" \\$2
 ..
-.de Vb
+.de Vb \" Begin verbatim text
 .ft CW
 .nf
 .ne \\$1
 ..
-.de Ve
+.de Ve \" End verbatim text
 .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.
-'''
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  | will give a
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
+.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
+.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
 .tr \(*W-|\(bv\*(Tr
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .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' '
+.    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" ""
+.    ds C` `
+.    ds C' '
 '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
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
 '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
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr
+.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
+.\" index entries marked with X<> in POD.  Of course, you'll have to process
+.\" the output yourself in some meaningful 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
+.\"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it
+.\" makes way too many mistakes in technical documents.
+.hy 0
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .bd B 3
-.      \" fudge factors for nroff and troff
+.    \" fudge factors for nroff and troff
 .if n \{\
-.      ds #H 0
-.      ds #V .8m
-.      ds #F .3m
-.      ds #[ \f1
-.      ds #] \fP
+.    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 #] \&
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
 .\}
-.      \" simple accents for nroff and troff
+.    \" simple accents for nroff and troff
 .if n \{\
-.      ds ' \&
-.      ds ` \&
-.      ds ^ \&
-.      ds , \&
-.      ds ~ ~
-.      ds ? ?
-.      ds ! !
-.      ds /
-.      ds q
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
 .\}
 .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'
+.    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 / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 .\}
-.      \" troff and (daisy-wheel) nroff accents
+.    \" 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 \*(#[\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
+.    \" 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)
+.    \" 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
+.    ds : e
+.    ds 8 ss
+.    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
 .\}
 .rm #[ #] #H #V #F C
+.\" ======================================================================
+.\"
+.IX Title "NLMCONV.1 1"
+.TH NLMCONV.1 1 "binutils-2.11.90" "2001-05-30" "GNU"
+.UC
 .SH "NAME"
-nlmconv \- converts object code into an NLM.
+nlmconv \- converts object code into an \s-1NLM\s0.
 .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 ]
+.IX Header "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;
+.IX Header "DESCRIPTION"
+\&\f(CW\*(C`nlmconv\*(C'\fR converts the relocatable \fBi386\fR object file
+\&\fIinfile\fR into the NetWare Loadable Module \fIoutfile\fR, optionally
+reading \fIheaderfile\fR for \s-1NLM\s0 header information.  For instructions
+on writing the \s-1NLM\s0 command file language used in header files, see the
+\&\fBlinkers\fR section, \fB\s-1NLMLINK\s0\fR in particular, of the \fI\s-1NLM\s0
+Development and Tools Overview\fR, which is part of the \s-1NLM\s0 Software
+Developer's Kit (``\s-1NLM\s0 \s-1SDK\s0''), available from Novell, Inc.
+\&\f(CW\*(C`nlmconv\*(C'\fR uses the \s-1GNU\s0 Binary File Descriptor library to read
+\&\fIinfile\fR;
 .PP
-\f(CWnlmconv\fR can perform a link step.  In other words, you can list
+\&\f(CW\*(C`nlmconv\*(C'\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.
+In this case, \f(CW\*(C`nlmconv\*(C'\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
+.IX Header "OPTIONS"
+.Ip "\f(CW\*(C`\-I \f(CIbfdname\f(CW\*(C'\fR" 4
+.IX Item "-I bfdname"
+.Ip "\f(CW\*(C`\-\-input\-target=\f(CIbfdname\f(CW\*(C'\fR" 4
+.IX Item "--input-target=bfdname"
+Object format of the input file.  \f(CW\*(C`nlmconv\*(C'\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
+.Ip "\f(CW\*(C`\-O \f(CIbfdname\f(CW\*(C'\fR" 4
+.IX Item "-O bfdname"
+.Ip "\f(CW\*(C`\-\-output\-target=\f(CIbfdname\f(CW\*(C'\fR" 4
+.IX Item "--output-target=bfdname"
+Object format of the output file.  \f(CW\*(C`nlmconv\*(C'\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
+output format is \fBnlm32\-i386\fR.
+.Ip "\f(CW\*(C`\-T \f(CIheaderfile\f(CW\*(C'\fR" 4
+.IX Item "-T headerfile"
+.Ip "\f(CW\*(C`\-\-header\-file=\f(CIheaderfile\f(CW\*(C'\fR" 4
+.IX Item "--header-file=headerfile"
 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
+\&\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
+.Ip "\f(CW\*(C`\-d\*(C'\fR" 4
+.IX Item "-d"
+.Ip "\f(CW\*(C`\-\-debug\*(C'\fR" 4
+.IX Item "--debug"
+Displays (on standard error) the linker command line used by \f(CW\*(C`nlmconv\*(C'\fR.
+.Ip "\f(CW\*(C`\-l \f(CIlinker\f(CW\*(C'\fR" 4
+.IX Item "-l linker"
+.Ip "\f(CW\*(C`\-\-linker=\f(CIlinker\f(CW\*(C'\fR" 4
+.IX Item "--linker=linker"
 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
+.Ip "\f(CW\*(C`\-h\*(C'\fR" 4
+.IX Item "-h"
+.Ip "\f(CW\*(C`\-\-help\*(C'\fR" 4
+.IX Item "--help"
 Prints a usage summary.
-.Ip "\f(CW-V\fR" 4
-.Ip "\f(CW--version\fR" 4
-Prints the version number for \f(CWnlmconv\fR.
+.Ip "\f(CW\*(C`\-V\*(C'\fR" 4
+.IX Item "-V"
+.Ip "\f(CW\*(C`\-\-version\*(C'\fR" 4
+.IX Item "--version"
+Prints the version number for \f(CW\*(C`nlmconv\*(C'\fR.
 .SH "SEE ALSO"
+.IX Header "SEE ALSO"
 the Info entries for \fIbinutils\fR.
 .SH "COPYRIGHT"
+.IX Header "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
+under the terms of the \s-1GNU\s0 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"
-
-.IX Item "\f(CW--debug\fR"
-
-.IX Item "\f(CW-l \fIlinker\fR\fR"
-
-.IX Item "\f(CW--linker=\fIlinker\fR\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"
-
+section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".