sdcc/support/sdbinutils/binutils/doc/nlmconv.1

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