Add GNU Free Documentation License
[deliverable/binutils-gdb.git] / gas / doc / as.1
1 .\" Copyright (c) 1991, 1992, 1996, 1997, 1998, 2000 Free Software Foundation
2 .\" See section COPYING for conditions for redistribution
3 .TH as 1 "29 March 1996" "Free Software Foundation" "GNU Development Tools"
4
5 .SH NAME
6 GNU as \- the portable GNU assembler.
7
8 .SH SYNOPSIS
9 .na
10 .B as
11 .RB "[\|" \-a "[\|" dhlns "\|]" \c
12 \&[\|\=\c
13 .I file\c
14 \&\|]\|]
15 .RB "[\|" \-D "\|]"
16 .RB "[\|" \-\-defsym\ SYM=VAL "\|]"
17 .RB "[\|" \-f "\|]"
18 .RB "[\|" \-\-gstabs "\|]"
19 .RB "[\|" \-I
20 .I path\c
21 \&\|]
22 .RB "[\|" \-K "\|]"
23 .RB "[\|" \-L "\|]"
24 .RB "[\|" \-M\ |\ \-\-mri "\|]"
25 .RB "[\|" \-o
26 .I objfile\c
27 \&\|]
28 .RB "[\|" \-R "\|]"
29 .RB "[\|" \-\-traditional\-format "\|]"
30 .RB "[\|" \-v "\|]"
31 .RB "[\|" \-w "\|]"
32 .RB "[\|" \-\^\- "\ |\ " \c
33 .I files\c
34 \&\|.\|.\|.\|]
35
36 .I i960-only options:
37 .br
38 .RB "[\|" \-ACA "\||\|" \-ACA_A "\||\|" \-ACB\c
39 .RB "\||\|" \-ACC "\||\|" \-AKA "\||\|" \-AKB\c
40 .RB "\||\|" \-AKC "\||\|" \-AMC "\|]"
41 .RB "[\|" \-b "\|]"
42 .RB "[\|" \-no-relax "\|]"
43
44 .I m680x0-only options:
45 .br
46 .RB "[\|" \-l "\|]"
47 .RB "[\|" \-mc68000 "\||\|" \-mc68010 "\||\|" \-mc68020 "\|]"
48 .ad b
49
50 .SH DESCRIPTION
51 GNU \c
52 .B as\c
53 \& is really a family of assemblers.
54 If you use (or have used) the GNU assembler on one architecture, you
55 should find a fairly similar environment when you use it on another
56 architecture. Each version has much in common with the others,
57 including object file formats, most assembler directives (often called
58 \c
59 .I pseudo-ops)\c
60 \& and assembler syntax.
61
62 For information on the syntax and pseudo-ops used by GNU \c
63 .B as\c
64 \&, see `\|\c
65 .B as\c
66 \|' entry in \c
67 .B info \c
68 (or the manual \c
69 .I
70 .I
71 Using as: The GNU Assembler\c
72 \&).
73
74 \c
75 .B as\c
76 \& is primarily intended to assemble the output of the GNU C
77 compiler \c
78 .B gcc\c
79 \& for use by the linker \c
80 .B ld\c
81 \&. Nevertheless,
82 we've tried to make \c
83 .B as\c
84 \& assemble correctly everything that the native
85 assembler would.
86 This doesn't mean \c
87 .B as\c
88 \& always uses the same syntax as another
89 assembler for the same architecture; for example, we know of several
90 incompatible versions of 680x0 assembly language syntax.
91
92 Each time you run \c
93 .B as\c
94 \& it assembles exactly one source
95 program. The source program is made up of one or more files.
96 (The standard input is also a file.)
97
98 If \c
99 .B as\c
100 \& is given no file names it attempts to read one input file
101 from the \c
102 .B as\c
103 \& standard input, which is normally your terminal. You
104 may have to type \c
105 .B ctl-D\c
106 \& to tell \c
107 .B as\c
108 \& there is no more program
109 to assemble. Use `\|\c
110 .B \-\^\-\c
111 \|' if you need to explicitly name the standard input file
112 in your command line.
113
114 .B as\c
115 \& may write warnings and error messages to the standard error
116 file (usually your terminal). This should not happen when \c
117 .B as\c
118 \& is
119 run automatically by a compiler. Warnings report an assumption made so
120 that \c
121 .B as\c
122 \& could keep assembling a flawed program; errors report a
123 grave problem that stops the assembly.
124
125 .SH OPTIONS
126 .TP
127 .BR \-a
128 Turn on assembly listings. There are various suboptions.
129 .B d
130 omits debugging directives.
131 .B h
132 includes the high level source code; this is only available if the
133 source file can be found, and the code was compiled with
134 .B \-g.
135 .B l
136 includes an assembly listing.
137 .B n
138 omits forms processing.
139 .B s
140 includes a symbol listing.
141 .B =
142 .I file
143 sets the listing file name; this must be the last suboption.
144 The default suboptions are
145 .B hls.
146 .TP
147 .B \-D
148 This option is accepted only for script compatibility with calls to
149 other assemblers; it has no effect on \c
150 .B as\c
151 \&.
152 .TP
153 .B \-\-defsym SYM=VALUE
154 Define the symbol SYM to be VALUE before assembling the input file.
155 VALUE must be an integer constant. As in C, a leading 0x indicates a
156 hexadecimal value, and a leading 0 indicates an octal value.
157 .TP
158 .B \-f
159 ``fast''--skip preprocessing (assume source is compiler output).
160 .TP
161 .BI "\-I\ " path
162 Add
163 .I path
164 to the search list for
165 .B .include
166 directives.
167 .TP
168 .B \-\-gstabs
169 Generate stabs debugging information for each assembler line. This
170 may help debugging assembler code, if the debugger can handle it.
171 .TP
172 .B \-K
173 Issue warnings when difference tables altered for long displacements.
174 .TP
175 .B \-L
176 Keep (in symbol table) local symbols, starting with `\|\c
177 .B L\c
178 \|'
179 .TP
180 .B \-M, \-\-mri
181 Assemble in MRI compatibility mode.
182 .TP
183 .BI "\-o\ " objfile
184 Name the object-file output from \c
185 .B as
186 .TP
187 .B \-R
188 Fold data section into text section
189 .TP
190 .B \-\-traditional\-format
191 Use same format as native assembler, when possible.
192 .TP
193 .B \-v
194 Announce \c
195 .B as\c
196 \& version
197 .TP
198 .B \-W, \-\-no-warn
199 Suppress warning messages.
200 .TP
201 .B \-\-fatal\-warnings
202 Consider warnings to be fatal.
203 .TP
204 .B \-\-warn
205 Just warn on warnings.
206 .TP
207 .IR "\-\^\-" "\ |\ " "files\|.\|.\|."
208 Source files to assemble, or standard input (\c
209 .BR "\-\^\-" ")"
210 .TP
211 .BI \-A var
212 .I
213 (When configured for Intel 960.)
214 Specify which variant of the 960 architecture is the target.
215 .TP
216 .B \-b
217 .I
218 (When configured for Intel 960.)
219 Add code to collect statistics about branches taken.
220 .TP
221 .B \-no-relax
222 .I
223 (When configured for Intel 960.)
224 Do not alter compare-and-branch instructions for long displacements;
225 error if necessary.
226 .TP
227 .B \-l
228 .I
229 (When configured for Motorola 68000).
230 .br
231 Shorten references to undefined symbols, to one word instead of two.
232 .TP
233 .BR "\-mc68000" "\||\|" "\-mc68010" "\||\|" "\-mc68020"
234 .I
235 (When configured for Motorola 68000).
236 .br
237 Specify what processor in the 68000 family is the target (default 68020)
238
239 .PP
240 Options may be in any order, and may be
241 before, after, or between file names. The order of file names is
242 significant.
243
244 `\|\c
245 .B \-\^\-\c
246 \|' (two hyphens) by itself names the standard input file
247 explicitly, as one of the files for \c
248 .B as\c
249 \& to assemble.
250
251 Except for `\|\c
252 .B \-\^\-\c
253 \|' any command line argument that begins with a
254 hyphen (`\|\c
255 .B \-\c
256 \|') is an option. Each option changes the behavior of
257 \c
258 .B as\c
259 \&. No option changes the way another option works. An
260 option is a `\|\c
261 .B \-\c
262 \|' followed by one or more letters; the case of
263 the letter is important. All options are optional.
264
265 The `\|\c
266 .B \-o\c
267 \|' option expects exactly one file name to follow. The file
268 name may either immediately follow the option's letter (compatible
269 with older assemblers) or it may be the next command argument (GNU
270 standard).
271
272 These two command lines are equivalent:
273 .br
274 .B
275 as\ \ \-o\ \ my\-object\-file.o\ \ mumble.s
276 .br
277 .B
278 as\ \ \-omy\-object\-file.o\ \ mumble.s
279
280 .SH "SEE ALSO"
281 .RB "`\|" as "\|'"
282 entry in
283 .B
284 info\c
285 \&;
286 .I
287 Using as: The GNU Assembler\c
288 \&;
289 .BR gcc "(" 1 "),"
290 .BR ld "(" 1 ")."
291
292 .SH COPYING
293 Copyright (c) 1991, 1992, 2000 Free Software Foundation, Inc.
294 .PP
295 This document is distributed under the terms of the GNU Free
296 Documenation License. That license is described in the GNU Free
297 Documentation License section.
298
299 .SH GNU Free Documentation License
300 Version 1.1, March 2000
301
302 Copyright (C) 2000 Free Software Foundation, Inc.
303 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
304
305 Everyone is permitted to copy and distribute verbatim
306 copies of this license document, but changing it is
307 not allowed.
308 .PP
309 0. PREAMBLE
310 .PP
311 The purpose of this License is to make a manual, textbook, or other
312 written document "free" in the sense of freedom: to assure everyone
313 the effective freedom to copy and redistribute it, with or without
314 modifying it, either commercially or noncommercially. Secondarily,
315 this License preserves for the author and publisher a way to get
316 credit for their work, while not being considered responsible for
317 modifications made by others.
318 .PP
319 This License is a kind of "copyleft", which means that derivative
320 works of the document must themselves be free in the same sense. It
321 complements the GNU General Public License, which is a copyleft
322 license designed for free software.
323 .PP
324 We have designed this License in order to use it for manuals for free
325 software, because free software needs free documentation: a free
326 program should come with manuals providing the same freedoms that the
327 software does. But this License is not limited to software manuals;
328 it can be used for any textual work, regardless of subject matter or
329 whether it is published as a printed book. We recommend this License
330 principally for works whose purpose is instruction or reference.
331 .PP
332 1. APPLICABILITY AND DEFINITIONS
333 .PP
334 This License applies to any manual or other work that contains a
335 notice placed by the copyright holder saying it can be distributed
336 under the terms of this License. The "Document", below, refers to any
337 such manual or work. Any member of the public is a licensee, and is
338 addressed as "you".
339 .PP
340 A "Modified Version" of the Document means any work containing the
341 Document or a portion of it, either copied verbatim, or with
342 modifications and/or translated into another language.
343 .PP
344 A "Secondary Section" is a named appendix or a front-matter section of
345 the Document that deals exclusively with the relationship of the
346 publishers or authors of the Document to the Document's overall subject
347 (or to related matters) and contains nothing that could fall directly
348 within that overall subject. (For example, if the Document is in part a
349 textbook of mathematics, a Secondary Section may not explain any
350 mathematics.) The relationship could be a matter of historical
351 connection with the subject or with related matters, or of legal,
352 commercial, philosophical, ethical or political position regarding
353 them.
354 .PP
355 The "Invariant Sections" are certain Secondary Sections whose titles
356 are designated, as being those of Invariant Sections, in the notice
357 that says that the Document is released under this License.
358 .PP
359 The "Cover Texts" are certain short passages of text that are listed,
360 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
361 the Document is released under this License.
362 .PP
363 A "Transparent" copy of the Document means a machine-readable copy,
364 represented in a format whose specification is available to the
365 general public, whose contents can be viewed and edited directly and
366 straightforwardly with generic text editors or (for images composed of
367 pixels) generic paint programs or (for drawings) some widely available
368 drawing editor, and that is suitable for input to text formatters or
369 for automatic translation to a variety of formats suitable for input
370 to text formatters. A copy made in an otherwise Transparent file
371 format whose markup has been designed to thwart or discourage
372 subsequent modification by readers is not Transparent. A copy that is
373 not "Transparent" is called "Opaque".
374 .PP
375 Examples of suitable formats for Transparent copies include plain
376 ASCII without markup, Texinfo input format, LaTeX input format, SGML
377 or XML using a publicly available DTD, and standard-conforming simple
378 HTML designed for human modification. Opaque formats include
379 PostScript, PDF, proprietary formats that can be read and edited only
380 by proprietary word processors, SGML or XML for which the DTD and/or
381 processing tools are not generally available, and the
382 machine-generated HTML produced by some word processors for output
383 purposes only.
384 .PP
385 The "Title Page" means, for a printed book, the title page itself,
386 plus such following pages as are needed to hold, legibly, the material
387 this License requires to appear in the title page. For works in
388 formats which do not have any title page as such, "Title Page" means
389 the text near the most prominent appearance of the work's title,
390 preceding the beginning of the body of the text.
391 .PP
392 2. VERBATIM COPYING
393 .PP
394 You may copy and distribute the Document in any medium, either
395 commercially or noncommercially, provided that this License, the
396 copyright notices, and the license notice saying this License applies
397 to the Document are reproduced in all copies, and that you add no other
398 conditions whatsoever to those of this License. You may not use
399 technical measures to obstruct or control the reading or further
400 copying of the copies you make or distribute. However, you may accept
401 compensation in exchange for copies. If you distribute a large enough
402 number of copies you must also follow the conditions in section 3.
403 .PP
404 You may also lend copies, under the same conditions stated above, and
405 you may publicly display copies.
406 .PP
407 3. COPYING IN QUANTITY
408 .PP
409 If you publish printed copies of the Document numbering more than 100,
410 and the Document's license notice requires Cover Texts, you must enclose
411 the copies in covers that carry, clearly and legibly, all these Cover
412 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
413 the back cover. Both covers must also clearly and legibly identify
414 you as the publisher of these copies. The front cover must present
415 the full title with all words of the title equally prominent and
416 visible. You may add other material on the covers in addition.
417 Copying with changes limited to the covers, as long as they preserve
418 the title of the Document and satisfy these conditions, can be treated
419 as verbatim copying in other respects.
420 .PP
421 If the required texts for either cover are too voluminous to fit
422 legibly, you should put the first ones listed (as many as fit
423 reasonably) on the actual cover, and continue the rest onto adjacent
424 pages.
425 .PP
426 If you publish or distribute Opaque copies of the Document numbering
427 more than 100, you must either include a machine-readable Transparent
428 copy along with each Opaque copy, or state in or with each Opaque copy
429 a publicly-accessible computer-network location containing a complete
430 Transparent copy of the Document, free of added material, which the
431 general network-using public has access to download anonymously at no
432 charge using public-standard network protocols. If you use the latter
433 option, you must take reasonably prudent steps, when you begin
434 distribution of Opaque copies in quantity, to ensure that this
435 Transparent copy will remain thus accessible at the stated location
436 until at least one year after the last time you distribute an Opaque
437 copy (directly or through your agents or retailers) of that edition to
438 the public.
439 .PP
440 It is requested, but not required, that you contact the authors of the
441 Document well before redistributing any large number of copies, to give
442 them a chance to provide you with an updated version of the Document.
443 .PP
444 4. MODIFICATIONS
445 .PP
446 You may copy and distribute a Modified Version of the Document under
447 the conditions of sections 2 and 3 above, provided that you release
448 the Modified Version under precisely this License, with the Modified
449 Version filling the role of the Document, thus licensing distribution
450 and modification of the Modified Version to whoever possesses a copy
451 of it. In addition, you must do these things in the Modified Version:
452 .PP
453 A. Use in the Title Page (and on the covers, if any) a title distinct
454 from that of the Document, and from those of previous versions
455 (which should, if there were any, be listed in the History section
456 of the Document). You may use the same title as a previous version
457 if the original publisher of that version gives permission.
458 .PP
459 B. List on the Title Page, as authors, one or more persons or entities
460 responsible for authorship of the modifications in the Modified
461 Version, together with at least five of the principal authors of the
462 Document (all of its principal authors, if it has less than five).
463 .PP
464 C. State on the Title page the name of the publisher of the
465 Modified Version, as the publisher.
466 .PP
467 D. Preserve all the copyright notices of the Document.
468 .PP
469 E. Add an appropriate copyright notice for your modifications
470 adjacent to the other copyright notices.
471 .PP
472 F. Include, immediately after the copyright notices, a license notice
473 giving the public permission to use the Modified Version under the
474 terms of this License, in the form shown in the Addendum below.
475 Preserve in that license notice the full lists of Invariant Sections
476 and required Cover Texts given in the Document's license notice.
477 .PP
478 H. Include an unaltered copy of this License.
479 .PP
480 I. Preserve the section entitled "History", and its title, and add to
481 it an item stating at least the title, year, new authors, and
482 publisher of the Modified Version as given on the Title Page. If
483 there is no section entitled "History" in the Document, create one
484 stating the title, year, authors, and publisher of the Document as
485 given on its Title Page, then add an item describing the Modified
486 Version as stated in the previous sentence.
487 .PP
488 J. Preserve the network location, if any, given in the Document for
489 public access to a Transparent copy of the Document, and likewise
490 the network locations given in the Document for previous versions
491 it was based on. These may be placed in the "History" section.
492 You may omit a network location for a work that was published at
493 least four years before the Document itself, or if the original
494 publisher of the version it refers to gives permission.
495 .PP
496 K. In any section entitled "Acknowledgements" or "Dedications",
497 preserve the section's title, and preserve in the section all the
498 substance and tone of each of the contributor acknowledgements
499 and/or dedications given therein.
500 .PP
501 L. Preserve all the Invariant Sections of the Document,
502 unaltered in their text and in their titles. Section numbers
503 or the equivalent are not considered part of the section titles.
504 .PP
505 M. Delete any section entitled "Endorsements". Such a section
506 may not be included in the Modified Version.
507 .PP
508 N. Do not retitle any existing section as "Endorsements"
509 or to conflict in title with any Invariant Section.
510 .PP
511 If the Modified Version includes new front-matter sections or
512 appendices that qualify as Secondary Sections and contain no material
513 copied from the Document, you may at your option designate some or all
514 of these sections as invariant. To do this, add their titles to the
515 list of Invariant Sections in the Modified Version's license notice.
516 These titles must be distinct from any other section titles.
517 .PP
518 You may add a section entitled "Endorsements", provided it contains
519 nothing but endorsements of your Modified Version by various
520 parties--for example, statements of peer review or that the text has
521 been approved by an organization as the authoritative definition of a
522 standard.
523 .PP
524 You may add a passage of up to five words as a Front-Cover Text, and a
525 passage of up to 25 words as a Back-Cover Text, to the end of the list
526 of Cover Texts in the Modified Version. Only one passage of
527 Front-Cover Text and one of Back-Cover Text may be added by (or
528 through arrangements made by) any one entity. If the Document already
529 includes a cover text for the same cover, previously added by you or
530 by arrangement made by the same entity you are acting on behalf of,
531 you may not add another; but you may replace the old one, on explicit
532 permission from the previous publisher that added the old one.
533 .PP
534 The author(s) and publisher(s) of the Document do not by this License
535 give permission to use their names for publicity for or to assert or
536 imply endorsement of any Modified Version.
537 .PP
538
539 5. COMBINING DOCUMENTS
540 .PP
541 You may combine the Document with other documents released under this
542 License, under the terms defined in section 4 above for modified
543 versions, provided that you include in the combination all of the
544 Invariant Sections of all of the original documents, unmodified, and
545 list them all as Invariant Sections of your combined work in its
546 license notice.
547 .PP
548 The combined work need only contain one copy of this License, and
549 multiple identical Invariant Sections may be replaced with a single
550 copy. If there are multiple Invariant Sections with the same name but
551 different contents, make the title of each such section unique by
552 adding at the end of it, in parentheses, the name of the original
553 author or publisher of that section if known, or else a unique number.
554 Make the same adjustment to the section titles in the list of
555 Invariant Sections in the license notice of the combined work.
556 .PP
557 In the combination, you must combine any sections entitled "History"
558 in the various original documents, forming one section entitled
559 "History"; likewise combine any sections entitled "Acknowledgements",
560 and any sections entitled "Dedications". You must delete all sections
561 entitled "Endorsements."
562 .PP
563
564 6. COLLECTIONS OF DOCUMENTS
565 .PP
566 You may make a collection consisting of the Document and other documents
567 released under this License, and replace the individual copies of this
568 License in the various documents with a single copy that is included in
569 the collection, provided that you follow the rules of this License for
570 verbatim copying of each of the documents in all other respects.
571 .PP
572 You may extract a single document from such a collection, and distribute
573 it individually under this License, provided you insert a copy of this
574 License into the extracted document, and follow this License in all
575 other respects regarding verbatim copying of that document.
576 .PP
577
578 7. AGGREGATION WITH INDEPENDENT WORKS
579 .PP
580 A compilation of the Document or its derivatives with other separate
581 and independent documents or works, in or on a volume of a storage or
582 distribution medium, does not as a whole count as a Modified Version
583 of the Document, provided no compilation copyright is claimed for the
584 compilation. Such a compilation is called an "aggregate", and this
585 License does not apply to the other self-contained works thus compiled
586 with the Document, on account of their being thus compiled, if they
587 are not themselves derivative works of the Document.
588 .PP
589 If the Cover Text requirement of section 3 is applicable to these
590 copies of the Document, then if the Document is less than one quarter
591 of the entire aggregate, the Document's Cover Texts may be placed on
592 covers that surround only the Document within the aggregate.
593 Otherwise they must appear on covers around the whole aggregate.
594 .PP
595
596 8. TRANSLATION
597 .PP
598 Translation is considered a kind of modification, so you may
599 distribute translations of the Document under the terms of section 4.
600 Replacing Invariant Sections with translations requires special
601 permission from their copyright holders, but you may include
602 translations of some or all Invariant Sections in addition to the
603 original versions of these Invariant Sections. You may include a
604 translation of this License provided that you also include the
605 original English version of this License. In case of a disagreement
606 between the translation and the original English version of this
607 License, the original English version will prevail.
608 .PP
609
610 9. TERMINATION
611 .PP
612 You may not copy, modify, sublicense, or distribute the Document except
613 as expressly provided for under this License. Any other attempt to
614 copy, modify, sublicense or distribute the Document is void, and will
615 automatically terminate your rights under this License. However,
616 parties who have received copies, or rights, from you under this
617 License will not have their licenses terminated so long as such
618 parties remain in full compliance.
619 .PP
620
621 10. FUTURE REVISIONS OF THIS LICENSE
622 .PP
623 The Free Software Foundation may publish new, revised versions
624 of the GNU Free Documentation License from time to time. Such new
625 versions will be similar in spirit to the present version, but may
626 differ in detail to address new problems or concerns. See
627 http://www.gnu.org/copyleft/.
628 .PP
629 Each version of the License is given a distinguishing version number.
630 If the Document specifies that a particular numbered version of this
631 License "or any later version" applies to it, you have the option of
632 following the terms and conditions either of that specified version or
633 of any later version that has been published (not as a draft) by the
634 Free Software Foundation. If the Document does not specify a version
635 number of this License, you may choose any version ever published (not
636 as a draft) by the Free Software Foundation.
637 .PP
638
639 ADDENDUM: How to use this License for your documents
640 .PP
641 To use this License in a document you have written, include a copy of
642 the License in the document and put the following copyright and
643 license notices just after the title page:
644 .PP
645 Copyright (c) YEAR YOUR NAME.
646 Permission is granted to copy, distribute and/or
647 modify this document under the terms of the GNU
648 Free Documentation License, Version 1.1 or any later
649 version published by the Free Software Foundation;
650 with the Invariant Sections being LIST THEIR TITLES,
651 with the Front-Cover Texts being LIST, and with the
652 Back-Cover Texts being LIST. A copy of the license
653 is included in the section entitled "GNU Free
654 Documentation License".
655 .PP
656 If you have no Invariant Sections, write "with no Invariant Sections"
657 instead of saying which ones are invariant. If you have no
658 Front-Cover Texts, write "no Front-Cover Texts" instead of
659 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
660 .PP
661 If your document contains nontrivial examples of program code, we
662 recommend releasing these examples in parallel under your choice of
663 free software license, such as the GNU General Public License,
664 to permit their use in free software.
This page took 0.043824 seconds and 5 git commands to generate.