binutils/doc/nlmconv.1

   1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "NLMCONV 1"
 127 .TH NLMCONV 1 "2012-11-13" "binutils-2.23.1" "GNU Development Tools"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 nlmconv \- converts object code into an NLM.
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 nlmconv [\fB\-I\fR \fIbfdname\fR|\fB\-\-input\-target=\fR\fIbfdname\fR]
 137         [\fB\-O\fR \fIbfdname\fR|\fB\-\-output\-target=\fR\fIbfdname\fR]
 138         [\fB\-T\fR \fIheaderfile\fR|\fB\-\-header\-file=\fR\fIheaderfile\fR]
 139         [\fB\-d\fR|\fB\-\-debug\fR] [\fB\-l\fR \fIlinker\fR|\fB\-\-linker=\fR\fIlinker\fR]
 140         [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
 141         \fIinfile\fR \fIoutfile\fR
 142 .SH "DESCRIPTION"
 143 .IX Header "DESCRIPTION"
 144 \&\fBnlmconv\fR converts the relocatable \fBi386\fR object file
 145 \&\fIinfile\fR into the NetWare Loadable Module \fIoutfile\fR, optionally
 146 reading \fIheaderfile\fR for \s-1NLM\s0 header information.  For instructions
 147 on writing the \s-1NLM\s0 command file language used in header files, see the
 148 \&\fBlinkers\fR section, \fB\s-1NLMLINK\s0\fR in particular, of the \fI\s-1NLM\s0
 149 Development and Tools Overview\fR, which is part of the \s-1NLM\s0 Software
 150 Developer's Kit (\*(L"\s-1NLM\s0 \s-1SDK\s0\*(R"), available from Novell, Inc.
 151 \&\fBnlmconv\fR uses the \s-1GNU\s0 Binary File Descriptor library to read
 152 \&\fIinfile\fR;
 153 .PP
 154 \&\fBnlmconv\fR can perform a link step.  In other words, you can list
 155 more than one object file for input if you list them in the definitions
 156 file (rather than simply specifying one input file on the command line).
 157 In this case, \fBnlmconv\fR calls the linker for you.
 158 .SH "OPTIONS"
 159 .IX Header "OPTIONS"
 160 .IP "\fB\-I\fR \fIbfdname\fR" 4
 161 .IX Item "-I bfdname"
 162 .PD 0
 163 .IP "\fB\-\-input\-target=\fR\fIbfdname\fR" 4
 164 .IX Item "--input-target=bfdname"
 165 .PD
 166 Object format of the input file.  \fBnlmconv\fR can usually determine
 167 the format of a given file (so no default is necessary).
 168 .IP "\fB\-O\fR \fIbfdname\fR" 4
 169 .IX Item "-O bfdname"
 170 .PD 0
 171 .IP "\fB\-\-output\-target=\fR\fIbfdname\fR" 4
 172 .IX Item "--output-target=bfdname"
 173 .PD
 174 Object format of the output file.  \fBnlmconv\fR infers the output
 175 format based on the input format, e.g. for a \fBi386\fR input file the
 176 output format is \fBnlm32\-i386\fR.
 177 .IP "\fB\-T\fR \fIheaderfile\fR" 4
 178 .IX Item "-T headerfile"
 179 .PD 0
 180 .IP "\fB\-\-header\-file=\fR\fIheaderfile\fR" 4
 181 .IX Item "--header-file=headerfile"
 182 .PD
 183 Reads \fIheaderfile\fR for \s-1NLM\s0 header information.  For instructions on
 184 writing the \s-1NLM\s0 command file language used in header files, see see the
 185 \&\fBlinkers\fR section, of the \fI\s-1NLM\s0 Development and Tools
 186 Overview\fR, which is part of the \s-1NLM\s0 Software Developer's Kit, available
 187 from Novell, Inc.
 188 .IP "\fB\-d\fR" 4
 189 .IX Item "-d"
 190 .PD 0
 191 .IP "\fB\-\-debug\fR" 4
 192 .IX Item "--debug"
 193 .PD
 194 Displays (on standard error) the linker command line used by \fBnlmconv\fR.
 195 .IP "\fB\-l\fR \fIlinker\fR" 4
 196 .IX Item "-l linker"
 197 .PD 0
 198 .IP "\fB\-\-linker=\fR\fIlinker\fR" 4
 199 .IX Item "--linker=linker"
 200 .PD
 201 Use \fIlinker\fR for any linking.  \fIlinker\fR can be an absolute or a
 202 relative pathname.
 203 .IP "\fB\-h\fR" 4
 204 .IX Item "-h"
 205 .PD 0
 206 .IP "\fB\-\-help\fR" 4
 207 .IX Item "--help"
 208 .PD
 209 Prints a usage summary.
 210 .IP "\fB\-V\fR" 4
 211 .IX Item "-V"
 212 .PD 0
 213 .IP "\fB\-\-version\fR" 4
 214 .IX Item "--version"
 215 .PD
 216 Prints the version number for \fBnlmconv\fR.
 217 .IP "\fB@\fR\fIfile\fR" 4
 218 .IX Item "@file"
 219 Read command-line options from \fIfile\fR.  The options read are
 220 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
 221 does not exist, or cannot be read, then the option will be treated
 222 literally, and not removed.
 223 .Sp
 224 Options in \fIfile\fR are separated by whitespace.  A whitespace
 225 character may be included in an option by surrounding the entire
 226 option in either single or double quotes.  Any character (including a
 227 backslash) may be included by prefixing the character to be included
 228 with a backslash.  The \fIfile\fR may itself contain additional
 229 @\fIfile\fR options; any such options will be processed recursively.
 230 .SH "SEE ALSO"
 231 .IX Header "SEE ALSO"
 232 the Info entries for \fIbinutils\fR.
 233 .SH "COPYRIGHT"
 234 .IX Header "COPYRIGHT"
 235 Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
 236 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
 237 2010, 2011, 2012
 238 Free Software Foundation, Inc.
 239 .PP
 240 Permission is granted to copy, distribute and/or modify this document
 241 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
 242 or any later version published by the Free Software Foundation;
 243 with no Invariant Sections, with no Front-Cover Texts, and with no
 244 Back-Cover Texts.  A copy of the license is included in the
 245 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".