Add GNU Free Documentation License
[deliverable/binutils-gdb.git] / binutils / nlmconv.1
1 .\" Copyright (c) 1991, 1996, 2000 Free Software Foundation
2 .\" See section COPYING for conditions for redistribution
3 .TH nlmconv 1 "March 1996" "Free Software Foundation" "GNU Development Tools"
4 .de BP
5 .sp
6 .ti \-.2i
7 \(**
8 ..
9
10 .SH NAME
11 nlmconv \- converts object code into an NLM
12
13 .SH SYNOPSIS
14 .hy 0
15 .na
16 .TP
17 .B nlmconv
18 .RB "[\|" \-I\ \fIbfdname\fB\ |\ \-\-input\-target=\fIbfdname\fR "\|]"
19 .RB "[\|" \-O\ \fIbfdname\fB\ |\ \-\-output\-target=\fIbfdname\fR "\|]"
20 .RB "[\|" \-T\ \fIheaderfile\fB\ |\ \-\-header\-file=\fIheaderfile\fR "\|]"
21 .RB "[\|" \-V\ |\ \-\-version\fR "\|]"
22 .RB "[\|" \-\-help\fR "\|]"
23 .B infile
24 .B outfile
25 .SH DESCRIPTION
26 .B nlmconv
27 converts the relocatable object file
28 .B infile
29 into the NetWare Loadable Module
30 .BR outfile ,
31 optionally reading
32 .I headerfile
33 for NLM header information. For instructions on writing the NLM
34 command file language used in header files, see
35 .IR "The NetWare Tool Maker Specification Manual" ,
36 available from Novell, Inc.
37 .B nlmconv
38 currently works with i386 object files in
39 .BR COFF ,
40 .BR ELF ,
41 or
42 .B a.out
43 format, and with SPARC object files in
44 .B ELF
45 or
46 .B a.out
47 format.
48 .br
49 .B nlmconv
50 uses the GNU Binary File Descriptor library to read
51 .IR infile .
52 .SH OPTIONS
53 .TP
54 .B \-I \fIbfdname\fR, \fB\-\-input\-target=\fIbfdname
55 Consider the source file's object format to be
56 .IR bfdname ,
57 rather than attempting to deduce it.
58 .TP
59 .B \-O \fIbfdname\fR, \fB\-\-output\-target=\fIbfdname
60 Write the output file using the object format
61 .IR bfdname .
62 .B nlmconv
63 infers the output format based on the input format, e.g. for an i386
64 input file the output format is
65 .IR nlm32\-i386 .
66 .TP
67 .B \-T \fIheaderfile\fR, \fB\-\-header\-file=\fIheaderfile
68 Reads
69 .I headerfile
70 for NLM header information. For instructions on writing the NLM
71 command file language used in header files, see
72 .IR "The NetWare Tool Maker Specification Manual" ,
73 available from Novell, Inc.
74 .TP
75 .B \-V\fR, \fB\-\-version
76 Show the version number of
77 .B nlmconv
78 and exit.
79 .TP
80 .B \-h\fR, \fB\-\-help
81 Show a summary of the options to
82 .B nlmconv
83 and exit.
84 .SH "SEE ALSO"
85 .RB "`\|" binutils "\|'"
86 entry in
87 .B
88 info\c
89 \&;
90 .I
91 The GNU Binary Utilities\c
92 \&, Roland H. Pesch (June 1993).
93
94 .SH COPYING
95 Copyright (c) 1993, 2000 Free Software Foundation, Inc.
96 .PP
97 This document is distributed under the terms of the GNU Free
98 Documenation License. That license is described in the GNU Free
99 Documentation License section.
100
101 .SH GNU Free Documentation License
102 Version 1.1, March 2000
103
104 Copyright (C) 2000 Free Software Foundation, Inc.
105 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
106
107 Everyone is permitted to copy and distribute verbatim
108 copies of this license document, but changing it is
109 not allowed.
110 .PP
111 0. PREAMBLE
112 .PP
113 The purpose of this License is to make a manual, textbook, or other
114 written document "free" in the sense of freedom: to assure everyone
115 the effective freedom to copy and redistribute it, with or without
116 modifying it, either commercially or noncommercially. Secondarily,
117 this License preserves for the author and publisher a way to get
118 credit for their work, while not being considered responsible for
119 modifications made by others.
120 .PP
121 This License is a kind of "copyleft", which means that derivative
122 works of the document must themselves be free in the same sense. It
123 complements the GNU General Public License, which is a copyleft
124 license designed for free software.
125 .PP
126 We have designed this License in order to use it for manuals for free
127 software, because free software needs free documentation: a free
128 program should come with manuals providing the same freedoms that the
129 software does. But this License is not limited to software manuals;
130 it can be used for any textual work, regardless of subject matter or
131 whether it is published as a printed book. We recommend this License
132 principally for works whose purpose is instruction or reference.
133 .PP
134 1. APPLICABILITY AND DEFINITIONS
135 .PP
136 This License applies to any manual or other work that contains a
137 notice placed by the copyright holder saying it can be distributed
138 under the terms of this License. The "Document", below, refers to any
139 such manual or work. Any member of the public is a licensee, and is
140 addressed as "you".
141 .PP
142 A "Modified Version" of the Document means any work containing the
143 Document or a portion of it, either copied verbatim, or with
144 modifications and/or translated into another language.
145 .PP
146 A "Secondary Section" is a named appendix or a front-matter section of
147 the Document that deals exclusively with the relationship of the
148 publishers or authors of the Document to the Document's overall subject
149 (or to related matters) and contains nothing that could fall directly
150 within that overall subject. (For example, if the Document is in part a
151 textbook of mathematics, a Secondary Section may not explain any
152 mathematics.) The relationship could be a matter of historical
153 connection with the subject or with related matters, or of legal,
154 commercial, philosophical, ethical or political position regarding
155 them.
156 .PP
157 The "Invariant Sections" are certain Secondary Sections whose titles
158 are designated, as being those of Invariant Sections, in the notice
159 that says that the Document is released under this License.
160 .PP
161 The "Cover Texts" are certain short passages of text that are listed,
162 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
163 the Document is released under this License.
164 .PP
165 A "Transparent" copy of the Document means a machine-readable copy,
166 represented in a format whose specification is available to the
167 general public, whose contents can be viewed and edited directly and
168 straightforwardly with generic text editors or (for images composed of
169 pixels) generic paint programs or (for drawings) some widely available
170 drawing editor, and that is suitable for input to text formatters or
171 for automatic translation to a variety of formats suitable for input
172 to text formatters. A copy made in an otherwise Transparent file
173 format whose markup has been designed to thwart or discourage
174 subsequent modification by readers is not Transparent. A copy that is
175 not "Transparent" is called "Opaque".
176 .PP
177 Examples of suitable formats for Transparent copies include plain
178 ASCII without markup, Texinfo input format, LaTeX input format, SGML
179 or XML using a publicly available DTD, and standard-conforming simple
180 HTML designed for human modification. Opaque formats include
181 PostScript, PDF, proprietary formats that can be read and edited only
182 by proprietary word processors, SGML or XML for which the DTD and/or
183 processing tools are not generally available, and the
184 machine-generated HTML produced by some word processors for output
185 purposes only.
186 .PP
187 The "Title Page" means, for a printed book, the title page itself,
188 plus such following pages as are needed to hold, legibly, the material
189 this License requires to appear in the title page. For works in
190 formats which do not have any title page as such, "Title Page" means
191 the text near the most prominent appearance of the work's title,
192 preceding the beginning of the body of the text.
193 .PP
194 2. VERBATIM COPYING
195 .PP
196 You may copy and distribute the Document in any medium, either
197 commercially or noncommercially, provided that this License, the
198 copyright notices, and the license notice saying this License applies
199 to the Document are reproduced in all copies, and that you add no other
200 conditions whatsoever to those of this License. You may not use
201 technical measures to obstruct or control the reading or further
202 copying of the copies you make or distribute. However, you may accept
203 compensation in exchange for copies. If you distribute a large enough
204 number of copies you must also follow the conditions in section 3.
205 .PP
206 You may also lend copies, under the same conditions stated above, and
207 you may publicly display copies.
208 .PP
209 3. COPYING IN QUANTITY
210 .PP
211 If you publish printed copies of the Document numbering more than 100,
212 and the Document's license notice requires Cover Texts, you must enclose
213 the copies in covers that carry, clearly and legibly, all these Cover
214 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
215 the back cover. Both covers must also clearly and legibly identify
216 you as the publisher of these copies. The front cover must present
217 the full title with all words of the title equally prominent and
218 visible. You may add other material on the covers in addition.
219 Copying with changes limited to the covers, as long as they preserve
220 the title of the Document and satisfy these conditions, can be treated
221 as verbatim copying in other respects.
222 .PP
223 If the required texts for either cover are too voluminous to fit
224 legibly, you should put the first ones listed (as many as fit
225 reasonably) on the actual cover, and continue the rest onto adjacent
226 pages.
227 .PP
228 If you publish or distribute Opaque copies of the Document numbering
229 more than 100, you must either include a machine-readable Transparent
230 copy along with each Opaque copy, or state in or with each Opaque copy
231 a publicly-accessible computer-network location containing a complete
232 Transparent copy of the Document, free of added material, which the
233 general network-using public has access to download anonymously at no
234 charge using public-standard network protocols. If you use the latter
235 option, you must take reasonably prudent steps, when you begin
236 distribution of Opaque copies in quantity, to ensure that this
237 Transparent copy will remain thus accessible at the stated location
238 until at least one year after the last time you distribute an Opaque
239 copy (directly or through your agents or retailers) of that edition to
240 the public.
241 .PP
242 It is requested, but not required, that you contact the authors of the
243 Document well before redistributing any large number of copies, to give
244 them a chance to provide you with an updated version of the Document.
245 .PP
246 4. MODIFICATIONS
247 .PP
248 You may copy and distribute a Modified Version of the Document under
249 the conditions of sections 2 and 3 above, provided that you release
250 the Modified Version under precisely this License, with the Modified
251 Version filling the role of the Document, thus licensing distribution
252 and modification of the Modified Version to whoever possesses a copy
253 of it. In addition, you must do these things in the Modified Version:
254 .PP
255 A. Use in the Title Page (and on the covers, if any) a title distinct
256 from that of the Document, and from those of previous versions
257 (which should, if there were any, be listed in the History section
258 of the Document). You may use the same title as a previous version
259 if the original publisher of that version gives permission.
260 .PP
261 B. List on the Title Page, as authors, one or more persons or entities
262 responsible for authorship of the modifications in the Modified
263 Version, together with at least five of the principal authors of the
264 Document (all of its principal authors, if it has less than five).
265 .PP
266 C. State on the Title page the name of the publisher of the
267 Modified Version, as the publisher.
268 .PP
269 D. Preserve all the copyright notices of the Document.
270 .PP
271 E. Add an appropriate copyright notice for your modifications
272 adjacent to the other copyright notices.
273 .PP
274 F. Include, immediately after the copyright notices, a license notice
275 giving the public permission to use the Modified Version under the
276 terms of this License, in the form shown in the Addendum below.
277 Preserve in that license notice the full lists of Invariant Sections
278 and required Cover Texts given in the Document's license notice.
279 .PP
280 H. Include an unaltered copy of this License.
281 .PP
282 I. Preserve the section entitled "History", and its title, and add to
283 it an item stating at least the title, year, new authors, and
284 publisher of the Modified Version as given on the Title Page. If
285 there is no section entitled "History" in the Document, create one
286 stating the title, year, authors, and publisher of the Document as
287 given on its Title Page, then add an item describing the Modified
288 Version as stated in the previous sentence.
289 .PP
290 J. Preserve the network location, if any, given in the Document for
291 public access to a Transparent copy of the Document, and likewise
292 the network locations given in the Document for previous versions
293 it was based on. These may be placed in the "History" section.
294 You may omit a network location for a work that was published at
295 least four years before the Document itself, or if the original
296 publisher of the version it refers to gives permission.
297 .PP
298 K. In any section entitled "Acknowledgements" or "Dedications",
299 preserve the section's title, and preserve in the section all the
300 substance and tone of each of the contributor acknowledgements
301 and/or dedications given therein.
302 .PP
303 L. Preserve all the Invariant Sections of the Document,
304 unaltered in their text and in their titles. Section numbers
305 or the equivalent are not considered part of the section titles.
306 .PP
307 M. Delete any section entitled "Endorsements". Such a section
308 may not be included in the Modified Version.
309 .PP
310 N. Do not retitle any existing section as "Endorsements"
311 or to conflict in title with any Invariant Section.
312 .PP
313 If the Modified Version includes new front-matter sections or
314 appendices that qualify as Secondary Sections and contain no material
315 copied from the Document, you may at your option designate some or all
316 of these sections as invariant. To do this, add their titles to the
317 list of Invariant Sections in the Modified Version's license notice.
318 These titles must be distinct from any other section titles.
319 .PP
320 You may add a section entitled "Endorsements", provided it contains
321 nothing but endorsements of your Modified Version by various
322 parties--for example, statements of peer review or that the text has
323 been approved by an organization as the authoritative definition of a
324 standard.
325 .PP
326 You may add a passage of up to five words as a Front-Cover Text, and a
327 passage of up to 25 words as a Back-Cover Text, to the end of the list
328 of Cover Texts in the Modified Version. Only one passage of
329 Front-Cover Text and one of Back-Cover Text may be added by (or
330 through arrangements made by) any one entity. If the Document already
331 includes a cover text for the same cover, previously added by you or
332 by arrangement made by the same entity you are acting on behalf of,
333 you may not add another; but you may replace the old one, on explicit
334 permission from the previous publisher that added the old one.
335 .PP
336 The author(s) and publisher(s) of the Document do not by this License
337 give permission to use their names for publicity for or to assert or
338 imply endorsement of any Modified Version.
339 .PP
340
341 5. COMBINING DOCUMENTS
342 .PP
343 You may combine the Document with other documents released under this
344 License, under the terms defined in section 4 above for modified
345 versions, provided that you include in the combination all of the
346 Invariant Sections of all of the original documents, unmodified, and
347 list them all as Invariant Sections of your combined work in its
348 license notice.
349 .PP
350 The combined work need only contain one copy of this License, and
351 multiple identical Invariant Sections may be replaced with a single
352 copy. If there are multiple Invariant Sections with the same name but
353 different contents, make the title of each such section unique by
354 adding at the end of it, in parentheses, the name of the original
355 author or publisher of that section if known, or else a unique number.
356 Make the same adjustment to the section titles in the list of
357 Invariant Sections in the license notice of the combined work.
358 .PP
359 In the combination, you must combine any sections entitled "History"
360 in the various original documents, forming one section entitled
361 "History"; likewise combine any sections entitled "Acknowledgements",
362 and any sections entitled "Dedications". You must delete all sections
363 entitled "Endorsements."
364 .PP
365
366 6. COLLECTIONS OF DOCUMENTS
367 .PP
368 You may make a collection consisting of the Document and other documents
369 released under this License, and replace the individual copies of this
370 License in the various documents with a single copy that is included in
371 the collection, provided that you follow the rules of this License for
372 verbatim copying of each of the documents in all other respects.
373 .PP
374 You may extract a single document from such a collection, and distribute
375 it individually under this License, provided you insert a copy of this
376 License into the extracted document, and follow this License in all
377 other respects regarding verbatim copying of that document.
378 .PP
379
380 7. AGGREGATION WITH INDEPENDENT WORKS
381 .PP
382 A compilation of the Document or its derivatives with other separate
383 and independent documents or works, in or on a volume of a storage or
384 distribution medium, does not as a whole count as a Modified Version
385 of the Document, provided no compilation copyright is claimed for the
386 compilation. Such a compilation is called an "aggregate", and this
387 License does not apply to the other self-contained works thus compiled
388 with the Document, on account of their being thus compiled, if they
389 are not themselves derivative works of the Document.
390 .PP
391 If the Cover Text requirement of section 3 is applicable to these
392 copies of the Document, then if the Document is less than one quarter
393 of the entire aggregate, the Document's Cover Texts may be placed on
394 covers that surround only the Document within the aggregate.
395 Otherwise they must appear on covers around the whole aggregate.
396 .PP
397
398 8. TRANSLATION
399 .PP
400 Translation is considered a kind of modification, so you may
401 distribute translations of the Document under the terms of section 4.
402 Replacing Invariant Sections with translations requires special
403 permission from their copyright holders, but you may include
404 translations of some or all Invariant Sections in addition to the
405 original versions of these Invariant Sections. You may include a
406 translation of this License provided that you also include the
407 original English version of this License. In case of a disagreement
408 between the translation and the original English version of this
409 License, the original English version will prevail.
410 .PP
411
412 9. TERMINATION
413 .PP
414 You may not copy, modify, sublicense, or distribute the Document except
415 as expressly provided for under this License. Any other attempt to
416 copy, modify, sublicense or distribute the Document is void, and will
417 automatically terminate your rights under this License. However,
418 parties who have received copies, or rights, from you under this
419 License will not have their licenses terminated so long as such
420 parties remain in full compliance.
421 .PP
422
423 10. FUTURE REVISIONS OF THIS LICENSE
424 .PP
425 The Free Software Foundation may publish new, revised versions
426 of the GNU Free Documentation License from time to time. Such new
427 versions will be similar in spirit to the present version, but may
428 differ in detail to address new problems or concerns. See
429 http://www.gnu.org/copyleft/.
430 .PP
431 Each version of the License is given a distinguishing version number.
432 If the Document specifies that a particular numbered version of this
433 License "or any later version" applies to it, you have the option of
434 following the terms and conditions either of that specified version or
435 of any later version that has been published (not as a draft) by the
436 Free Software Foundation. If the Document does not specify a version
437 number of this License, you may choose any version ever published (not
438 as a draft) by the Free Software Foundation.
439 .PP
440
441 ADDENDUM: How to use this License for your documents
442 .PP
443 To use this License in a document you have written, include a copy of
444 the License in the document and put the following copyright and
445 license notices just after the title page:
446 .PP
447 Copyright (c) YEAR YOUR NAME.
448 Permission is granted to copy, distribute and/or
449 modify this document under the terms of the GNU
450 Free Documentation License, Version 1.1 or any later
451 version published by the Free Software Foundation;
452 with the Invariant Sections being LIST THEIR TITLES,
453 with the Front-Cover Texts being LIST, and with the
454 Back-Cover Texts being LIST. A copy of the license
455 is included in the section entitled "GNU Free
456 Documentation License".
457 .PP
458 If you have no Invariant Sections, write "with no Invariant Sections"
459 instead of saying which ones are invariant. If you have no
460 Front-Cover Texts, write "no Front-Cover Texts" instead of
461 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
462 .PP
463 If your document contains nontrivial examples of program code, we
464 recommend releasing these examples in parallel under your choice of
465 free software license, such as the GNU General Public License,
466 to permit their use in free software.
This page took 0.038458 seconds and 4 git commands to generate.