binutils/doc/nlmconv.1

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