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