2001-01-06 Jan Hubicka <jh@suse.cz>, Andreas Jaeger <aj@suse.de>
[external/binutils.git] / gas / doc / as.texinfo
1 \input texinfo @c                               -*-Texinfo-*-
2 @c  Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 2000
3 @c  Free Software Foundation, Inc.
4 @c UPDATE!!  On future updates--
5 @c   (1)   check for new machine-dep cmdline options in
6 @c         md_parse_option definitions in config/tc-*.c
7 @c   (2)   for platform-specific directives, examine md_pseudo_op
8 @c         in config/tc-*.c
9 @c   (3)   for object-format specific directives, examine obj_pseudo_op
10 @c         in config/obj-*.c       
11 @c   (4)   portable directives in potable[] in read.c
12 @c %**start of header
13 @setfilename as.info
14 @c ---config---
15 @c defaults, config file may override:
16 @set have-stabs
17 @c ---
18 @include asconfig.texi
19 @include gasver.texi
20 @c ---
21 @c common OR combinations of conditions
22 @ifset AOUT
23 @set aout-bout
24 @end ifset
25 @ifset ARM/Thumb
26 @set ARM
27 @end ifset
28 @ifset BOUT
29 @set aout-bout
30 @end ifset
31 @ifset H8/300
32 @set H8
33 @end ifset
34 @ifset H8/500
35 @set H8
36 @end ifset
37 @ifset SH
38 @set H8
39 @end ifset
40 @ifset HPPA
41 @set abnormal-separator
42 @end ifset
43 @c ------------
44 @ifset GENERIC
45 @settitle Using @value{AS}
46 @end ifset
47 @ifclear GENERIC
48 @settitle Using @value{AS} (@value{TARGET})
49 @end ifclear
50 @setchapternewpage odd
51 @c %**end of header
52
53 @c @smallbook
54 @c @set SMALL
55 @c WARE! Some of the machine-dependent sections contain tables of machine
56 @c instructions.  Except in multi-column format, these tables look silly.
57 @c Unfortunately, Texinfo doesn't have a general-purpose multi-col format, so
58 @c the multi-col format is faked within @example sections.
59 @c 
60 @c Again unfortunately, the natural size that fits on a page, for these tables,
61 @c is different depending on whether or not smallbook is turned on.
62 @c This matters, because of order: text flow switches columns at each page
63 @c break.
64 @c 
65 @c The format faked in this source works reasonably well for smallbook,
66 @c not well for the default large-page format.  This manual expects that if you
67 @c turn on @smallbook, you will also uncomment the "@set SMALL" to enable the
68 @c tables in question.  You can turn on one without the other at your
69 @c discretion, of course. 
70 @ifinfo
71 @set SMALL
72 @c the insn tables look just as silly in info files regardless of smallbook,
73 @c might as well show 'em anyways.
74 @end ifinfo
75
76 @ifinfo
77 @format
78 START-INFO-DIR-ENTRY
79 * As: (as).                     The GNU assembler.
80 END-INFO-DIR-ENTRY
81 @end format
82 @end ifinfo
83
84 @finalout
85 @syncodeindex ky cp
86
87 @ifinfo
88 This file documents the GNU Assembler "@value{AS}".
89
90 Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000 Free Software Foundation, Inc.
91
92       Permission is granted to copy, distribute and/or modify this document
93       under the terms of the GNU Free Documentation License, Version 1.1
94       or any later version published by the Free Software Foundation;
95       with no Invariant Sections, with no Front-Cover Texts, and with no
96       Back-Cover Texts.  A copy of the license is included in the
97       section entitled "GNU Free Documentation License".
98
99 @ignore
100 Permission is granted to process this file through Tex and print the
101 results, provided the printed document carries copying permission
102 notice identical to this one except for the removal of this paragraph
103 (this paragraph not being relevant to the printed manual).
104
105 @end ignore
106 @end ifinfo
107
108 @titlepage
109 @title Using @value{AS}
110 @subtitle The @sc{gnu} Assembler
111 @ifclear GENERIC
112 @subtitle for the @value{TARGET} family
113 @end ifclear
114 @sp 1
115 @subtitle Version @value{VERSION}
116 @sp 1
117 @sp 13
118 The Free Software Foundation Inc.  thanks The Nice Computer
119 Company of Australia for loaning Dean Elsner to write the
120 first (Vax) version of @code{as} for Project @sc{gnu}.
121 The proprietors, management and staff of TNCCA thank FSF for
122 distracting the boss while they got some work
123 done.
124 @sp 3
125 @author Dean Elsner, Jay Fenlason & friends
126 @page
127 @tex
128 {\parskip=0pt
129 \hfill {\it Using {\tt @value{AS}}}\par
130 \hfill Edited by Cygnus Support\par
131 }
132 %"boxit" macro for figures:
133 %Modified from Knuth's ``boxit'' macro from TeXbook (answer to exercise 21.3)
134 \gdef\boxit#1#2{\vbox{\hrule\hbox{\vrule\kern3pt
135      \vbox{\parindent=0pt\parskip=0pt\hsize=#1\kern3pt\strut\hfil
136 #2\hfil\strut\kern3pt}\kern3pt\vrule}\hrule}}%box with visible outline
137 \gdef\ibox#1#2{\hbox to #1{#2\hfil}\kern8pt}% invisible box
138 @end tex
139
140 @vskip 0pt plus 1filll
141 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000 Free Software Foundation, Inc.
142
143       Permission is granted to copy, distribute and/or modify this document
144       under the terms of the GNU Free Documentation License, Version 1.1
145       or any later version published by the Free Software Foundation;
146       with no Invariant Sections, with no Front-Cover Texts, and with no
147       Back-Cover Texts.  A copy of the license is included in the
148       section entitled "GNU Free Documentation License".
149
150 @end titlepage
151
152 @ifinfo
153 @node Top
154 @top Using @value{AS}
155
156 This file is a user guide to the @sc{gnu} assembler @code{@value{AS}} version
157 @value{VERSION}.
158 @ifclear GENERIC
159 This version of the file describes @code{@value{AS}} configured to generate
160 code for @value{TARGET} architectures.
161 @end ifclear
162
163 This document is distributed under the terms of the GNU Free
164 Documentation License.  A copy of the license is included in the
165 section entitled "GNU Free Documentation License".
166
167 @menu
168 * Overview::                    Overview
169 * Invoking::                    Command-Line Options
170 * Syntax::                      Syntax
171 * Sections::                    Sections and Relocation
172 * Symbols::                     Symbols
173 * Expressions::                 Expressions
174 * Pseudo Ops::                  Assembler Directives
175 * Machine Dependencies::        Machine Dependent Features
176 * Reporting Bugs::              Reporting Bugs
177 * Acknowledgements::            Who Did What
178 * GNU Free Documentation License::  GNU Free Documentation License
179 * Index::                       Index
180 @end menu
181 @end ifinfo
182
183 @node Overview
184 @chapter Overview
185 @iftex
186 This manual is a user guide to the @sc{gnu} assembler @code{@value{AS}}.
187 @ifclear GENERIC
188 This version of the manual describes @code{@value{AS}} configured to generate
189 code for @value{TARGET} architectures.
190 @end ifclear
191 @end iftex
192
193 @cindex invocation summary
194 @cindex option summary
195 @cindex summary of options
196 Here is a brief summary of how to invoke @code{@value{AS}}.  For details,
197 @pxref{Invoking,,Comand-Line Options}.
198
199 @c We don't use deffn and friends for the following because they seem
200 @c to be limited to one line for the header.
201 @smallexample
202 @value{AS} [ -a[cdhlns][=file] ] [ -D ]  [ --defsym @var{sym}=@var{val} ]
203  [ -f ] [ --gstabs ] [ --gdwarf2 ] [ --help ] [ -I @var{dir} ] [ -J ] [ -K ] [ -L ]
204  [ --keep-locals ] [ -o @var{objfile} ] [ -R ] [ --statistics ] [ -v ]
205  [ -version ] [ --version ] [ -W ] [ --warn ] [ --fatal-warnings ] 
206  [ -w ] [ -x ] [ -Z ] [ --target-help ]
207 @ifset A29K
208 @c am29k has no machine-dependent assembler options
209 @end ifset
210 @ifset ARC
211  [ -mbig-endian | -mlittle-endian ]
212 @end ifset
213 @ifset ARM
214  [ -m[arm]1 | -m[arm]2 | -m[arm]250 | -m[arm]3 | -m[arm]6 | -m[arm]60 |
215    -m[arm]600 | -m[arm]610 | -m[arm]620 | -m[arm]7[t][[d]m[i]][fe] | -m[arm]70 |
216    -m[arm]700 | -m[arm]710[c] | -m[arm]7100 | -m[arm]7500 | -m[arm]8 |
217    -m[arm]810 | -m[arm]9 | -m[arm]920 | -m[arm]920t | -m[arm]9tdmi |
218    -mstrongarm | -mstrongarm110 | -mstrongarm1100 ]
219  [ -m[arm]v2 | -m[arm]v2a | -m[arm]v3 | -m[arm]v3m | -m[arm]v4 | -m[arm]v4t |
220    -m[arm]v5 | -[arm]v5t ]
221  [ -mthumb | -mall ]
222  [ -mfpa10 | -mfpa11 | -mfpe-old | -mno-fpu ]
223  [ -EB | -EL ]
224  [ -mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant ]
225  [ -mthumb-interwork ]
226  [ -moabi ]
227  [ -k ]
228 @end ifset
229 @ifset D10V
230  [ -O ]
231 @end ifset
232 @ifset D30V
233  [ -O | -n | -N ]
234 @end ifset
235 @ifset H8
236 @c Hitachi family chips have no machine-dependent assembler options
237 @end ifset
238 @ifset HPPA
239 @c HPPA has no machine-dependent assembler options (yet).
240 @end ifset
241 @ifset PJ
242  [ -mb | -me ]
243 @end ifset
244 @ifset SPARC
245 @c The order here is important.  See c-sparc.texi.
246  [ -Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite
247    -Av8plus | -Av8plusa | -Av9 | -Av9a ]
248  [ -xarch=v8plus | -xarch=v8plusa ] [ -bump ] [ -32 | -64 ]
249 @end ifset
250 @ifset TIC54X
251  [ -mcpu=54[123589] | -mcpu=54[56]lp ] [ -mfar-mode | -mf ] 
252  [ -merrors-to-file <filename> | -me <filename> ]
253 @end ifset
254 @ifset Z8000
255 @c Z8000 has no machine-dependent assembler options
256 @end ifset
257 @ifset I960
258 @c see md_parse_option in tc-i960.c
259  [ -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC ]
260  [ -b ] [ -no-relax ]
261 @end ifset
262 @ifset M32R
263  [ --m32rx | --[no-]warn-explicit-parallel-conflicts | --W[n]p ]
264 @end ifset
265 @ifset M680X0
266  [ -l ] [ -m68000 | -m68010 | -m68020 | ... ]
267 @end ifset
268 @ifset MCORE
269  [ -jsri2bsr ] [ -sifilter ] [ -relax ]
270  [ -mcpu=[210|340] ]
271 @end ifset
272 @ifset M68HC11
273  [ -m68hc11 | -m68hc12 ]
274  [ --force-long-branchs ] [ --short-branchs ] [ --strict-direct-mode ]
275  [ --print-insn-syntax ] [ --print-opcodes ] [ --generate-example ]
276 @end ifset
277 @ifset MIPS
278  [ -nocpp ] [ -EL ] [ -EB ] [ -G @var{num} ] [ -mcpu=@var{CPU} ]
279  [ -mips1 ] [ -mips2 ] [ -mips3 ] [ -mips4 ] [ -mips5 ]
280  [ -mips32 ] [ -mips64 ]
281  [ -m4650 ] [ -no-m4650 ]
282  [ --trap ] [ --break ]
283  [ --emulation=@var{name} ]
284 @end ifset
285  [ -- | @var{files} @dots{} ]
286 @end smallexample
287
288 @table @code
289 @item -a[cdhlmns]
290 Turn on listings, in any of a variety of ways:
291
292 @table @code
293 @item -ac
294 omit false conditionals
295
296 @item -ad
297 omit debugging directives
298
299 @item -ah
300 include high-level source
301
302 @item -al
303 include assembly
304
305 @item -am
306 include macro expansions
307
308 @item -an
309 omit forms processing
310
311 @item -as
312 include symbols
313
314 @item =file
315 set the name of the listing file
316 @end table
317
318 You may combine these options; for example, use @samp{-aln} for assembly
319 listing without forms processing.  The @samp{=file} option, if used, must be
320 the last one.  By itself, @samp{-a} defaults to @samp{-ahls}.
321
322 @item -D
323 Ignored.  This option is accepted for script compatibility with calls to
324 other assemblers.
325
326 @item --defsym @var{sym}=@var{value}
327 Define the symbol @var{sym} to be @var{value} before assembling the input file.
328 @var{value} must be an integer constant.  As in C, a leading @samp{0x}
329 indicates a hexadecimal value, and a leading @samp{0} indicates an octal value.
330
331 @item -f
332 ``fast''---skip whitespace and comment preprocessing (assume source is
333 compiler output).
334
335 @item --gstabs
336 Generate stabs debugging information for each assembler line.  This
337 may help debugging assembler code, if the debugger can handle it.
338
339 @item --gdwarf2
340 Generate DWARF2 debugging information for each assembler line.  This
341 may help debugging assembler code, if the debugger can handle it.  Note - this
342 option is only supported by some targets, not all of them.
343
344 @item --help
345 Print a summary of the command line options and exit.
346
347 @item --target-help
348 Print a summary of all target specific options and exit.
349
350 @item -I @var{dir}
351 Add directory @var{dir} to the search list for @code{.include} directives.
352
353 @item -J
354 Don't warn about signed overflow.
355
356 @item -K
357 @ifclear DIFF-TBL-KLUGE
358 This option is accepted but has no effect on the @value{TARGET} family.
359 @end ifclear
360 @ifset DIFF-TBL-KLUGE
361 Issue warnings when difference tables altered for long displacements.
362 @end ifset
363
364 @item -L
365 @itemx --keep-locals
366 Keep (in the symbol table) local symbols.  On traditional a.out systems
367 these start with @samp{L}, but different systems have different local
368 label prefixes.
369
370 @item -o @var{objfile}
371 Name the object-file output from @code{@value{AS}} @var{objfile}.
372
373 @item -R
374 Fold the data section into the text section.
375
376 @item --statistics
377 Print the maximum space (in bytes) and total time (in seconds) used by
378 assembly.
379
380 @item --strip-local-absolute
381 Remove local absolute symbols from the outgoing symbol table.
382
383 @item -v
384 @itemx -version
385 Print the @code{as} version.
386
387 @item --version
388 Print the @code{as} version and exit.
389
390 @item -W
391 @itemx --no-warn
392 Suppress warning messages.
393
394 @item --fatal-warnings
395 Treat warnings as errors.
396
397 @item --warn
398 Don't suppress warning messages or treat them as errors.
399
400 @item -w
401 Ignored.
402
403 @item -x
404 Ignored.
405
406 @item -Z
407 Generate an object file even after errors.
408
409 @item -- | @var{files} @dots{}
410 Standard input, or source files to assemble.
411
412 @end table
413
414 @ifset ARC
415 The following options are available when @value{AS} is configured for
416 an ARC processor.
417
418 @table @code
419
420 @cindex ARC endianness
421 @cindex endianness, ARC
422 @cindex big endian output, ARC
423 @item -mbig-endian
424 Generate ``big endian'' format output.
425
426 @cindex little endian output, ARC
427 @item -mlittle-endian
428 Generate ``little endian'' format output.
429
430 @end table
431 @end ifset
432
433 @ifset ARM
434 The following options are available when @value{AS} is configured for the ARM
435 processor family.
436
437 @table @code
438 @item -m[arm][1|2|3|6|7|8|9][...] 
439 Specify which ARM processor variant is the target.
440 @item -m[arm]v[2|2a|3|3m|4|4t|5|5t]
441 Specify which ARM architecture variant is used by the target.
442 @item -mthumb | -mall
443 Enable or disable Thumb only instruction decoding.
444 @item -mfpa10 | -mfpa11 | -mfpe-old | -mno-fpu
445 Select which Floating Point architcture is the target.
446 @item -mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant | -moabi
447 Select which procedure calling convention is in use.
448 @item -EB | -EL
449 Select either big-endian (-EB) or little-endian (-EL) output.
450 @item -mthumb-interwork
451 Specify that the code has been generated with interworking between Thumb and
452 ARM code in mind.
453 @item -k
454 Specify that PIC code has been generated.
455 @end table
456 @end ifset
457
458 @ifset D10V
459 The following options are available when @value{AS} is configured for
460 a D10V processor.
461 @table @code
462 @cindex D10V optimization
463 @cindex optimization, D10V
464 @item -O
465 Optimize output by parallelizing instructions.
466 @end table
467 @end ifset
468
469 @ifset D30V
470 The following options are available when @value{AS} is configured for a D30V
471 processor.
472 @table @code
473 @cindex D30V optimization
474 @cindex optimization, D30V
475 @item -O
476 Optimize output by parallelizing instructions.
477
478 @cindex D30V nops
479 @item -n
480 Warn when nops are generated.
481
482 @cindex D30V nops after 32-bit multiply
483 @item -N
484 Warn when a nop after a 32-bit multiply instruction is generated.
485 @end table
486 @end ifset
487
488 @ifset I960
489 The following options are available when @value{AS} is configured for the
490 Intel 80960 processor.
491
492 @table @code
493 @item -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC
494 Specify which variant of the 960 architecture is the target.
495
496 @item -b
497 Add code to collect statistics about branches taken.
498
499 @item -no-relax
500 Do not alter compare-and-branch instructions for long displacements;
501 error if necessary.
502
503 @end table
504 @end ifset
505
506 @ifset M32R
507 The following options are available when @value{AS} is configured for the
508 Mitsubishi M32R series.
509
510 @table @code
511
512 @item --m32rx
513 Specify which processor in the M32R family is the target.  The default
514 is normally the M32R, but this option changes it to the M32RX.
515
516 @item --warn-explicit-parallel-conflicts or --Wp
517 Produce warning messages when questionable parallel constructs are
518 encountered. 
519
520 @item --no-warn-explicit-parallel-conflicts or --Wnp
521 Do not produce warning messages when questionable parallel constructs are 
522 encountered. 
523
524 @end table
525 @end ifset
526
527 @ifset M680X0
528 The following options are available when @value{AS} is configured for the
529 Motorola 68000 series.
530
531 @table @code
532
533 @item -l
534 Shorten references to undefined symbols, to one word instead of two.
535
536 @item -m68000 | -m68008 | -m68010 | -m68020 | -m68030 | -m68040 | -m68060
537 @itemx | -m68302 | -m68331 | -m68332 | -m68333 | -m68340 | -mcpu32 | -m5200
538 Specify what processor in the 68000 family is the target.  The default
539 is normally the 68020, but this can be changed at configuration time.
540
541 @item -m68881 | -m68882 | -mno-68881 | -mno-68882
542 The target machine does (or does not) have a floating-point coprocessor.
543 The default is to assume a coprocessor for 68020, 68030, and cpu32.  Although
544 the basic 68000 is not compatible with the 68881, a combination of the
545 two can be specified, since it's possible to do emulation of the
546 coprocessor instructions with the main processor.
547
548 @item -m68851 | -mno-68851
549 The target machine does (or does not) have a memory-management
550 unit coprocessor.  The default is to assume an MMU for 68020 and up.
551
552 @end table
553 @end ifset
554
555 @ifset PJ
556 The following options are available when @value{AS} is configured for
557 a picoJava processor.
558
559 @table @code
560
561 @cindex PJ endianness
562 @cindex endianness, PJ
563 @cindex big endian output, PJ
564 @item -mb
565 Generate ``big endian'' format output.
566
567 @cindex little endian output, PJ
568 @item -ml
569 Generate ``little endian'' format output.
570
571 @end table
572 @end ifset
573
574 @ifset M68HC11
575 The following options are available when @value{AS} is configured for the
576 Motorola 68HC11 or 68HC12 series.
577
578 @table @code
579
580 @item -m68hc11 | -m68hc12
581 Specify what processor is the target.  The default is
582 defined by the configuration option when building the assembler.
583
584 @item --force-long-branchs
585 Relative branches are turned into absolute ones. This concerns
586 conditional branches, unconditional branches and branches to a
587 sub routine.
588
589 @item -S | --short-branchs
590 Do not turn relative branchs into absolute ones
591 when the offset is out of range.
592
593 @item --strict-direct-mode
594 Do not turn the direct addressing mode into extended addressing mode
595 when the instruction does not support direct addressing mode.
596
597 @item --print-insn-syntax
598 Print the syntax of instruction in case of error.
599
600 @item --print-opcodes
601 print the list of instructions with syntax and then exit.
602
603 @item --generate-example
604 print an example of instruction for each possible instruction and then exit.
605 This option is only useful for testing @code{@value{AS}}.
606
607 @end table
608 @end ifset
609
610 @ifset SPARC
611 The following options are available when @code{@value{AS}} is configured
612 for the SPARC architecture:
613
614 @table @code
615 @item -Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite
616 @itemx -Av8plus | -Av8plusa | -Av9 | -Av9a
617 Explicitly select a variant of the SPARC architecture.
618
619 @samp{-Av8plus} and @samp{-Av8plusa} select a 32 bit environment.
620 @samp{-Av9} and @samp{-Av9a} select a 64 bit environment.
621
622 @samp{-Av8plusa} and @samp{-Av9a} enable the SPARC V9 instruction set with
623 UltraSPARC extensions.
624
625 @item -xarch=v8plus | -xarch=v8plusa
626 For compatibility with the Solaris v9 assembler.  These options are
627 equivalent to -Av8plus and -Av8plusa, respectively.
628
629 @item -bump
630 Warn when the assembler switches to another architecture.
631 @end table
632 @end ifset
633
634 @ifset TIC54X
635 The following options are available when @value{AS} is configured for the 'c54x
636 architecture. 
637
638 @table @code
639 @item -mfar-mode
640 Enable extended addressing mode.  All addresses and relocations will assume
641 extended addressing (usually 23 bits).
642 @item -mcpu=@var{CPU_VERSION}
643 Sets the CPU version being compiled for.
644 @item -merrors-to-file @var{FILENAME}
645 Redirect error output to a file, for broken systems which don't support such
646 behaviour in the shell.
647 @end table
648 @end ifset
649
650 @ifset MIPS
651 The following options are available when @value{AS} is configured for
652 a MIPS processor.
653
654 @table @code
655 @item -G @var{num}
656 This option sets the largest size of an object that can be referenced
657 implicitly with the @code{gp} register.  It is only accepted for targets that
658 use ECOFF format, such as a DECstation running Ultrix.  The default value is 8.
659
660 @cindex MIPS endianness
661 @cindex endianness, MIPS
662 @cindex big endian output, MIPS
663 @item -EB
664 Generate ``big endian'' format output.
665
666 @cindex little endian output, MIPS
667 @item -EL
668 Generate ``little endian'' format output.
669
670 @cindex MIPS ISA
671 @item -mips1
672 @itemx -mips2
673 @itemx -mips3
674 @itemx -mips4
675 @itemx -mips32
676 Generate code for a particular MIPS Instruction Set Architecture level.
677 @samp{-mips1} corresponds to the @sc{r2000} and @sc{r3000} processors,
678 @samp{-mips2} to the @sc{r6000} processor, and @samp{-mips3} to the @sc{r4000}
679 processor.
680 @samp{-mips5}, @samp{-mips32}, and @samp{-mips64} correspond
681 to generic @sc{MIPS V}, @sc{MIPS32}, and @sc{MIPS64} ISA
682 processors, respectively.
683
684 @item -m4650
685 @itemx -no-m4650
686 Generate code for the MIPS @sc{r4650} chip.  This tells the assembler to accept
687 the @samp{mad} and @samp{madu} instruction, and to not schedule @samp{nop}
688 instructions around accesses to the @samp{HI} and @samp{LO} registers.
689 @samp{-no-m4650} turns off this option.
690
691 @item -mcpu=@var{CPU}
692 Generate code for a particular MIPS cpu.  It is exactly equivalent to
693 @samp{-m@var{cpu}}, except that there are more value of @var{cpu}
694 understood.
695
696 @cindex emulation
697 @item --emulation=@var{name}
698 This option causes @code{@value{AS}} to emulate @code{@value{AS}} configured
699 for some other target, in all respects, including output format (choosing
700 between ELF and ECOFF only), handling of pseudo-opcodes which may generate
701 debugging information or store symbol table information, and default
702 endianness.  The available configuration names are: @samp{mipsecoff},
703 @samp{mipself}, @samp{mipslecoff}, @samp{mipsbecoff}, @samp{mipslelf},
704 @samp{mipsbelf}.  The first two do not alter the default endianness from that
705 of the primary target for which the assembler was configured; the others change
706 the default to little- or big-endian as indicated by the @samp{b} or @samp{l}
707 in the name.  Using @samp{-EB} or @samp{-EL} will override the endianness
708 selection in any case.
709
710 This option is currently supported only when the primary target
711 @code{@value{AS}} is configured for is a MIPS ELF or ECOFF target.
712 Furthermore, the primary target or others specified with
713 @samp{--enable-targets=@dots{}} at configuration time must include support for
714 the other format, if both are to be available.  For example, the Irix 5
715 configuration includes support for both.
716
717 Eventually, this option will support more configurations, with more
718 fine-grained control over the assembler's behavior, and will be supported for
719 more processors.
720
721 @item -nocpp
722 @code{@value{AS}} ignores this option.  It is accepted for compatibility with
723 the native tools.
724
725 @need 900
726 @item --trap
727 @itemx --no-trap
728 @itemx --break
729 @itemx --no-break
730 Control how to deal with multiplication overflow and division by zero.
731 @samp{--trap} or @samp{--no-break} (which are synonyms) take a trap exception
732 (and only work for Instruction Set Architecture level 2 and higher);
733 @samp{--break} or @samp{--no-trap} (also synonyms, and the default) take a
734 break exception.
735 @end table
736 @end ifset
737
738 @ifset MCORE
739 The following options are available when @value{AS} is configured for
740 an MCore processor.
741
742 @table @code
743 @item -jsri2bsr
744 @itemx -nojsri2bsr
745 Enable or disable the JSRI to BSR transformation.  By default this is enabled.
746 The command line option @samp{-nojsri2bsr} can be used to disable it.
747
748 @item -sifilter
749 @itemx -nosifilter
750 Enable or disable the silicon filter behaviour.  By default this is disabled.
751 The default can be overidden by the @samp{-sifilter} command line option.
752
753 @item -relax
754 Alter jump instructions for long displacements.
755
756 @item -mcpu=[210|340]
757 Select the cpu type on the target hardware.  This controls which instructions
758 can be assembled.
759
760 @item -EB
761 Assemble for a big endian target.
762
763 @item -EL
764 Assemble for a little endian target.
765
766 @end table
767 @end ifset
768
769 @menu
770 * Manual::                      Structure of this Manual
771 * GNU Assembler::               The GNU Assembler
772 * Object Formats::              Object File Formats
773 * Command Line::                Command Line
774 * Input Files::                 Input Files
775 * Object::                      Output (Object) File
776 * Errors::                      Error and Warning Messages
777 @end menu
778
779 @node Manual
780 @section Structure of this Manual
781
782 @cindex manual, structure and purpose
783 This manual is intended to describe what you need to know to use
784 @sc{gnu} @code{@value{AS}}.  We cover the syntax expected in source files, including
785 notation for symbols, constants, and expressions; the directives that
786 @code{@value{AS}} understands; and of course how to invoke @code{@value{AS}}.
787
788 @ifclear GENERIC
789 We also cover special features in the @value{TARGET}
790 configuration of @code{@value{AS}}, including assembler directives.
791 @end ifclear
792 @ifset GENERIC
793 This manual also describes some of the machine-dependent features of
794 various flavors of the assembler.
795 @end ifset
796
797 @cindex machine instructions (not covered)
798 On the other hand, this manual is @emph{not} intended as an introduction
799 to programming in assembly language---let alone programming in general!
800 In a similar vein, we make no attempt to introduce the machine
801 architecture; we do @emph{not} describe the instruction set, standard
802 mnemonics, registers or addressing modes that are standard to a
803 particular architecture.
804 @ifset GENERIC
805 You may want to consult the manufacturer's
806 machine architecture manual for this information.
807 @end ifset
808 @ifclear GENERIC
809 @ifset H8/300
810 For information on the H8/300 machine instruction set, see @cite{H8/300
811 Series Programming Manual} (Hitachi ADE--602--025).  For the H8/300H,
812 see @cite{H8/300H Series Programming Manual} (Hitachi).
813 @end ifset
814 @ifset H8/500
815 For information on the H8/500 machine instruction set, see @cite{H8/500
816 Series Programming Manual} (Hitachi M21T001).
817 @end ifset
818 @ifset SH
819 For information on the Hitachi SH machine instruction set, see
820 @cite{SH-Microcomputer User's Manual} (Hitachi Micro Systems, Inc.).
821 @end ifset
822 @ifset Z8000
823 For information on the Z8000 machine instruction set, see @cite{Z8000 CPU Technical Manual}
824 @end ifset
825 @end ifclear
826
827 @c I think this is premature---doc@cygnus.com, 17jan1991
828 @ignore
829 Throughout this manual, we assume that you are running @dfn{GNU},
830 the portable operating system from the @dfn{Free Software
831 Foundation, Inc.}.  This restricts our attention to certain kinds of
832 computer (in particular, the kinds of computers that @sc{gnu} can run on);
833 once this assumption is granted examples and definitions need less
834 qualification.
835
836 @code{@value{AS}} is part of a team of programs that turn a high-level
837 human-readable series of instructions into a low-level
838 computer-readable series of instructions.  Different versions of
839 @code{@value{AS}} are used for different kinds of computer.
840 @end ignore
841
842 @c There used to be a section "Terminology" here, which defined
843 @c "contents", "byte", "word", and "long".  Defining "word" to any
844 @c particular size is confusing when the .word directive may generate 16
845 @c bits on one machine and 32 bits on another; in general, for the user
846 @c version of this manual, none of these terms seem essential to define.
847 @c They were used very little even in the former draft of the manual;
848 @c this draft makes an effort to avoid them (except in names of
849 @c directives).
850
851 @node GNU Assembler
852 @section The GNU Assembler
853
854 @sc{gnu} @code{as} is really a family of assemblers.
855 @ifclear GENERIC
856 This manual describes @code{@value{AS}}, a member of that family which is
857 configured for the @value{TARGET} architectures.
858 @end ifclear
859 If you use (or have used) the @sc{gnu} assembler on one architecture, you
860 should find a fairly similar environment when you use it on another
861 architecture.  Each version has much in common with the others,
862 including object file formats, most assembler directives (often called
863 @dfn{pseudo-ops}) and assembler syntax.@refill
864
865 @cindex purpose of @sc{gnu} assembler
866 @code{@value{AS}} is primarily intended to assemble the output of the
867 @sc{gnu} C compiler @code{@value{GCC}} for use by the linker
868 @code{@value{LD}}.  Nevertheless, we've tried to make @code{@value{AS}}
869 assemble correctly everything that other assemblers for the same
870 machine would assemble.
871 @ifset VAX
872 Any exceptions are documented explicitly (@pxref{Machine Dependencies}).
873 @end ifset
874 @ifset M680X0
875 @c This remark should appear in generic version of manual; assumption
876 @c here is that generic version sets M680x0.
877 This doesn't mean @code{@value{AS}} always uses the same syntax as another
878 assembler for the same architecture; for example, we know of several
879 incompatible versions of 680x0 assembly language syntax.
880 @end ifset
881
882 Unlike older assemblers, @code{@value{AS}} is designed to assemble a source
883 program in one pass of the source file.  This has a subtle impact on the
884 @kbd{.org} directive (@pxref{Org,,@code{.org}}).
885
886 @node Object Formats
887 @section Object File Formats
888
889 @cindex object file format
890 The @sc{gnu} assembler can be configured to produce several alternative
891 object file formats.  For the most part, this does not affect how you
892 write assembly language programs; but directives for debugging symbols
893 are typically different in different file formats.  @xref{Symbol
894 Attributes,,Symbol Attributes}.
895 @ifclear GENERIC
896 @ifclear MULTI-OBJ
897 On the @value{TARGET}, @code{@value{AS}} is configured to produce
898 @value{OBJ-NAME} format object files.
899 @end ifclear
900 @c The following should exhaust all configs that set MULTI-OBJ, ideally
901 @ifset A29K
902 On the @value{TARGET}, @code{@value{AS}} can be configured to produce either
903 @code{a.out} or COFF format object files.
904 @end ifset
905 @ifset I960
906 On the @value{TARGET}, @code{@value{AS}} can be configured to produce either
907 @code{b.out} or COFF format object files.
908 @end ifset
909 @ifset HPPA
910 On the @value{TARGET}, @code{@value{AS}} can be configured to produce either
911 SOM or ELF format object files.
912 @end ifset
913 @end ifclear
914
915 @node Command Line
916 @section Command Line
917
918 @cindex command line conventions
919 After the program name @code{@value{AS}}, the command line may contain
920 options and file names.  Options may appear in any order, and may be
921 before, after, or between file names.  The order of file names is
922 significant.
923
924 @cindex standard input, as input file
925 @kindex --
926 @file{--} (two hyphens) by itself names the standard input file
927 explicitly, as one of the files for @code{@value{AS}} to assemble.
928
929 @cindex options, command line
930 Except for @samp{--} any command line argument that begins with a
931 hyphen (@samp{-}) is an option.  Each option changes the behavior of
932 @code{@value{AS}}.  No option changes the way another option works.  An
933 option is a @samp{-} followed by one or more letters; the case of
934 the letter is important.   All options are optional.
935
936 Some options expect exactly one file name to follow them.  The file
937 name may either immediately follow the option's letter (compatible
938 with older assemblers) or it may be the next command argument (@sc{gnu}
939 standard).  These two command lines are equivalent:
940
941 @smallexample
942 @value{AS} -o my-object-file.o mumble.s
943 @value{AS} -omy-object-file.o mumble.s
944 @end smallexample
945
946 @node Input Files
947 @section Input Files
948
949 @cindex input
950 @cindex source program
951 @cindex files, input
952 We use the phrase @dfn{source program}, abbreviated @dfn{source}, to
953 describe the program input to one run of @code{@value{AS}}.  The program may
954 be in one or more files; how the source is partitioned into files
955 doesn't change the meaning of the source.
956
957 @c I added "con" prefix to "catenation" just to prove I can overcome my
958 @c APL training...   doc@cygnus.com
959 The source program is a concatenation of the text in all the files, in the
960 order specified.
961
962 Each time you run @code{@value{AS}} it assembles exactly one source
963 program.  The source program is made up of one or more files.
964 (The standard input is also a file.)
965
966 You give @code{@value{AS}} a command line that has zero or more input file
967 names.  The input files are read (from left file name to right).  A
968 command line argument (in any position) that has no special meaning
969 is taken to be an input file name.
970
971 If you give @code{@value{AS}} no file names it attempts to read one input file
972 from the @code{@value{AS}} standard input, which is normally your terminal.  You
973 may have to type @key{ctl-D} to tell @code{@value{AS}} there is no more program
974 to assemble.
975
976 Use @samp{--} if you need to explicitly name the standard input file
977 in your command line.
978
979 If the source is empty, @code{@value{AS}} produces a small, empty object
980 file.
981
982 @subheading Filenames and Line-numbers
983
984 @cindex input file linenumbers
985 @cindex line numbers, in input files
986 There are two ways of locating a line in the input file (or files) and
987 either may be used in reporting error messages.  One way refers to a line
988 number in a physical file; the other refers to a line number in a
989 ``logical'' file.  @xref{Errors, ,Error and Warning Messages}.
990
991 @dfn{Physical files} are those files named in the command line given
992 to @code{@value{AS}}.
993
994 @dfn{Logical files} are simply names declared explicitly by assembler
995 directives; they bear no relation to physical files.  Logical file names help
996 error messages reflect the original source file, when @code{@value{AS}} source
997 is itself synthesized from other files.  @code{@value{AS}} understands the
998 @samp{#} directives emitted by the @code{@value{GCC}} preprocessor.  See also
999 @ref{File,,@code{.file}}.
1000
1001 @node Object
1002 @section Output (Object) File
1003
1004 @cindex object file
1005 @cindex output file
1006 @kindex a.out
1007 @kindex .o
1008 Every time you run @code{@value{AS}} it produces an output file, which is
1009 your assembly language program translated into numbers.  This file
1010 is the object file.  Its default name is
1011 @ifclear BOUT
1012 @code{a.out}.
1013 @end ifclear
1014 @ifset BOUT
1015 @ifset GENERIC
1016 @code{a.out}, or 
1017 @end ifset
1018 @code{b.out} when @code{@value{AS}} is configured for the Intel 80960.
1019 @end ifset
1020 You can give it another name by using the @code{-o} option.  Conventionally,
1021 object file names end with @file{.o}.  The default name is used for historical
1022 reasons: older assemblers were capable of assembling self-contained programs
1023 directly into a runnable program.  (For some formats, this isn't currently
1024 possible, but it can be done for the @code{a.out} format.)
1025
1026 @cindex linker
1027 @kindex ld
1028 The object file is meant for input to the linker @code{@value{LD}}.  It contains
1029 assembled program code, information to help @code{@value{LD}} integrate
1030 the assembled program into a runnable file, and (optionally) symbolic
1031 information for the debugger.
1032
1033 @c link above to some info file(s) like the description of a.out.
1034 @c don't forget to describe @sc{gnu} info as well as Unix lossage.
1035
1036 @node Errors
1037 @section Error and Warning Messages
1038
1039 @cindex error messsages
1040 @cindex warning messages
1041 @cindex messages from assembler
1042 @code{@value{AS}} may write warnings and error messages to the standard error
1043 file (usually your terminal).  This should not happen when  a compiler
1044 runs @code{@value{AS}} automatically.  Warnings report an assumption made so
1045 that @code{@value{AS}} could keep assembling a flawed program; errors report a
1046 grave problem that stops the assembly.
1047
1048 @cindex format of warning messages
1049 Warning messages have the format
1050
1051 @smallexample
1052 file_name:@b{NNN}:Warning Message Text
1053 @end smallexample
1054
1055 @noindent
1056 @cindex line numbers, in warnings/errors
1057 (where @b{NNN} is a line number).  If a logical file name has been given
1058 (@pxref{File,,@code{.file}}) it is used for the filename, otherwise the name of
1059 the current input file is used.  If a logical line number was given
1060 @ifset GENERIC
1061 (@pxref{Line,,@code{.line}})
1062 @end ifset
1063 @ifclear GENERIC
1064 @ifclear A29K
1065 (@pxref{Line,,@code{.line}})
1066 @end ifclear
1067 @ifset A29K
1068 (@pxref{Ln,,@code{.ln}})
1069 @end ifset
1070 @end ifclear
1071 then it is used to calculate the number printed,
1072 otherwise the actual line in the current source file is printed.  The
1073 message text is intended to be self explanatory (in the grand Unix
1074 tradition).
1075
1076 @cindex format of error messages
1077 Error messages have the format
1078 @smallexample
1079 file_name:@b{NNN}:FATAL:Error Message Text
1080 @end smallexample
1081 The file name and line number are derived as for warning
1082 messages.  The actual message text may be rather less explanatory
1083 because many of them aren't supposed to happen.
1084
1085 @node Invoking
1086 @chapter Command-Line Options
1087
1088 @cindex options, all versions of assembler
1089 This chapter describes command-line options available in @emph{all}
1090 versions of the @sc{gnu} assembler; @pxref{Machine Dependencies}, for options specific
1091 @ifclear GENERIC
1092 to the @value{TARGET}.
1093 @end ifclear
1094 @ifset GENERIC
1095 to particular machine architectures.
1096 @end ifset
1097
1098 If you are invoking @code{@value{AS}} via the @sc{gnu} C compiler (version 2),
1099 you can use the @samp{-Wa} option to pass arguments through to the assembler.
1100 The assembler arguments must be separated from each other (and the @samp{-Wa})
1101 by commas.  For example:
1102
1103 @smallexample
1104 gcc -c -g -O -Wa,-alh,-L file.c
1105 @end smallexample
1106
1107 @noindent
1108 This passes two options to the assembler: @samp{-alh} (emit a listing to
1109 standard output with with high-level and assembly source) and @samp{-L} (retain
1110 local symbols in the symbol table).
1111
1112 Usually you do not need to use this @samp{-Wa} mechanism, since many compiler
1113 command-line options are automatically passed to the assembler by the compiler.
1114 (You can call the @sc{gnu} compiler driver with the @samp{-v} option to see
1115 precisely what options it passes to each compilation pass, including the
1116 assembler.)
1117
1118 @menu
1119 * a::             -a[cdhlns] enable listings
1120 * D::             -D for compatibility
1121 * f::             -f to work faster
1122 * I::             -I for .include search path
1123 @ifclear DIFF-TBL-KLUGE
1124 * K::             -K for compatibility
1125 @end ifclear
1126 @ifset DIFF-TBL-KLUGE
1127 * K::             -K for difference tables
1128 @end ifset
1129
1130 * L::             -L to retain local labels
1131 * M::             -M or --mri to assemble in MRI compatibility mode
1132 * MD::            --MD for dependency tracking
1133 * o::             -o to name the object file
1134 * R::             -R to join data and text sections
1135 * statistics::    --statistics to see statistics about assembly
1136 * traditional-format:: --traditional-format for compatible output
1137 * v::             -v to announce version
1138 * W::             -W, --no-warn, --warn, --fatal-warnings to control warnings
1139 * Z::             -Z to make object file even after errors
1140 @end menu
1141
1142 @node a
1143 @section Enable Listings: @code{-a[cdhlns]}
1144
1145 @kindex -a
1146 @kindex -ac
1147 @kindex -ad
1148 @kindex -ah
1149 @kindex -al
1150 @kindex -an
1151 @kindex -as
1152 @cindex listings, enabling
1153 @cindex assembly listings, enabling
1154
1155 These options enable listing output from the assembler.  By itself,
1156 @samp{-a} requests high-level, assembly, and symbols listing.
1157 You can use other letters to select specific options for the list:
1158 @samp{-ah} requests a high-level language listing,
1159 @samp{-al} requests an output-program assembly listing, and
1160 @samp{-as} requests a symbol table listing.
1161 High-level listings require that a compiler debugging option like
1162 @samp{-g} be used, and that assembly listings (@samp{-al}) be requested
1163 also.
1164
1165 Use the @samp{-ac} option to omit false conditionals from a listing.  Any lines
1166 which are not assembled because of a false @code{.if} (or @code{.ifdef}, or any
1167 other conditional), or a true @code{.if} followed by an @code{.else}, will be
1168 omitted from the listing.
1169
1170 Use the @samp{-ad} option to omit debugging directives from the
1171 listing.
1172
1173 Once you have specified one of these options, you can further control
1174 listing output and its appearance using the directives @code{.list},
1175 @code{.nolist}, @code{.psize}, @code{.eject}, @code{.title}, and
1176 @code{.sbttl}.
1177 The @samp{-an} option turns off all forms processing.
1178 If you do not request listing output with one of the @samp{-a} options, the
1179 listing-control directives have no effect.
1180
1181 The letters after @samp{-a} may be combined into one option,
1182 @emph{e.g.}, @samp{-aln}.
1183
1184 @node D
1185 @section @code{-D}
1186
1187 @kindex -D
1188 This option has no effect whatsoever, but it is accepted to make it more
1189 likely that scripts written for other assemblers also work with
1190 @code{@value{AS}}.
1191
1192 @node f
1193 @section Work Faster: @code{-f}
1194
1195 @kindex -f
1196 @cindex trusted compiler
1197 @cindex faster processing (@code{-f})
1198 @samp{-f} should only be used when assembling programs written by a
1199 (trusted) compiler.  @samp{-f} stops the assembler from doing whitespace
1200 and comment preprocessing on
1201 the input file(s) before assembling them.  @xref{Preprocessing,
1202 ,Preprocessing}.
1203
1204 @quotation
1205 @emph{Warning:} if you use @samp{-f} when the files actually need to be
1206 preprocessed (if they contain comments, for example), @code{@value{AS}} does
1207 not work correctly.
1208 @end quotation
1209
1210 @node I
1211 @section @code{.include} search path: @code{-I} @var{path}
1212
1213 @kindex -I @var{path}
1214 @cindex paths for @code{.include}
1215 @cindex search path for @code{.include}
1216 @cindex @code{include} directive search path
1217 Use this option to add a @var{path} to the list of directories
1218 @code{@value{AS}} searches for files specified in @code{.include}
1219 directives (@pxref{Include,,@code{.include}}).  You may use @code{-I} as
1220 many times as necessary to include a variety of paths.  The current
1221 working directory is always searched first; after that, @code{@value{AS}}
1222 searches any @samp{-I} directories in the same order as they were
1223 specified (left to right) on the command line.
1224
1225 @node K
1226 @section Difference Tables: @code{-K}
1227
1228 @kindex -K
1229 @ifclear DIFF-TBL-KLUGE
1230 On the @value{TARGET} family, this option is allowed, but has no effect.  It is
1231 permitted for compatibility with the @sc{gnu} assembler on other platforms,
1232 where it can be used to warn when the assembler alters the machine code
1233 generated for @samp{.word} directives in difference tables.  The @value{TARGET}
1234 family does not have the addressing limitations that sometimes lead to this
1235 alteration on other platforms.
1236 @end ifclear
1237
1238 @ifset DIFF-TBL-KLUGE
1239 @cindex difference tables, warning
1240 @cindex warning for altered difference tables
1241 @code{@value{AS}} sometimes alters the code emitted for directives of the form
1242 @samp{.word @var{sym1}-@var{sym2}}; @pxref{Word,,@code{.word}}.
1243 You can use the @samp{-K} option if you want a warning issued when this
1244 is done.
1245 @end ifset
1246
1247 @node L
1248 @section Include Local Labels: @code{-L}
1249
1250 @kindex -L
1251 @cindex local labels, retaining in output
1252 Labels beginning with @samp{L} (upper case only) are called @dfn{local
1253 labels}. @xref{Symbol Names}.  Normally you do not see such labels when
1254 debugging, because they are intended for the use of programs (like
1255 compilers) that compose assembler programs, not for your notice.
1256 Normally both @code{@value{AS}} and @code{@value{LD}} discard such labels, so you do not
1257 normally debug with them.
1258
1259 This option tells @code{@value{AS}} to retain those @samp{L@dots{}} symbols
1260 in the object file.  Usually if you do this you also tell the linker
1261 @code{@value{LD}} to preserve symbols whose names begin with @samp{L}.
1262
1263 By default, a local label is any label beginning with @samp{L}, but each
1264 target is allowed to redefine the local label prefix.
1265 @ifset HPPA
1266 On the HPPA local labels begin with @samp{L$}.
1267 @end ifset
1268
1269 @node M
1270 @section Assemble in MRI Compatibility Mode: @code{-M}
1271
1272 @kindex -M
1273 @cindex MRI compatibility mode
1274 The @code{-M} or @code{--mri} option selects MRI compatibility mode.  This
1275 changes the syntax and pseudo-op handling of @code{@value{AS}} to make it
1276 compatible with the @code{ASM68K} or the @code{ASM960} (depending upon the
1277 configured target) assembler from Microtec Research.  The exact nature of the
1278 MRI syntax will not be documented here; see the MRI manuals for more
1279 information.  Note in particular that the handling of macros and macro
1280 arguments is somewhat different.  The purpose of this option is to permit
1281 assembling existing MRI assembler code using @code{@value{AS}}.
1282
1283 The MRI compatibility is not complete.  Certain operations of the MRI assembler
1284 depend upon its object file format, and can not be supported using other object
1285 file formats.  Supporting these would require enhancing each object file format
1286 individually.  These are:
1287
1288 @itemize @bullet
1289 @item global symbols in common section
1290
1291 The m68k MRI assembler supports common sections which are merged by the linker.
1292 Other object file formats do not support this.  @code{@value{AS}} handles
1293 common sections by treating them as a single common symbol.  It permits local
1294 symbols to be defined within a common section, but it can not support global
1295 symbols, since it has no way to describe them.
1296
1297 @item complex relocations
1298
1299 The MRI assemblers support relocations against a negated section address, and
1300 relocations which combine the start addresses of two or more sections.  These
1301 are not support by other object file formats.
1302
1303 @item @code{END} pseudo-op specifying start address
1304
1305 The MRI @code{END} pseudo-op permits the specification of a start address.
1306 This is not supported by other object file formats.  The start address may
1307 instead be specified using the @code{-e} option to the linker, or in a linker
1308 script.
1309
1310 @item @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops
1311
1312 The MRI @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops assign a module
1313 name to the output file.  This is not supported by other object file formats.
1314
1315 @item @code{ORG} pseudo-op
1316
1317 The m68k MRI @code{ORG} pseudo-op begins an absolute section at a given
1318 address.  This differs from the usual @code{@value{AS}} @code{.org} pseudo-op,
1319 which changes the location within the current section.  Absolute sections are
1320 not supported by other object file formats.  The address of a section may be
1321 assigned within a linker script.
1322 @end itemize
1323
1324 There are some other features of the MRI assembler which are not supported by
1325 @code{@value{AS}}, typically either because they are difficult or because they
1326 seem of little consequence.  Some of these may be supported in future releases.
1327
1328 @itemize @bullet
1329
1330 @item EBCDIC strings
1331
1332 EBCDIC strings are not supported.
1333
1334 @item packed binary coded decimal
1335
1336 Packed binary coded decimal is not supported.  This means that the @code{DC.P}
1337 and @code{DCB.P} pseudo-ops are not supported.
1338
1339 @item @code{FEQU} pseudo-op
1340
1341 The m68k @code{FEQU} pseudo-op is not supported.
1342
1343 @item @code{NOOBJ} pseudo-op
1344
1345 The m68k @code{NOOBJ} pseudo-op is not supported.
1346
1347 @item @code{OPT} branch control options
1348
1349 The m68k @code{OPT} branch control options---@code{B}, @code{BRS}, @code{BRB},
1350 @code{BRL}, and @code{BRW}---are ignored.  @code{@value{AS}} automatically
1351 relaxes all branches, whether forward or backward, to an appropriate size, so
1352 these options serve no purpose.
1353
1354 @item @code{OPT} list control options
1355
1356 The following m68k @code{OPT} list control options are ignored: @code{C},
1357 @code{CEX}, @code{CL}, @code{CRE}, @code{E}, @code{G}, @code{I}, @code{M},
1358 @code{MEX}, @code{MC}, @code{MD}, @code{X}.
1359
1360 @item other @code{OPT} options
1361
1362 The following m68k @code{OPT} options are ignored: @code{NEST}, @code{O},
1363 @code{OLD}, @code{OP}, @code{P}, @code{PCO}, @code{PCR}, @code{PCS}, @code{R}.
1364
1365 @item @code{OPT} @code{D} option is default
1366
1367 The m68k @code{OPT} @code{D} option is the default, unlike the MRI assembler.
1368 @code{OPT NOD} may be used to turn it off.
1369
1370 @item @code{XREF} pseudo-op.
1371
1372 The m68k @code{XREF} pseudo-op is ignored.
1373
1374 @item @code{.debug} pseudo-op
1375
1376 The i960 @code{.debug} pseudo-op is not supported.
1377
1378 @item @code{.extended} pseudo-op
1379
1380 The i960 @code{.extended} pseudo-op is not supported.
1381
1382 @item @code{.list} pseudo-op.
1383
1384 The various options of the i960 @code{.list} pseudo-op are not supported.
1385
1386 @item @code{.optimize} pseudo-op
1387
1388 The i960 @code{.optimize} pseudo-op is not supported.
1389
1390 @item @code{.output} pseudo-op
1391
1392 The i960 @code{.output} pseudo-op is not supported.
1393
1394 @item @code{.setreal} pseudo-op
1395
1396 The i960 @code{.setreal} pseudo-op is not supported.
1397
1398 @end itemize
1399
1400 @node MD
1401 @section Dependency tracking: @code{--MD}
1402
1403 @kindex --MD
1404 @cindex dependency tracking
1405 @cindex make rules
1406
1407 @code{@value{AS}} can generate a dependency file for the file it creates.  This
1408 file consists of a single rule suitable for @code{make} describing the
1409 dependencies of the main source file.
1410
1411 The rule is written to the file named in its argument.
1412
1413 This feature is used in the automatic updating of makefiles.
1414
1415 @node o
1416 @section Name the Object File: @code{-o}
1417
1418 @kindex -o
1419 @cindex naming object file
1420 @cindex object file name
1421 There is always one object file output when you run @code{@value{AS}}.  By
1422 default it has the name
1423 @ifset GENERIC
1424 @ifset I960
1425 @file{a.out} (or @file{b.out}, for Intel 960 targets only).
1426 @end ifset
1427 @ifclear I960
1428 @file{a.out}.
1429 @end ifclear
1430 @end ifset
1431 @ifclear GENERIC
1432 @ifset I960
1433 @file{b.out}.
1434 @end ifset
1435 @ifclear I960
1436 @file{a.out}.
1437 @end ifclear
1438 @end ifclear
1439 You use this option (which takes exactly one filename) to give the
1440 object file a different name.
1441
1442 Whatever the object file is called, @code{@value{AS}} overwrites any
1443 existing file of the same name.
1444
1445 @node R
1446 @section Join Data and Text Sections: @code{-R}
1447
1448 @kindex -R
1449 @cindex data and text sections, joining
1450 @cindex text and data sections, joining
1451 @cindex joining text and data sections
1452 @cindex merging text and data sections
1453 @code{-R} tells @code{@value{AS}} to write the object file as if all
1454 data-section data lives in the text section.  This is only done at
1455 the very last moment:  your binary data are the same, but data
1456 section parts are relocated differently.  The data section part of
1457 your object file is zero bytes long because all its bytes are
1458 appended to the text section.  (@xref{Sections,,Sections and Relocation}.)
1459
1460 When you specify @code{-R} it would be possible to generate shorter
1461 address displacements (because we do not have to cross between text and
1462 data section).  We refrain from doing this simply for compatibility with
1463 older versions of @code{@value{AS}}.  In future, @code{-R} may work this way.
1464
1465 @ifset COFF
1466 When @code{@value{AS}} is configured for COFF output,
1467 this option is only useful if you use sections named @samp{.text} and
1468 @samp{.data}.
1469 @end ifset
1470
1471 @ifset HPPA
1472 @code{-R} is not supported for any of the HPPA targets.  Using
1473 @code{-R} generates a warning from @code{@value{AS}}.
1474 @end ifset
1475
1476 @node statistics
1477 @section Display Assembly Statistics: @code{--statistics}
1478
1479 @kindex --statistics
1480 @cindex statistics, about assembly
1481 @cindex time, total for assembly
1482 @cindex space used, maximum for assembly
1483 Use @samp{--statistics} to display two statistics about the resources used by
1484 @code{@value{AS}}: the maximum amount of space allocated during the assembly
1485 (in bytes), and the total execution time taken for the assembly (in @sc{cpu}
1486 seconds).
1487
1488 @node traditional-format
1489 @section Compatible output: @code{--traditional-format}
1490
1491 @kindex --traditional-format
1492 For some targets, the output of @code{@value{AS}} is different in some ways
1493 from the output of some existing assembler.  This switch requests
1494 @code{@value{AS}} to use the traditional format instead.
1495
1496 For example, it disables the exception frame optimizations which
1497 @code{@value{AS}} normally does by default on @code{@value{GCC}} output.
1498
1499 @node v
1500 @section Announce Version: @code{-v}
1501
1502 @kindex -v
1503 @kindex -version
1504 @cindex assembler version
1505 @cindex version of assembler
1506 You can find out what version of as is running by including the
1507 option @samp{-v} (which you can also spell as @samp{-version}) on the
1508 command line.
1509
1510 @node W
1511 @section Control Warnings: @code{-W}, @code{--warn}, @code{--no-warn}, @code{--fatal-warnings}
1512
1513 @code{@value{AS}} should never give a warning or error message when
1514 assembling compiler output.  But programs written by people often
1515 cause @code{@value{AS}} to give a warning that a particular assumption was
1516 made.  All such warnings are directed to the standard error file.
1517
1518 @kindex @samp{-W}
1519 @kindex @samp{--no-warn}
1520 @cindex suppressing warnings
1521 @cindex warnings, suppressing
1522 If you use the @code{-W} and @code{--no-warn} options, no warnings are issued.
1523 This only affects the warning messages: it does not change any particular of
1524 how @code{@value{AS}} assembles your file.  Errors, which stop the assembly,
1525 are still reported.
1526
1527 @kindex @samp{--fatal-warnings}
1528 @cindex errors, caused by warnings
1529 @cindex warnings, causing error
1530 If you use the @code{--fatal-warnings} option, @code{@value{AS}} considers
1531 files that generate warnings to be in error.
1532
1533 @kindex @samp{--warn}
1534 @cindex warnings, switching on
1535 You can switch these options off again by specifying @code{--warn}, which
1536 causes warnings to be output as usual.
1537
1538 @node Z
1539 @section Generate Object File in Spite of Errors: @code{-Z}
1540 @cindex object file, after errors
1541 @cindex errors, continuing after
1542 After an error message, @code{@value{AS}} normally produces no output.  If for
1543 some reason you are interested in object file output even after
1544 @code{@value{AS}} gives an error message on your program, use the @samp{-Z}
1545 option.  If there are any errors, @code{@value{AS}} continues anyways, and
1546 writes an object file after a final warning message of the form @samp{@var{n}
1547 errors, @var{m} warnings, generating bad object file.}
1548
1549 @node Syntax
1550 @chapter Syntax
1551
1552 @cindex machine-independent syntax
1553 @cindex syntax, machine-independent
1554 This chapter describes the machine-independent syntax allowed in a
1555 source file.  @code{@value{AS}} syntax is similar to what many other
1556 assemblers use; it is inspired by the BSD 4.2
1557 @ifclear VAX
1558 assembler.
1559 @end ifclear
1560 @ifset VAX
1561 assembler, except that @code{@value{AS}} does not assemble Vax bit-fields.
1562 @end ifset
1563
1564 @menu
1565 * Preprocessing::              Preprocessing
1566 * Whitespace::                  Whitespace
1567 * Comments::                    Comments
1568 * Symbol Intro::                Symbols
1569 * Statements::                  Statements
1570 * Constants::                   Constants
1571 @end menu
1572
1573 @node Preprocessing
1574 @section Preprocessing
1575
1576 @cindex preprocessing
1577 The @code{@value{AS}} internal preprocessor:
1578 @itemize @bullet
1579 @cindex whitespace, removed by preprocessor
1580 @item
1581 adjusts and removes extra whitespace.  It leaves one space or tab before
1582 the keywords on a line, and turns any other whitespace on the line into
1583 a single space.
1584
1585 @cindex comments, removed by preprocessor
1586 @item
1587 removes all comments, replacing them with a single space, or an
1588 appropriate number of newlines.
1589
1590 @cindex constants, converted by preprocessor
1591 @item
1592 converts character constants into the appropriate numeric values.
1593 @end itemize
1594
1595 It does not do macro processing, include file handling, or
1596 anything else you may get from your C compiler's preprocessor.  You can
1597 do include file processing with the @code{.include} directive
1598 (@pxref{Include,,@code{.include}}).  You can use the @sc{gnu} C compiler driver
1599 to get other ``CPP'' style preprocessing, by giving the input file a
1600 @samp{.S} suffix.  @xref{Overall Options,, Options Controlling the Kind of
1601 Output, gcc.info, Using GNU CC}.
1602
1603 Excess whitespace, comments, and character constants
1604 cannot be used in the portions of the input text that are not
1605 preprocessed.
1606
1607 @cindex turning preprocessing on and off
1608 @cindex preprocessing, turning on and off
1609 @kindex #NO_APP
1610 @kindex #APP
1611 If the first line of an input file is @code{#NO_APP} or if you use the
1612 @samp{-f} option, whitespace and comments are not removed from the input file.
1613 Within an input file, you can ask for whitespace and comment removal in
1614 specific portions of the by putting a line that says @code{#APP} before the
1615 text that may contain whitespace or comments, and putting a line that says
1616 @code{#NO_APP} after this text.  This feature is mainly intend to support
1617 @code{asm} statements in compilers whose output is otherwise free of comments
1618 and whitespace.
1619
1620 @node Whitespace
1621 @section Whitespace
1622
1623 @cindex whitespace
1624 @dfn{Whitespace} is one or more blanks or tabs, in any order.
1625 Whitespace is used to separate symbols, and to make programs neater for
1626 people to read.  Unless within character constants
1627 (@pxref{Characters,,Character Constants}), any whitespace means the same
1628 as exactly one space.
1629
1630 @node Comments
1631 @section Comments
1632
1633 @cindex comments
1634 There are two ways of rendering comments to @code{@value{AS}}.  In both
1635 cases the comment is equivalent to one space.
1636
1637 Anything from @samp{/*} through the next @samp{*/} is a comment.
1638 This means you may not nest these comments.
1639
1640 @smallexample
1641 /*
1642   The only way to include a newline ('\n') in a comment
1643   is to use this sort of comment.
1644 */
1645
1646 /* This sort of comment does not nest. */
1647 @end smallexample
1648
1649 @cindex line comment character
1650 Anything from the @dfn{line comment} character to the next newline
1651 is considered a comment and is ignored.  The line comment character is
1652 @ifset A29K
1653 @samp{;} for the AMD 29K family;
1654 @end ifset
1655 @ifset ARC
1656 @samp{;} on the ARC;
1657 @end ifset
1658 @ifset ARM
1659 @samp{@@} on the ARM;
1660 @end ifset
1661 @ifset H8/300
1662 @samp{;} for the H8/300 family;
1663 @end ifset
1664 @ifset H8/500
1665 @samp{!} for the H8/500 family;
1666 @end ifset
1667 @ifset HPPA
1668 @samp{;} for the HPPA;
1669 @end ifset
1670 @ifset I80386
1671 @samp{#} on the i386 and x86-64;
1672 @end ifset
1673 @ifset I960
1674 @samp{#} on the i960;
1675 @end ifset
1676 @ifset PJ
1677 @samp{;} for picoJava;
1678 @end ifset
1679 @ifset SH
1680 @samp{!} for the Hitachi SH;
1681 @end ifset
1682 @ifset SPARC
1683 @samp{!} on the SPARC;
1684 @end ifset
1685 @ifset M32R
1686 @samp{#} on the m32r;
1687 @end ifset
1688 @ifset M680X0
1689 @samp{|} on the 680x0;
1690 @end ifset
1691 @ifset M68HC11
1692 @samp{#} on the 68HC11 and 68HC12;
1693 @end ifset
1694 @ifset VAX
1695 @samp{#} on the Vax;
1696 @end ifset
1697 @ifset Z8000
1698 @samp{!} for the Z8000;
1699 @end ifset
1700 @ifset V850
1701 @samp{#} on the V850;
1702 @end ifset
1703 see @ref{Machine Dependencies}.  @refill
1704 @c FIXME What about m88k, i860?
1705
1706 @ifset GENERIC
1707 On some machines there are two different line comment characters.  One
1708 character only begins a comment if it is the first non-whitespace character on
1709 a line, while the other always begins a comment.
1710 @end ifset
1711
1712 @ifset V850
1713 The V850 assembler also supports a double dash as starting a comment that
1714 extends to the end of the line.
1715
1716 @samp{--};
1717 @end ifset
1718
1719 @kindex #
1720 @cindex lines starting with @code{#}
1721 @cindex logical line numbers
1722 To be compatible with past assemblers, lines that begin with @samp{#} have a
1723 special interpretation.  Following the @samp{#} should be an absolute
1724 expression (@pxref{Expressions}): the logical line number of the @emph{next}
1725 line.  Then a string (@pxref{Strings,, Strings}) is allowed: if present it is a
1726 new logical file name.  The rest of the line, if any, should be whitespace.
1727
1728 If the first non-whitespace characters on the line are not numeric,
1729 the line is ignored.  (Just like a comment.)
1730
1731 @smallexample
1732                           # This is an ordinary comment.
1733 # 42-6 "new_file_name"    # New logical file name
1734                           # This is logical line # 36.
1735 @end smallexample
1736 This feature is deprecated, and may disappear from future versions
1737 of @code{@value{AS}}.
1738
1739 @node Symbol Intro
1740 @section Symbols
1741
1742 @cindex characters used in symbols
1743 @ifclear SPECIAL-SYMS
1744 A @dfn{symbol} is one or more characters chosen from the set of all
1745 letters (both upper and lower case), digits and the three characters
1746 @samp{_.$}.
1747 @end ifclear
1748 @ifset SPECIAL-SYMS
1749 @ifclear GENERIC
1750 @ifset H8
1751 A @dfn{symbol} is one or more characters chosen from the set of all
1752 letters (both upper and lower case), digits and the three characters
1753 @samp{._$}.  (Save that, on the H8/300 only, you may not use @samp{$} in
1754 symbol names.)
1755 @end ifset
1756 @end ifclear
1757 @end ifset
1758 @ifset GENERIC
1759 On most machines, you can also use @code{$} in symbol names; exceptions
1760 are noted in @ref{Machine Dependencies}.
1761 @end ifset
1762 No symbol may begin with a digit.  Case is significant.
1763 There is no length limit: all characters are significant.  Symbols are
1764 delimited by characters not in that set, or by the beginning of a file
1765 (since the source program must end with a newline, the end of a file is
1766 not a possible symbol delimiter).  @xref{Symbols}.
1767 @cindex length of symbols
1768
1769 @node Statements
1770 @section Statements
1771
1772 @cindex statements, structure of
1773 @cindex line separator character
1774 @cindex statement separator character
1775 @ifclear GENERIC
1776 @ifclear abnormal-separator
1777 A @dfn{statement} ends at a newline character (@samp{\n}) or at a
1778 semicolon (@samp{;}).  The newline or semicolon is considered part of
1779 the preceding statement.  Newlines and semicolons within character
1780 constants are an exception: they do not end statements.
1781 @end ifclear
1782 @ifset abnormal-separator
1783 @ifset A29K
1784 A @dfn{statement} ends at a newline character (@samp{\n}) or an ``at''
1785 sign (@samp{@@}).  The newline or at sign is considered part of the
1786 preceding statement.  Newlines and at signs within character constants
1787 are an exception: they do not end statements.
1788 @end ifset
1789 @ifset HPPA
1790 A @dfn{statement} ends at a newline character (@samp{\n}) or an exclamation 
1791 point (@samp{!}).  The newline or exclamation point is considered part of the
1792 preceding statement.  Newlines and exclamation points within character
1793 constants are an exception: they do not end statements.
1794 @end ifset
1795 @ifset H8
1796 A @dfn{statement} ends at a newline character (@samp{\n}); or (for the
1797 H8/300) a dollar sign (@samp{$}); or (for the
1798 Hitachi-SH or the
1799 H8/500) a semicolon
1800 (@samp{;}).  The newline or separator character is considered part of
1801 the preceding statement.  Newlines and separators within character
1802 constants are an exception: they do not end statements.
1803 @end ifset
1804 @end ifset
1805 @end ifclear
1806 @ifset GENERIC
1807 A @dfn{statement} ends at a newline character (@samp{\n}) or line
1808 separator character.  (The line separator is usually @samp{;}, unless
1809 this conflicts with the comment character; @pxref{Machine Dependencies}.)  The
1810 newline or separator character is considered part of the preceding
1811 statement.  Newlines and separators within character constants are an
1812 exception: they do not end statements.
1813 @end ifset
1814
1815 @cindex newline, required at file end
1816 @cindex EOF, newline must precede
1817 It is an error to end any statement with end-of-file:  the last
1818 character of any input file should be a newline.@refill
1819
1820 An empty statement is allowed, and may include whitespace.  It is ignored.
1821
1822 @cindex instructions and directives
1823 @cindex directives and instructions
1824 @c "key symbol" is not used elsewhere in the document; seems pedantic to
1825 @c @defn{} it in that case, as was done previously...  doc@cygnus.com,
1826 @c 13feb91.
1827 A statement begins with zero or more labels, optionally followed by a
1828 key symbol which determines what kind of statement it is.  The key
1829 symbol determines the syntax of the rest of the statement.  If the
1830 symbol begins with a dot @samp{.} then the statement is an assembler
1831 directive: typically valid for any computer.  If the symbol begins with
1832 a letter the statement is an assembly language @dfn{instruction}: it
1833 assembles into a machine language instruction.
1834 @ifset GENERIC
1835 Different versions of @code{@value{AS}} for different computers
1836 recognize different instructions.  In fact, the same symbol may
1837 represent a different instruction in a different computer's assembly
1838 language.@refill
1839 @end ifset
1840
1841 @cindex @code{:} (label)
1842 @cindex label (@code{:})
1843 A label is a symbol immediately followed by a colon (@code{:}).
1844 Whitespace before a label or after a colon is permitted, but you may not
1845 have whitespace between a label's symbol and its colon. @xref{Labels}.
1846
1847 @ifset HPPA
1848 For HPPA targets, labels need not be immediately followed by a colon, but 
1849 the definition of a label must begin in column zero.  This also implies that
1850 only one label may be defined on each line.
1851 @end ifset
1852
1853 @smallexample
1854 label:     .directive    followed by something
1855 another_label:           # This is an empty statement.
1856            instruction   operand_1, operand_2, @dots{}
1857 @end smallexample
1858
1859 @node Constants
1860 @section Constants
1861
1862 @cindex constants
1863 A constant is a number, written so that its value is known by
1864 inspection, without knowing any context.  Like this:
1865 @smallexample
1866 @group
1867 .byte  74, 0112, 092, 0x4A, 0X4a, 'J, '\J # All the same value.
1868 .ascii "Ring the bell\7"                  # A string constant.
1869 .octa  0x123456789abcdef0123456789ABCDEF0 # A bignum.
1870 .float 0f-314159265358979323846264338327\
1871 95028841971.693993751E-40                 # - pi, a flonum.
1872 @end group
1873 @end smallexample
1874
1875 @menu
1876 * Characters::                  Character Constants
1877 * Numbers::                     Number Constants
1878 @end menu
1879
1880 @node Characters
1881 @subsection Character Constants
1882
1883 @cindex character constants
1884 @cindex constants, character
1885 There are two kinds of character constants.  A @dfn{character} stands
1886 for one character in one byte and its value may be used in
1887 numeric expressions.  String constants (properly called string
1888 @emph{literals}) are potentially many bytes and their values may not be
1889 used in arithmetic expressions.
1890
1891 @menu
1892 * Strings::                     Strings
1893 * Chars::                       Characters
1894 @end menu
1895
1896 @node Strings
1897 @subsubsection Strings
1898
1899 @cindex string constants
1900 @cindex constants, string
1901 A @dfn{string} is written between double-quotes.  It may contain
1902 double-quotes or null characters.  The way to get special characters
1903 into a string is to @dfn{escape} these characters: precede them with
1904 a backslash @samp{\} character.  For example @samp{\\} represents
1905 one backslash:  the first @code{\} is an escape which tells
1906 @code{@value{AS}} to interpret the second character literally as a backslash
1907 (which prevents @code{@value{AS}} from recognizing the second @code{\} as an
1908 escape character).  The complete list of escapes follows.
1909
1910 @cindex escape codes, character
1911 @cindex character escape codes
1912 @table @kbd
1913 @c      @item \a
1914 @c      Mnemonic for ACKnowledge; for ASCII this is octal code 007.
1915 @c
1916 @cindex @code{\b} (backspace character)
1917 @cindex backspace (@code{\b})
1918 @item \b
1919 Mnemonic for backspace; for ASCII this is octal code 010.
1920
1921 @c      @item \e
1922 @c      Mnemonic for EOText; for ASCII this is octal code 004.
1923 @c
1924 @cindex @code{\f} (formfeed character)
1925 @cindex formfeed (@code{\f})
1926 @item \f
1927 Mnemonic for FormFeed; for ASCII this is octal code 014.
1928
1929 @cindex @code{\n} (newline character)
1930 @cindex newline (@code{\n})
1931 @item \n
1932 Mnemonic for newline; for ASCII this is octal code 012.
1933
1934 @c      @item \p
1935 @c      Mnemonic for prefix; for ASCII this is octal code 033, usually known as @code{escape}.
1936 @c
1937 @cindex @code{\r} (carriage return character)
1938 @cindex carriage return (@code{\r})
1939 @item \r
1940 Mnemonic for carriage-Return; for ASCII this is octal code 015.
1941
1942 @c      @item \s
1943 @c      Mnemonic for space; for ASCII this is octal code 040.  Included for compliance with
1944 @c      other assemblers.
1945 @c
1946 @cindex @code{\t} (tab)
1947 @cindex tab (@code{\t})
1948 @item \t
1949 Mnemonic for horizontal Tab; for ASCII this is octal code 011.
1950
1951 @c      @item \v
1952 @c      Mnemonic for Vertical tab; for ASCII this is octal code 013.
1953 @c      @item \x @var{digit} @var{digit} @var{digit}
1954 @c      A hexadecimal character code.  The numeric code is 3 hexadecimal digits.
1955 @c
1956 @cindex @code{\@var{ddd}} (octal character code)
1957 @cindex octal character code (@code{\@var{ddd}})
1958 @item \ @var{digit} @var{digit} @var{digit}
1959 An octal character code.  The numeric code is 3 octal digits.
1960 For compatibility with other Unix systems, 8 and 9 are accepted as digits:
1961 for example, @code{\008} has the value 010, and @code{\009} the value 011.
1962
1963 @cindex @code{\@var{xd...}} (hex character code)
1964 @cindex hex character code (@code{\@var{xd...}})
1965 @item \@code{x} @var{hex-digits...}
1966 A hex character code.  All trailing hex digits are combined.  Either upper or
1967 lower case @code{x} works.
1968
1969 @cindex @code{\\} (@samp{\} character)
1970 @cindex backslash (@code{\\})
1971 @item \\
1972 Represents one @samp{\} character.
1973
1974 @c      @item \'
1975 @c      Represents one @samp{'} (accent acute) character.
1976 @c      This is needed in single character literals
1977 @c      (@xref{Characters,,Character Constants}.) to represent
1978 @c      a @samp{'}.
1979 @c
1980 @cindex @code{\"} (doublequote character)
1981 @cindex doublequote (@code{\"})
1982 @item \"
1983 Represents one @samp{"} character.  Needed in strings to represent
1984 this character, because an unescaped @samp{"} would end the string.
1985
1986 @item \ @var{anything-else}
1987 Any other character when escaped by @kbd{\} gives a warning, but
1988 assembles as if the @samp{\} was not present.  The idea is that if
1989 you used an escape sequence you clearly didn't want the literal
1990 interpretation of the following character.  However @code{@value{AS}} has no
1991 other interpretation, so @code{@value{AS}} knows it is giving you the wrong
1992 code and warns you of the fact.
1993 @end table
1994
1995 Which characters are escapable, and what those escapes represent,
1996 varies widely among assemblers.  The current set is what we think
1997 the BSD 4.2 assembler recognizes, and is a subset of what most C
1998 compilers recognize.  If you are in doubt, do not use an escape
1999 sequence.
2000
2001 @node Chars
2002 @subsubsection Characters
2003
2004 @cindex single character constant
2005 @cindex character, single
2006 @cindex constant, single character
2007 A single character may be written as a single quote immediately
2008 followed by that character.  The same escapes apply to characters as
2009 to strings.  So if you want to write the character backslash, you
2010 must write @kbd{'\\} where the first @code{\} escapes the second
2011 @code{\}.  As you can see, the quote is an acute accent, not a
2012 grave accent.  A newline
2013 @ifclear GENERIC
2014 @ifclear abnormal-separator
2015 (or semicolon @samp{;})
2016 @end ifclear
2017 @ifset abnormal-separator
2018 @ifset A29K
2019 (or at sign @samp{@@})
2020 @end ifset
2021 @ifset H8
2022 (or dollar sign @samp{$}, for the H8/300; or semicolon @samp{;} for the
2023 Hitachi SH or
2024 H8/500)
2025 @end ifset
2026 @end ifset
2027 @end ifclear
2028 immediately following an acute accent is taken as a literal character
2029 and does not count as the end of a statement.  The value of a character
2030 constant in a numeric expression is the machine's byte-wide code for
2031 that character.  @code{@value{AS}} assumes your character code is ASCII:
2032 @kbd{'A} means 65, @kbd{'B} means 66, and so on. @refill
2033
2034 @node Numbers
2035 @subsection Number Constants
2036
2037 @cindex constants, number
2038 @cindex number constants
2039 @code{@value{AS}} distinguishes three kinds of numbers according to how they
2040 are stored in the target machine.  @emph{Integers} are numbers that
2041 would fit into an @code{int} in the C language.  @emph{Bignums} are
2042 integers, but they are stored in more than 32 bits.  @emph{Flonums}
2043 are floating point numbers, described below.
2044
2045 @menu
2046 * Integers::                    Integers
2047 * Bignums::                     Bignums
2048 * Flonums::                     Flonums
2049 @ifclear GENERIC
2050 @ifset I960
2051 * Bit Fields::                  Bit Fields
2052 @end ifset
2053 @end ifclear
2054 @end menu
2055
2056 @node Integers
2057 @subsubsection Integers
2058 @cindex integers
2059 @cindex constants, integer
2060
2061 @cindex binary integers
2062 @cindex integers, binary
2063 A binary integer is @samp{0b} or @samp{0B} followed by zero or more of
2064 the binary digits @samp{01}.
2065
2066 @cindex octal integers
2067 @cindex integers, octal
2068 An octal integer is @samp{0} followed by zero or more of the octal
2069 digits (@samp{01234567}).
2070
2071 @cindex decimal integers
2072 @cindex integers, decimal
2073 A decimal integer starts with a non-zero digit followed by zero or
2074 more digits (@samp{0123456789}).
2075
2076 @cindex hexadecimal integers
2077 @cindex integers, hexadecimal
2078 A hexadecimal integer is @samp{0x} or @samp{0X} followed by one or
2079 more hexadecimal digits chosen from @samp{0123456789abcdefABCDEF}.
2080
2081 Integers have the usual values.  To denote a negative integer, use
2082 the prefix operator @samp{-} discussed under expressions
2083 (@pxref{Prefix Ops,,Prefix Operators}).
2084
2085 @node Bignums
2086 @subsubsection Bignums
2087
2088 @cindex bignums
2089 @cindex constants, bignum
2090 A @dfn{bignum} has the same syntax and semantics as an integer
2091 except that the number (or its negative) takes more than 32 bits to
2092 represent in binary.  The distinction is made because in some places
2093 integers are permitted while bignums are not.
2094
2095 @node Flonums
2096 @subsubsection Flonums
2097 @cindex flonums
2098 @cindex floating point numbers
2099 @cindex constants, floating point
2100
2101 @cindex precision, floating point
2102 A @dfn{flonum} represents a floating point number.  The translation is
2103 indirect: a decimal floating point number from the text is converted by
2104 @code{@value{AS}} to a generic binary floating point number of more than
2105 sufficient precision.  This generic floating point number is converted
2106 to a particular computer's floating point format (or formats) by a
2107 portion of @code{@value{AS}} specialized to that computer.
2108
2109 A flonum is written by writing (in order)
2110 @itemize @bullet
2111 @item
2112 The digit @samp{0}.
2113 @ifset HPPA
2114 (@samp{0} is optional on the HPPA.)
2115 @end ifset
2116
2117 @item
2118 A letter, to tell @code{@value{AS}} the rest of the number is a flonum.
2119 @ifset GENERIC
2120 @kbd{e} is recommended.  Case is not important.
2121 @ignore
2122 @c FIXME: verify if flonum syntax really this vague for most cases
2123 (Any otherwise illegal letter works here, but that might be changed.  Vax BSD
2124 4.2 assembler seems to allow any of @samp{defghDEFGH}.)
2125 @end ignore
2126
2127 On the H8/300, H8/500,
2128 Hitachi SH,
2129 and AMD 29K architectures, the letter must be
2130 one of the letters @samp{DFPRSX} (in upper or lower case).
2131
2132 On the ARC, the letter must be one of the letters @samp{DFRS}
2133 (in upper or lower case).
2134
2135 On the Intel 960 architecture, the letter must be
2136 one of the letters @samp{DFT} (in upper or lower case).
2137
2138 On the HPPA architecture, the letter must be @samp{E} (upper case only).
2139 @end ifset
2140 @ifclear GENERIC
2141 @ifset A29K
2142 One of the letters @samp{DFPRSX} (in upper or lower case).
2143 @end ifset
2144 @ifset ARC
2145 One of the letters @samp{DFRS} (in upper or lower case).
2146 @end ifset
2147 @ifset H8
2148 One of the letters @samp{DFPRSX} (in upper or lower case).
2149 @end ifset
2150 @ifset HPPA
2151 The letter @samp{E} (upper case only).
2152 @end ifset
2153 @ifset I960
2154 One of the letters @samp{DFT} (in upper or lower case).
2155 @end ifset
2156 @end ifclear
2157
2158 @item
2159 An optional sign: either @samp{+} or @samp{-}.
2160
2161 @item
2162 An optional @dfn{integer part}: zero or more decimal digits.
2163
2164 @item
2165 An optional @dfn{fractional part}: @samp{.} followed by zero
2166 or more decimal digits.
2167
2168 @item
2169 An optional exponent, consisting of:
2170
2171 @itemize @bullet
2172 @item
2173 An @samp{E} or @samp{e}.
2174 @c I can't find a config where "EXP_CHARS" is other than 'eE', but in
2175 @c principle this can perfectly well be different on different targets.
2176 @item
2177 Optional sign: either @samp{+} or @samp{-}.
2178 @item
2179 One or more decimal digits.
2180 @end itemize
2181
2182 @end itemize
2183
2184 At least one of the integer part or the fractional part must be
2185 present.  The floating point number has the usual base-10 value.
2186
2187 @code{@value{AS}} does all processing using integers.  Flonums are computed
2188 independently of any floating point hardware in the computer running
2189 @code{@value{AS}}.
2190
2191 @ifclear GENERIC
2192 @ifset I960
2193 @c Bit fields are written as a general facility but are also controlled
2194 @c by a conditional-compilation flag---which is as of now (21mar91)
2195 @c turned on only by the i960 config of GAS.
2196 @node Bit Fields
2197 @subsubsection Bit Fields
2198
2199 @cindex bit fields
2200 @cindex constants, bit field
2201 You can also define numeric constants as @dfn{bit fields}.
2202 specify two numbers separated by a colon---
2203 @example
2204 @var{mask}:@var{value}
2205 @end example
2206 @noindent
2207 @code{@value{AS}} applies a bitwise @sc{and} between @var{mask} and
2208 @var{value}.
2209
2210 The resulting number is then packed
2211 @ifset GENERIC
2212 @c this conditional paren in case bit fields turned on elsewhere than 960
2213 (in host-dependent byte order)
2214 @end ifset
2215 into a field whose width depends on which assembler directive has the
2216 bit-field as its argument.  Overflow (a result from the bitwise and
2217 requiring more binary digits to represent) is not an error; instead,
2218 more constants are generated, of the specified width, beginning with the
2219 least significant digits.@refill
2220
2221 The directives @code{.byte}, @code{.hword}, @code{.int}, @code{.long},
2222 @code{.short}, and @code{.word} accept bit-field arguments.
2223 @end ifset
2224 @end ifclear
2225
2226 @node Sections
2227 @chapter Sections and Relocation
2228 @cindex sections
2229 @cindex relocation
2230
2231 @menu
2232 * Secs Background::             Background
2233 * Ld Sections::                 Linker Sections
2234 * As Sections::                 Assembler Internal Sections
2235 * Sub-Sections::                Sub-Sections
2236 * bss::                         bss Section
2237 @end menu
2238
2239 @node Secs Background
2240 @section Background
2241
2242 Roughly, a section is a range of addresses, with no gaps; all data
2243 ``in'' those addresses is treated the same for some particular purpose.
2244 For example there may be a ``read only'' section.
2245
2246 @cindex linker, and assembler
2247 @cindex assembler, and linker
2248 The linker @code{@value{LD}} reads many object files (partial programs) and
2249 combines their contents to form a runnable program.  When @code{@value{AS}}
2250 emits an object file, the partial program is assumed to start at address 0.
2251 @code{@value{LD}} assigns the final addresses for the partial program, so that
2252 different partial programs do not overlap.  This is actually an
2253 oversimplification, but it suffices to explain how @code{@value{AS}} uses
2254 sections.
2255
2256 @code{@value{LD}} moves blocks of bytes of your program to their run-time
2257 addresses.  These blocks slide to their run-time addresses as rigid
2258 units; their length does not change and neither does the order of bytes
2259 within them.  Such a rigid unit is called a @emph{section}.  Assigning
2260 run-time addresses to sections is called @dfn{relocation}.  It includes
2261 the task of adjusting mentions of object-file addresses so they refer to
2262 the proper run-time addresses.
2263 @ifset H8
2264 For the H8/300 and H8/500,
2265 and for the Hitachi SH,
2266 @code{@value{AS}} pads sections if needed to
2267 ensure they end on a word (sixteen bit) boundary.
2268 @end ifset
2269
2270 @cindex standard assembler sections
2271 An object file written by @code{@value{AS}} has at least three sections, any
2272 of which may be empty.  These are named @dfn{text}, @dfn{data} and
2273 @dfn{bss} sections.
2274
2275 @ifset COFF
2276 @ifset GENERIC
2277 When it generates COFF output,
2278 @end ifset
2279 @code{@value{AS}} can also generate whatever other named sections you specify
2280 using the @samp{.section} directive (@pxref{Section,,@code{.section}}).
2281 If you do not use any directives that place output in the @samp{.text}
2282 or @samp{.data} sections, these sections still exist, but are empty.
2283 @end ifset
2284
2285 @ifset HPPA
2286 @ifset GENERIC
2287 When @code{@value{AS}} generates SOM or ELF output for the HPPA,
2288 @end ifset
2289 @code{@value{AS}} can also generate whatever other named sections you
2290 specify using the @samp{.space} and @samp{.subspace} directives.  See
2291 @cite{HP9000 Series 800 Assembly Language Reference Manual}
2292 (HP 92432-90001) for details on the @samp{.space} and @samp{.subspace}
2293 assembler directives.
2294
2295 @ifset SOM
2296 Additionally, @code{@value{AS}} uses different names for the standard
2297 text, data, and bss sections when generating SOM output.  Program text
2298 is placed into the @samp{$CODE$} section, data into @samp{$DATA$}, and
2299 BSS into @samp{$BSS$}.
2300 @end ifset
2301 @end ifset
2302
2303 Within the object file, the text section starts at address @code{0}, the
2304 data section follows, and the bss section follows the data section.
2305
2306 @ifset HPPA
2307 When generating either SOM or ELF output files on the HPPA, the text
2308 section starts at address @code{0}, the data section at address
2309 @code{0x4000000}, and the bss section follows the data section.
2310 @end ifset
2311
2312 To let @code{@value{LD}} know which data changes when the sections are
2313 relocated, and how to change that data, @code{@value{AS}} also writes to the
2314 object file details of the relocation needed.  To perform relocation
2315 @code{@value{LD}} must know, each time an address in the object
2316 file is mentioned:
2317 @itemize @bullet
2318 @item
2319 Where in the object file is the beginning of this reference to
2320 an address?
2321 @item
2322 How long (in bytes) is this reference?
2323 @item
2324 Which section does the address refer to?  What is the numeric value of
2325 @display
2326 (@var{address}) @minus{} (@var{start-address of section})?
2327 @end display
2328 @item
2329 Is the reference to an address ``Program-Counter relative''?
2330 @end itemize
2331
2332 @cindex addresses, format of
2333 @cindex section-relative addressing
2334 In fact, every address @code{@value{AS}} ever uses is expressed as
2335 @display
2336 (@var{section}) + (@var{offset into section})
2337 @end display
2338 @noindent
2339 Further, most expressions @code{@value{AS}} computes have this section-relative
2340 nature.
2341 @ifset SOM
2342 (For some object formats, such as SOM for the HPPA, some expressions are
2343 symbol-relative instead.)
2344 @end ifset
2345
2346 In this manual we use the notation @{@var{secname} @var{N}@} to mean ``offset
2347 @var{N} into section @var{secname}.''
2348
2349 Apart from text, data and bss sections you need to know about the
2350 @dfn{absolute} section.  When @code{@value{LD}} mixes partial programs,
2351 addresses in the absolute section remain unchanged.  For example, address
2352 @code{@{absolute 0@}} is ``relocated'' to run-time address 0 by
2353 @code{@value{LD}}.  Although the linker never arranges two partial programs'
2354 data sections with overlapping addresses after linking, @emph{by definition}
2355 their absolute sections must overlap.  Address @code{@{absolute@ 239@}} in one
2356 part of a program is always the same address when the program is running as
2357 address @code{@{absolute@ 239@}} in any other part of the program.
2358
2359 The idea of sections is extended to the @dfn{undefined} section.  Any
2360 address whose section is unknown at assembly time is by definition
2361 rendered @{undefined @var{U}@}---where @var{U} is filled in later.
2362 Since numbers are always defined, the only way to generate an undefined
2363 address is to mention an undefined symbol.  A reference to a named
2364 common block would be such a symbol: its value is unknown at assembly
2365 time so it has section @emph{undefined}.
2366
2367 By analogy the word @emph{section} is used to describe groups of sections in
2368 the linked program.  @code{@value{LD}} puts all partial programs' text
2369 sections in contiguous addresses in the linked program.  It is
2370 customary to refer to the @emph{text section} of a program, meaning all
2371 the addresses of all partial programs' text sections.  Likewise for
2372 data and bss sections.
2373
2374 Some sections are manipulated by @code{@value{LD}}; others are invented for
2375 use of @code{@value{AS}} and have no meaning except during assembly.
2376
2377 @node Ld Sections
2378 @section Linker Sections
2379 @code{@value{LD}} deals with just four kinds of sections, summarized below.
2380
2381 @table @strong
2382
2383 @ifset COFF
2384 @cindex named sections
2385 @cindex sections, named
2386 @item named sections
2387 @end ifset
2388 @ifset aout-bout
2389 @cindex text section
2390 @cindex data section
2391 @itemx text section
2392 @itemx data section
2393 @end ifset
2394 These sections hold your program.  @code{@value{AS}} and @code{@value{LD}} treat them as
2395 separate but equal sections.  Anything you can say of one section is
2396 true another.
2397 @ifset aout-bout
2398 When the program is running, however, it is
2399 customary for the text section to be unalterable.  The
2400 text section is often shared among processes: it contains
2401 instructions, constants and the like.  The data section of a running
2402 program is usually alterable: for example, C variables would be stored
2403 in the data section.
2404 @end ifset
2405
2406 @cindex bss section
2407 @item bss section
2408 This section contains zeroed bytes when your program begins running.  It
2409 is used to hold unitialized variables or common storage.  The length of
2410 each partial program's bss section is important, but because it starts
2411 out containing zeroed bytes there is no need to store explicit zero
2412 bytes in the object file.  The bss section was invented to eliminate
2413 those explicit zeros from object files.
2414
2415 @cindex absolute section
2416 @item absolute section
2417 Address 0 of this section is always ``relocated'' to runtime address 0.
2418 This is useful if you want to refer to an address that @code{@value{LD}} must
2419 not change when relocating.  In this sense we speak of absolute
2420 addresses being ``unrelocatable'': they do not change during relocation.
2421
2422 @cindex undefined section
2423 @item undefined section
2424 This ``section'' is a catch-all for address references to objects not in
2425 the preceding sections.
2426 @c FIXME: ref to some other doc on obj-file formats could go here.
2427 @end table
2428
2429 @cindex relocation example
2430 An idealized example of three relocatable sections follows.
2431 @ifset COFF
2432 The example uses the traditional section names @samp{.text} and @samp{.data}.
2433 @end ifset
2434 Memory addresses are on the horizontal axis.
2435
2436 @c TEXI2ROFF-KILL
2437 @ifinfo
2438 @c END TEXI2ROFF-KILL
2439 @smallexample
2440                       +-----+----+--+
2441 partial program # 1:  |ttttt|dddd|00|
2442                       +-----+----+--+
2443
2444                       text   data bss
2445                       seg.   seg. seg.
2446
2447                       +---+---+---+
2448 partial program # 2:  |TTT|DDD|000|
2449                       +---+---+---+
2450
2451                       +--+---+-----+--+----+---+-----+~~
2452 linked program:       |  |TTT|ttttt|  |dddd|DDD|00000|
2453                       +--+---+-----+--+----+---+-----+~~
2454
2455     addresses:        0 @dots{}
2456 @end smallexample
2457 @c TEXI2ROFF-KILL
2458 @end ifinfo
2459 @need 5000
2460 @tex
2461
2462 \line{\it Partial program \#1: \hfil}
2463 \line{\ibox{2.5cm}{\tt text}\ibox{2cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
2464 \line{\boxit{2.5cm}{\tt ttttt}\boxit{2cm}{\tt dddd}\boxit{1cm}{\tt 00}\hfil}
2465
2466 \line{\it Partial program \#2: \hfil}
2467 \line{\ibox{1cm}{\tt text}\ibox{1.5cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
2468 \line{\boxit{1cm}{\tt TTT}\boxit{1.5cm}{\tt DDDD}\boxit{1cm}{\tt 000}\hfil}
2469
2470 \line{\it linked program: \hfil}
2471 \line{\ibox{.5cm}{}\ibox{1cm}{\tt text}\ibox{2.5cm}{}\ibox{.75cm}{}\ibox{2cm}{\tt data}\ibox{1.5cm}{}\ibox{2cm}{\tt bss}\hfil}
2472 \line{\boxit{.5cm}{}\boxit{1cm}{\tt TTT}\boxit{2.5cm}{\tt
2473 ttttt}\boxit{.75cm}{}\boxit{2cm}{\tt dddd}\boxit{1.5cm}{\tt
2474 DDDD}\boxit{2cm}{\tt 00000}\ \dots\hfil}
2475
2476 \line{\it addresses: \hfil}
2477 \line{0\dots\hfil}
2478
2479 @end tex
2480 @c END TEXI2ROFF-KILL
2481
2482 @node As Sections
2483 @section Assembler Internal Sections
2484
2485 @cindex internal assembler sections
2486 @cindex sections in messages, internal
2487 These sections are meant only for the internal use of @code{@value{AS}}.  They
2488 have no meaning at run-time.  You do not really need to know about these
2489 sections for most purposes; but they can be mentioned in @code{@value{AS}}
2490 warning messages, so it might be helpful to have an idea of their
2491 meanings to @code{@value{AS}}.  These sections are used to permit the
2492 value of every expression in your assembly language program to be a
2493 section-relative address.
2494
2495 @table @b
2496 @cindex assembler internal logic error
2497 @item ASSEMBLER-INTERNAL-LOGIC-ERROR!
2498 An internal assembler logic error has been found.  This means there is a
2499 bug in the assembler.
2500
2501 @cindex expr (internal section)
2502 @item expr section
2503 The assembler stores complex expression internally as combinations of
2504 symbols.  When it needs to represent an expression as a symbol, it puts
2505 it in the expr section.
2506 @c FIXME item debug
2507 @c FIXME item transfer[t] vector preload
2508 @c FIXME item transfer[t] vector postload
2509 @c FIXME item register
2510 @end table
2511
2512 @node Sub-Sections
2513 @section Sub-Sections
2514
2515 @cindex numbered subsections
2516 @cindex grouping data
2517 @ifset aout-bout
2518 Assembled bytes
2519 @ifset COFF
2520 conventionally
2521 @end ifset
2522 fall into two sections: text and data.
2523 @end ifset
2524 You may have separate groups of
2525 @ifset GENERIC
2526 data in named sections
2527 @end ifset
2528 @ifclear GENERIC
2529 @ifclear aout-bout
2530 data in named sections
2531 @end ifclear
2532 @ifset aout-bout
2533 text or data
2534 @end ifset
2535 @end ifclear
2536 that you want to end up near to each other in the object file, even though they
2537 are not contiguous in the assembler source.  @code{@value{AS}} allows you to
2538 use @dfn{subsections} for this purpose.  Within each section, there can be
2539 numbered subsections with values from 0 to 8192.  Objects assembled into the
2540 same subsection go into the object file together with other objects in the same
2541 subsection.  For example, a compiler might want to store constants in the text
2542 section, but might not want to have them interspersed with the program being
2543 assembled.  In this case, the compiler could issue a @samp{.text 0} before each
2544 section of code being output, and a @samp{.text 1} before each group of
2545 constants being output.
2546
2547 Subsections are optional.  If you do not use subsections, everything
2548 goes in subsection number zero.
2549
2550 @ifset GENERIC
2551 Each subsection is zero-padded up to a multiple of four bytes.
2552 (Subsections may be padded a different amount on different flavors
2553 of @code{@value{AS}}.)
2554 @end ifset
2555 @ifclear GENERIC
2556 @ifset H8
2557 On the H8/300 and H8/500 platforms, each subsection is zero-padded to a word
2558 boundary (two bytes).
2559 The same is true on the Hitachi SH.
2560 @end ifset
2561 @ifset I960
2562 @c FIXME section padding (alignment)?
2563 @c Rich Pixley says padding here depends on target obj code format; that
2564 @c doesn't seem particularly useful to say without further elaboration,
2565 @c so for now I say nothing about it.  If this is a generic BFD issue,
2566 @c these paragraphs might need to vanish from this manual, and be
2567 @c discussed in BFD chapter of binutils (or some such).
2568 @end ifset
2569 @ifset A29K
2570 On the AMD 29K family, no particular padding is added to section or
2571 subsection sizes; @value{AS} forces no alignment on this platform.
2572 @end ifset
2573 @end ifclear
2574
2575 Subsections appear in your object file in numeric order, lowest numbered
2576 to highest.  (All this to be compatible with other people's assemblers.)
2577 The object file contains no representation of subsections; @code{@value{LD}} and
2578 other programs that manipulate object files see no trace of them.
2579 They just see all your text subsections as a text section, and all your
2580 data subsections as a data section.
2581
2582 To specify which subsection you want subsequent statements assembled
2583 into, use a numeric argument to specify it, in a @samp{.text
2584 @var{expression}} or a @samp{.data @var{expression}} statement.
2585 @ifset COFF
2586 @ifset GENERIC
2587 When generating COFF output, you
2588 @end ifset
2589 @ifclear GENERIC
2590 You
2591 @end ifclear
2592 can also use an extra subsection
2593 argument with arbitrary named sections: @samp{.section @var{name},
2594 @var{expression}}.
2595 @end ifset
2596 @var{Expression} should be an absolute expression.
2597 (@xref{Expressions}.)  If you just say @samp{.text} then @samp{.text 0}
2598 is assumed.  Likewise @samp{.data} means @samp{.data 0}.  Assembly
2599 begins in @code{text 0}.  For instance:
2600 @smallexample
2601 .text 0     # The default subsection is text 0 anyway.
2602 .ascii "This lives in the first text subsection. *"
2603 .text 1
2604 .ascii "But this lives in the second text subsection."
2605 .data 0
2606 .ascii "This lives in the data section,"
2607 .ascii "in the first data subsection."
2608 .text 0
2609 .ascii "This lives in the first text section,"
2610 .ascii "immediately following the asterisk (*)."
2611 @end smallexample
2612
2613 Each section has a @dfn{location counter} incremented by one for every byte
2614 assembled into that section.  Because subsections are merely a convenience
2615 restricted to @code{@value{AS}} there is no concept of a subsection location
2616 counter.  There is no way to directly manipulate a location counter---but the
2617 @code{.align} directive changes it, and any label definition captures its
2618 current value.  The location counter of the section where statements are being
2619 assembled is said to be the @dfn{active} location counter.
2620
2621 @node bss
2622 @section bss Section
2623
2624 @cindex bss section
2625 @cindex common variable storage
2626 The bss section is used for local common variable storage.
2627 You may allocate address space in the bss section, but you may
2628 not dictate data to load into it before your program executes.  When
2629 your program starts running, all the contents of the bss
2630 section are zeroed bytes.
2631
2632 The @code{.lcomm} pseudo-op defines a symbol in the bss section; see
2633 @ref{Lcomm,,@code{.lcomm}}.
2634
2635 The @code{.comm} pseudo-op may be used to declare a common symbol, which is
2636 another form of uninitialized symbol; see @xref{Comm,,@code{.comm}}.
2637
2638 @ifset GENERIC
2639 When assembling for a target which supports multiple sections, such as ELF or
2640 COFF, you may switch into the @code{.bss} section and define symbols as usual;
2641 see @ref{Section,,@code{.section}}.  You may only assemble zero values into the
2642 section.  Typically the section will only contain symbol definitions and
2643 @code{.skip} directives (@pxref{Skip,,@code{.skip}}).
2644 @end ifset
2645
2646 @node Symbols
2647 @chapter Symbols
2648
2649 @cindex symbols
2650 Symbols are a central concept: the programmer uses symbols to name
2651 things, the linker uses symbols to link, and the debugger uses symbols
2652 to debug.
2653
2654 @quotation
2655 @cindex debuggers, and symbol order
2656 @emph{Warning:} @code{@value{AS}} does not place symbols in the object file in
2657 the same order they were declared.  This may break some debuggers.
2658 @end quotation
2659
2660 @menu
2661 * Labels::                      Labels
2662 * Setting Symbols::             Giving Symbols Other Values
2663 * Symbol Names::                Symbol Names
2664 * Dot::                         The Special Dot Symbol
2665 * Symbol Attributes::           Symbol Attributes
2666 @end menu
2667
2668 @node Labels
2669 @section Labels
2670
2671 @cindex labels
2672 A @dfn{label} is written as a symbol immediately followed by a colon
2673 @samp{:}.  The symbol then represents the current value of the
2674 active location counter, and is, for example, a suitable instruction
2675 operand.  You are warned if you use the same symbol to represent two
2676 different locations: the first definition overrides any other
2677 definitions.
2678
2679 @ifset HPPA
2680 On the HPPA, the usual form for a label need not be immediately followed by a
2681 colon, but instead must start in column zero.  Only one label may be defined on
2682 a single line.  To work around this, the HPPA version of @code{@value{AS}} also
2683 provides a special directive @code{.label} for defining labels more flexibly.
2684 @end ifset
2685
2686 @node Setting Symbols
2687 @section Giving Symbols Other Values
2688
2689 @cindex assigning values to symbols
2690 @cindex symbol values, assigning
2691 A symbol can be given an arbitrary value by writing a symbol, followed
2692 by an equals sign @samp{=}, followed by an expression
2693 (@pxref{Expressions}).  This is equivalent to using the @code{.set}
2694 directive.  @xref{Set,,@code{.set}}.
2695
2696 @node Symbol Names
2697 @section Symbol Names
2698
2699 @cindex symbol names
2700 @cindex names, symbol
2701 @ifclear SPECIAL-SYMS
2702 Symbol names begin with a letter or with one of @samp{._}.  On most
2703 machines, you can also use @code{$} in symbol names; exceptions are
2704 noted in @ref{Machine Dependencies}.  That character may be followed by any
2705 string of digits, letters, dollar signs (unless otherwise noted in
2706 @ref{Machine Dependencies}), and underscores.
2707 @end ifclear
2708 @ifset A29K
2709 For the AMD 29K family, @samp{?} is also allowed in the
2710 body of a symbol name, though not at its beginning.
2711 @end ifset
2712
2713 @ifset SPECIAL-SYMS
2714 @ifset H8
2715 Symbol names begin with a letter or with one of @samp{._}.  On the
2716 Hitachi SH or the
2717 H8/500, you can also use @code{$} in symbol names.  That character may
2718 be followed by any string of digits, letters, dollar signs (save on the
2719 H8/300), and underscores.
2720 @end ifset
2721 @end ifset
2722
2723 Case of letters is significant: @code{foo} is a different symbol name
2724 than @code{Foo}.
2725
2726 Each symbol has exactly one name.  Each name in an assembly language program
2727 refers to exactly one symbol.  You may use that symbol name any number of times
2728 in a program.
2729
2730 @subheading Local Symbol Names
2731
2732 @cindex local symbol names
2733 @cindex symbol names, local
2734 @cindex temporary symbol names
2735 @cindex symbol names, temporary
2736 Local symbols help compilers and programmers use names temporarily.
2737 There are ten local symbol names, which are re-used throughout the
2738 program.  You may refer to them using the names @samp{0} @samp{1}
2739 @dots{} @samp{9}.  To define a local symbol, write a label of the form
2740 @samp{@b{N}:} (where @b{N} represents any digit).  To refer to the most
2741 recent previous definition of that symbol write @samp{@b{N}b}, using the
2742 same digit as when you defined the label.  To refer to the next
2743 definition of a local label, write @samp{@b{N}f}---where @b{N} gives you
2744 a choice of 10 forward references.  The @samp{b} stands for
2745 ``backwards'' and the @samp{f} stands for ``forwards''.
2746
2747 Local symbols are not emitted by the current @sc{gnu} C compiler.
2748
2749 There is no restriction on how you can use these labels, but
2750 remember that at any point in the assembly you can refer to at most
2751 10 prior local labels and to at most 10 forward local labels.
2752
2753 Local symbol names are only a notation device.  They are immediately
2754 transformed into more conventional symbol names before the assembler
2755 uses them.  The symbol names stored in the symbol table, appearing in
2756 error messages and optionally emitted to the object file have these
2757 parts:
2758
2759 @table @code
2760 @item L
2761 All local labels begin with @samp{L}. Normally both @code{@value{AS}} and
2762 @code{@value{LD}} forget symbols that start with @samp{L}. These labels are
2763 used for symbols you are never intended to see.  If you use the
2764 @samp{-L} option then @code{@value{AS}} retains these symbols in the
2765 object file. If you also instruct @code{@value{LD}} to retain these symbols,
2766 you may use them in debugging.
2767
2768 @item @var{digit}
2769 If the label is written @samp{0:} then the digit is @samp{0}.
2770 If the label is written @samp{1:} then the digit is @samp{1}.
2771 And so on up through @samp{9:}.
2772
2773 @item @kbd{C-A}
2774 This unusual character is included so you do not accidentally invent
2775 a symbol of the same name.  The character has ASCII value
2776 @samp{\001}.
2777
2778 @item @emph{ordinal number}
2779 This is a serial number to keep the labels distinct.  The first
2780 @samp{0:} gets the number @samp{1}; The 15th @samp{0:} gets the
2781 number @samp{15}; @emph{etc.}.  Likewise for the other labels @samp{1:}
2782 through @samp{9:}.
2783 @end table
2784
2785 For instance, the first @code{1:} is named @code{L1@kbd{C-A}1}, the 44th
2786 @code{3:} is named @code{L3@kbd{C-A}44}.
2787
2788 @node Dot
2789 @section The Special Dot Symbol
2790
2791 @cindex dot (symbol)
2792 @cindex @code{.} (symbol)
2793 @cindex current address
2794 @cindex location counter
2795 The special symbol @samp{.} refers to the current address that
2796 @code{@value{AS}} is assembling into.  Thus, the expression @samp{melvin:
2797 .long .} defines @code{melvin} to contain its own address.
2798 Assigning a value to @code{.} is treated the same as a @code{.org}
2799 directive.  Thus, the expression @samp{.=.+4} is the same as saying
2800 @ifclear no-space-dir
2801 @samp{.space 4}.
2802 @end ifclear
2803 @ifset no-space-dir
2804 @ifset A29K
2805 @samp{.block 4}.
2806 @end ifset
2807 @end ifset
2808
2809 @node Symbol Attributes
2810 @section Symbol Attributes
2811
2812 @cindex symbol attributes
2813 @cindex attributes, symbol
2814 Every symbol has, as well as its name, the attributes ``Value'' and
2815 ``Type''.  Depending on output format, symbols can also have auxiliary
2816 attributes.
2817 @ifset INTERNALS
2818 The detailed definitions are in @file{a.out.h}.
2819 @end ifset
2820
2821 If you use a symbol without defining it, @code{@value{AS}} assumes zero for
2822 all these attributes, and probably won't warn you.  This makes the
2823 symbol an externally defined symbol, which is generally what you
2824 would want.
2825
2826 @menu
2827 * Symbol Value::                Value
2828 * Symbol Type::                 Type
2829 @ifset aout-bout
2830 @ifset GENERIC
2831 * a.out Symbols::               Symbol Attributes: @code{a.out}
2832 @end ifset
2833 @ifclear GENERIC
2834 @ifclear BOUT
2835 * a.out Symbols::               Symbol Attributes: @code{a.out}
2836 @end ifclear
2837 @ifset BOUT
2838 * a.out Symbols::               Symbol Attributes: @code{a.out}, @code{b.out}
2839 @end ifset
2840 @end ifclear
2841 @end ifset
2842 @ifset COFF
2843 * COFF Symbols::                Symbol Attributes for COFF
2844 @end ifset
2845 @ifset SOM
2846 * SOM Symbols::                Symbol Attributes for SOM
2847 @end ifset
2848 @end menu
2849
2850 @node Symbol Value
2851 @subsection Value
2852
2853 @cindex value of a symbol
2854 @cindex symbol value
2855 The value of a symbol is (usually) 32 bits.  For a symbol which labels a
2856 location in the text, data, bss or absolute sections the value is the
2857 number of addresses from the start of that section to the label.
2858 Naturally for text, data and bss sections the value of a symbol changes
2859 as @code{@value{LD}} changes section base addresses during linking.  Absolute
2860 symbols' values do not change during linking: that is why they are
2861 called absolute.
2862
2863 The value of an undefined symbol is treated in a special way.  If it is
2864 0 then the symbol is not defined in this assembler source file, and
2865 @code{@value{LD}} tries to determine its value from other files linked into the
2866 same program.  You make this kind of symbol simply by mentioning a symbol
2867 name without defining it.  A non-zero value represents a @code{.comm}
2868 common declaration.  The value is how much common storage to reserve, in
2869 bytes (addresses).  The symbol refers to the first address of the
2870 allocated storage.
2871
2872 @node Symbol Type
2873 @subsection Type
2874
2875 @cindex type of a symbol
2876 @cindex symbol type
2877 The type attribute of a symbol contains relocation (section)
2878 information, any flag settings indicating that a symbol is external, and
2879 (optionally), other information for linkers and debuggers.  The exact
2880 format depends on the object-code output format in use.
2881
2882 @ifset aout-bout
2883 @ifclear GENERIC
2884 @ifset BOUT
2885 @c The following avoids a "widow" subsection title.  @group would be
2886 @c better if it were available outside examples.
2887 @need 1000
2888 @node a.out Symbols
2889 @subsection Symbol Attributes: @code{a.out}, @code{b.out}
2890
2891 @cindex @code{b.out} symbol attributes
2892 @cindex symbol attributes, @code{b.out}
2893 These symbol attributes appear only when @code{@value{AS}} is configured for
2894 one of the Berkeley-descended object output formats---@code{a.out} or
2895 @code{b.out}.
2896
2897 @end ifset
2898 @ifclear BOUT
2899 @node a.out Symbols
2900 @subsection Symbol Attributes: @code{a.out}
2901
2902 @cindex @code{a.out} symbol attributes
2903 @cindex symbol attributes, @code{a.out}
2904
2905 @end ifclear
2906 @end ifclear
2907 @ifset GENERIC
2908 @node a.out Symbols
2909 @subsection Symbol Attributes: @code{a.out}
2910
2911 @cindex @code{a.out} symbol attributes
2912 @cindex symbol attributes, @code{a.out}
2913
2914 @end ifset
2915 @menu
2916 * Symbol Desc::                 Descriptor
2917 * Symbol Other::                Other
2918 @end menu
2919
2920 @node Symbol Desc
2921 @subsubsection Descriptor
2922
2923 @cindex descriptor, of @code{a.out} symbol
2924 This is an arbitrary 16-bit value.  You may establish a symbol's
2925 descriptor value by using a @code{.desc} statement
2926 (@pxref{Desc,,@code{.desc}}).  A descriptor value means nothing to
2927 @code{@value{AS}}.
2928
2929 @node Symbol Other
2930 @subsubsection Other
2931
2932 @cindex other attribute, of @code{a.out} symbol
2933 This is an arbitrary 8-bit value.  It means nothing to @code{@value{AS}}.
2934 @end ifset
2935
2936 @ifset COFF
2937 @node COFF Symbols
2938 @subsection Symbol Attributes for COFF
2939
2940 @cindex COFF symbol attributes
2941 @cindex symbol attributes, COFF
2942
2943 The COFF format supports a multitude of auxiliary symbol attributes;
2944 like the primary symbol attributes, they are set between @code{.def} and
2945 @code{.endef} directives.
2946
2947 @subsubsection Primary Attributes
2948
2949 @cindex primary attributes, COFF symbols
2950 The symbol name is set with @code{.def}; the value and type,
2951 respectively, with @code{.val} and @code{.type}.
2952
2953 @subsubsection Auxiliary Attributes
2954
2955 @cindex auxiliary attributes, COFF symbols
2956 The @code{@value{AS}} directives @code{.dim}, @code{.line}, @code{.scl},
2957 @code{.size}, and @code{.tag} can generate auxiliary symbol table
2958 information for COFF.
2959 @end ifset
2960
2961 @ifset SOM
2962 @node SOM Symbols
2963 @subsection Symbol Attributes for SOM
2964
2965 @cindex SOM symbol attributes
2966 @cindex symbol attributes, SOM
2967
2968 The SOM format for the HPPA supports a multitude of symbol attributes set with
2969 the @code{.EXPORT} and @code{.IMPORT} directives.
2970
2971 The attributes are described in @cite{HP9000 Series 800 Assembly 
2972 Language Reference Manual} (HP 92432-90001) under the @code{IMPORT} and
2973 @code{EXPORT} assembler directive documentation.
2974 @end ifset
2975
2976 @node Expressions
2977 @chapter Expressions
2978
2979 @cindex expressions
2980 @cindex addresses
2981 @cindex numeric values
2982 An @dfn{expression} specifies an address or numeric value.
2983 Whitespace may precede and/or follow an expression.
2984
2985 The result of an expression must be an absolute number, or else an offset into
2986 a particular section.  If an expression is not absolute, and there is not
2987 enough information when @code{@value{AS}} sees the expression to know its
2988 section, a second pass over the source program might be necessary to interpret
2989 the expression---but the second pass is currently not implemented.
2990 @code{@value{AS}} aborts with an error message in this situation.
2991
2992 @menu
2993 * Empty Exprs::                 Empty Expressions
2994 * Integer Exprs::               Integer Expressions
2995 @end menu
2996
2997 @node Empty Exprs
2998 @section Empty Expressions
2999
3000 @cindex empty expressions
3001 @cindex expressions, empty
3002 An empty expression has no value: it is just whitespace or null.
3003 Wherever an absolute expression is required, you may omit the
3004 expression, and @code{@value{AS}} assumes a value of (absolute) 0.  This
3005 is compatible with other assemblers.
3006
3007 @node Integer Exprs
3008 @section Integer Expressions
3009
3010 @cindex integer expressions
3011 @cindex expressions, integer
3012 An @dfn{integer expression} is one or more @emph{arguments} delimited
3013 by @emph{operators}.
3014
3015 @menu
3016 * Arguments::                   Arguments
3017 * Operators::                   Operators
3018 * Prefix Ops::                  Prefix Operators
3019 * Infix Ops::                   Infix Operators
3020 @end menu
3021
3022 @node Arguments
3023 @subsection Arguments
3024
3025 @cindex expression arguments
3026 @cindex arguments in expressions
3027 @cindex operands in expressions
3028 @cindex arithmetic operands
3029 @dfn{Arguments} are symbols, numbers or subexpressions.  In other
3030 contexts arguments are sometimes called ``arithmetic operands''.  In
3031 this manual, to avoid confusing them with the ``instruction operands'' of
3032 the machine language, we use the term ``argument'' to refer to parts of
3033 expressions only, reserving the word ``operand'' to refer only to machine
3034 instruction operands.
3035
3036 Symbols are evaluated to yield @{@var{section} @var{NNN}@} where
3037 @var{section} is one of text, data, bss, absolute,
3038 or undefined.  @var{NNN} is a signed, 2's complement 32 bit
3039 integer.
3040
3041 Numbers are usually integers.
3042
3043 A number can be a flonum or bignum.  In this case, you are warned
3044 that only the low order 32 bits are used, and @code{@value{AS}} pretends
3045 these 32 bits are an integer.  You may write integer-manipulating
3046 instructions that act on exotic constants, compatible with other
3047 assemblers.
3048
3049 @cindex subexpressions
3050 Subexpressions are a left parenthesis @samp{(} followed by an integer
3051 expression, followed by a right parenthesis @samp{)}; or a prefix
3052 operator followed by an argument.
3053
3054 @node Operators
3055 @subsection Operators
3056
3057 @cindex operators, in expressions
3058 @cindex arithmetic functions
3059 @cindex functions, in expressions
3060 @dfn{Operators} are arithmetic functions, like @code{+} or @code{%}.  Prefix
3061 operators are followed by an argument.  Infix operators appear
3062 between their arguments.  Operators may be preceded and/or followed by
3063 whitespace.
3064
3065 @node Prefix Ops
3066 @subsection Prefix Operator
3067
3068 @cindex prefix operators
3069 @code{@value{AS}} has the following @dfn{prefix operators}.  They each take
3070 one argument, which must be absolute.
3071
3072 @c the tex/end tex stuff surrounding this small table is meant to make
3073 @c it align, on the printed page, with the similar table in the next
3074 @c section (which is inside an enumerate).
3075 @tex
3076 \global\advance\leftskip by \itemindent
3077 @end tex
3078
3079 @table @code
3080 @item -
3081 @dfn{Negation}.  Two's complement negation.
3082 @item ~
3083 @dfn{Complementation}.  Bitwise not.
3084 @end table
3085
3086 @tex
3087 \global\advance\leftskip by -\itemindent
3088 @end tex
3089
3090 @node Infix Ops
3091 @subsection Infix Operators
3092
3093 @cindex infix operators
3094 @cindex operators, permitted arguments
3095 @dfn{Infix operators} take two arguments, one on either side.  Operators
3096 have precedence, but operations with equal precedence are performed left
3097 to right.  Apart from @code{+} or @code{-}, both arguments must be
3098 absolute, and the result is absolute.
3099
3100 @enumerate
3101 @cindex operator precedence
3102 @cindex precedence of operators
3103
3104 @item
3105 Highest Precedence
3106
3107 @table @code
3108 @item *
3109 @dfn{Multiplication}.
3110
3111 @item /
3112 @dfn{Division}.  Truncation is the same as the C operator @samp{/}
3113
3114 @item %
3115 @dfn{Remainder}.
3116
3117 @item <
3118 @itemx <<
3119 @dfn{Shift Left}.  Same as the C operator @samp{<<}.
3120
3121 @item >
3122 @itemx >>
3123 @dfn{Shift Right}.  Same as the C operator @samp{>>}.
3124 @end table
3125
3126 @item
3127 Intermediate precedence
3128
3129 @table @code
3130 @item |
3131
3132 @dfn{Bitwise Inclusive Or}.
3133
3134 @item &
3135 @dfn{Bitwise And}.
3136
3137 @item ^
3138 @dfn{Bitwise Exclusive Or}.
3139
3140 @item !
3141 @dfn{Bitwise Or Not}.
3142 @end table
3143
3144 @item
3145 Lowest Precedence
3146
3147 @table @code
3148 @cindex addition, permitted arguments
3149 @cindex plus, permitted arguments
3150 @cindex arguments for addition
3151 @item +
3152 @dfn{Addition}.  If either argument is absolute, the result has the section of
3153 the other argument.  You may not add together arguments from different
3154 sections.
3155
3156 @cindex subtraction, permitted arguments
3157 @cindex minus, permitted arguments
3158 @cindex arguments for subtraction
3159 @item -
3160 @dfn{Subtraction}.  If the right argument is absolute, the
3161 result has the section of the left argument.
3162 If both arguments are in the same section, the result is absolute.
3163 You may not subtract arguments from different sections.
3164 @c FIXME is there still something useful to say about undefined - undefined ?
3165 @end table
3166 @end enumerate
3167
3168 In short, it's only meaningful to add or subtract the @emph{offsets} in an
3169 address; you can only have a defined section in one of the two arguments.
3170
3171 @node Pseudo Ops
3172 @chapter Assembler Directives
3173
3174 @cindex directives, machine independent
3175 @cindex pseudo-ops, machine independent
3176 @cindex machine independent directives
3177 All assembler directives have names that begin with a period (@samp{.}).
3178 The rest of the name is letters, usually in lower case.
3179
3180 This chapter discusses directives that are available regardless of the
3181 target machine configuration for the @sc{gnu} assembler.
3182 @ifset GENERIC
3183 Some machine configurations provide additional directives.
3184 @xref{Machine Dependencies}.
3185 @end ifset
3186 @ifclear GENERIC
3187 @ifset machine-directives
3188 @xref{Machine Dependencies} for additional directives.
3189 @end ifset
3190 @end ifclear
3191
3192 @menu
3193 * Abort::                       @code{.abort}
3194 @ifset COFF
3195 * ABORT::                       @code{.ABORT}
3196 @end ifset
3197
3198 * Align::                       @code{.align @var{abs-expr} , @var{abs-expr}}
3199 * Ascii::                       @code{.ascii "@var{string}"}@dots{}
3200 * Asciz::                       @code{.asciz "@var{string}"}@dots{}
3201 * Balign::                      @code{.balign @var{abs-expr} , @var{abs-expr}}
3202 * Byte::                        @code{.byte @var{expressions}}
3203 * Comm::                        @code{.comm @var{symbol} , @var{length} }
3204 * Data::                        @code{.data @var{subsection}}
3205 @ifset COFF
3206 * Def::                         @code{.def @var{name}}
3207 @end ifset
3208 @ifset aout-bout
3209 * Desc::                        @code{.desc @var{symbol}, @var{abs-expression}}
3210 @end ifset
3211 @ifset COFF
3212 * Dim::                         @code{.dim}
3213 @end ifset
3214
3215 * Double::                      @code{.double @var{flonums}}
3216 * Eject::                       @code{.eject}
3217 * Else::                        @code{.else}
3218 * Elseif::                      @code{.elseif}
3219 * End::                         @code{.end}
3220 @ifset COFF
3221 * Endef::                       @code{.endef}
3222 @end ifset
3223
3224 * Endfunc::                     @code{.endfunc}
3225 * Endif::                       @code{.endif}
3226 * Equ::                         @code{.equ @var{symbol}, @var{expression}}
3227 * Equiv::                       @code{.equiv @var{symbol}, @var{expression}}
3228 * Err::                         @code{.err}
3229 * Exitm::                       @code{.exitm}
3230 * Extern::                      @code{.extern}
3231 * Fail::                        @code{.fail}
3232 @ifclear no-file-dir
3233 * File::                        @code{.file @var{string}}
3234 @end ifclear
3235
3236 * Fill::                        @code{.fill @var{repeat} , @var{size} , @var{value}}
3237 * Float::                       @code{.float @var{flonums}}
3238 * Func::                        @code{.func}  
3239 * Global::                      @code{.global @var{symbol}}, @code{.globl @var{symbol}}
3240 @ifset ELF
3241 * Hidden::                      @code{.hidden @var{names}}
3242 @end ifset
3243
3244 * hword::                       @code{.hword @var{expressions}}
3245 * Ident::                       @code{.ident}
3246 * If::                          @code{.if @var{absolute expression}}
3247 * Include::                     @code{.include "@var{file}"}
3248 * Int::                         @code{.int @var{expressions}}
3249 @ifset ELF
3250 * Internal::                    @code{.internal @var{names}}
3251 @end ifset
3252
3253 * Irp::                         @code{.irp @var{symbol},@var{values}}@dots{}
3254 * Irpc::                        @code{.irpc @var{symbol},@var{values}}@dots{}
3255 * Lcomm::                       @code{.lcomm @var{symbol} , @var{length}}
3256 * Lflags::                      @code{.lflags}
3257 @ifclear no-line-dir
3258 * Line::                        @code{.line @var{line-number}}
3259 @end ifclear
3260
3261 * Ln::                          @code{.ln @var{line-number}}
3262 * Linkonce::                    @code{.linkonce [@var{type}]}
3263 * List::                        @code{.list}
3264 * Long::                        @code{.long @var{expressions}}
3265 @ignore
3266 * Lsym::                        @code{.lsym @var{symbol}, @var{expression}}
3267 @end ignore
3268
3269 * Macro::                       @code{.macro @var{name} @var{args}}@dots{}
3270 * MRI::                         @code{.mri @var{val}}
3271 * Nolist::                      @code{.nolist}
3272 * Octa::                        @code{.octa @var{bignums}}
3273 * Org::                         @code{.org @var{new-lc} , @var{fill}}
3274 * P2align::                     @code{.p2align @var{abs-expr} , @var{abs-expr}}
3275 @ifset ELF
3276 * PopSection::                  @code{.popsection}
3277 * Previous::                    @code{.previous}
3278 @end ifset
3279
3280 * Print::                       @code{.print @var{string}}
3281 @ifset ELF
3282 * Protected::                   @code{.protected @var{names}}
3283 @end ifset
3284
3285 * Psize::                       @code{.psize @var{lines}, @var{columns}}
3286 * Purgem::                      @code{.purgem @var{name}}
3287 @ifset ELF
3288 * PushSection::                 @code{.pushsection @var{name}}
3289 @end ifset
3290
3291 * Quad::                        @code{.quad @var{bignums}}
3292 * Rept::                        @code{.rept @var{count}}
3293 * Sbttl::                       @code{.sbttl "@var{subheading}"}
3294 @ifset COFF
3295 * Scl::                         @code{.scl @var{class}}
3296 * Section::                     @code{.section @var{name}, @var{subsection}}
3297 @end ifset
3298
3299 * Set::                         @code{.set @var{symbol}, @var{expression}}
3300 * Short::                       @code{.short @var{expressions}}
3301 * Single::                      @code{.single @var{flonums}}
3302 * Size::                        @code{.size [@var{name} , @var{expression}]}
3303 * Skip::                        @code{.skip @var{size} , @var{fill}}
3304 * Sleb128::                     @code{.sleb128 @var{expressions}}
3305 * Space::                       @code{.space @var{size} , @var{fill}}
3306 @ifset have-stabs
3307 * Stab::                        @code{.stabd, .stabn, .stabs}
3308 @end ifset
3309
3310 * String::                      @code{.string "@var{str}"}
3311 * Struct::                      @code{.struct @var{expression}}
3312 @ifset ELF
3313 * SubSection::                  @code{.subsection}
3314 * Symver::                      @code{.symver @var{name},@var{name2@@nodename}}
3315 @end ifset
3316
3317 @ifset COFF
3318 * Tag::                         @code{.tag @var{structname}}
3319 @end ifset
3320
3321 * Text::                        @code{.text @var{subsection}}
3322 * Title::                       @code{.title "@var{heading}"}
3323 * Type::                        @code{.type <@var{int} | @var{name} , @var{type description}>}
3324 * Uleb128::                     @code{.uleb128 @var{expressions}}
3325 @ifset COFF
3326 * Val::                         @code{.val @var{addr}}
3327 @end ifset
3328
3329 @ifset ELF
3330 * Version::                     @code{.version "@var{string}"}
3331 * VTableEntry::                 @code{.vtable_entry @var{table}, @var{offset}}
3332 * VTableInherit::               @code{.vtable_inherit @var{child}, @var{parent}}
3333 * Weak::                        @code{.weak @var{names}}
3334 @end ifset
3335
3336 * Word::                        @code{.word @var{expressions}}
3337 * Deprecated::                  Deprecated Directives
3338 @end menu
3339
3340 @node Abort
3341 @section @code{.abort}
3342
3343 @cindex @code{abort} directive
3344 @cindex stopping the assembly
3345 This directive stops the assembly immediately.  It is for
3346 compatibility with other assemblers.  The original idea was that the
3347 assembly language source would be piped into the assembler.  If the sender
3348 of the source quit, it could use this directive tells @code{@value{AS}} to
3349 quit also.  One day @code{.abort} will not be supported.
3350
3351 @ifset COFF
3352 @node ABORT
3353 @section @code{.ABORT}
3354
3355 @cindex @code{ABORT} directive
3356 When producing COFF output, @code{@value{AS}} accepts this directive as a
3357 synonym for @samp{.abort}.
3358
3359 @ifset BOUT
3360 When producing @code{b.out} output, @code{@value{AS}} accepts this directive,
3361 but ignores it.
3362 @end ifset
3363 @end ifset
3364
3365 @node Align
3366 @section @code{.align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
3367
3368 @cindex padding the location counter
3369 @cindex @code{align} directive
3370 Pad the location counter (in the current subsection) to a particular storage
3371 boundary.  The first expression (which must be absolute) is the alignment
3372 required, as described below.
3373
3374 The second expression (also absolute) gives the fill value to be stored in the
3375 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
3376 padding bytes are normally zero.  However, on some systems, if the section is
3377 marked as containing code and the fill value is omitted, the space is filled
3378 with no-op instructions.
3379
3380 The third expression is also absolute, and is also optional.  If it is present,
3381 it is the maximum number of bytes that should be skipped by this alignment
3382 directive.  If doing the alignment would require skipping more bytes than the
3383 specified maximum, then the alignment is not done at all.  You can omit the
3384 fill value (the second argument) entirely by simply using two commas after the
3385 required alignment; this can be useful if you want the alignment to be filled
3386 with no-op instructions when appropriate.
3387
3388 The way the required alignment is specified varies from system to system.
3389 For the a29k, hppa, m68k, m88k, w65, sparc, and Hitachi SH, and i386 using ELF
3390 format,
3391 the first expression is the
3392 alignment request in bytes.  For example @samp{.align 8} advances
3393 the location counter until it is a multiple of 8.  If the location counter
3394 is already a multiple of 8, no change is needed.
3395
3396 For other systems, including the i386 using a.out format, and the arm and
3397 strongarm, it is the
3398 number of low-order zero bits the location counter must have after
3399 advancement.  For example @samp{.align 3} advances the location
3400 counter until it a multiple of 8.  If the location counter is already a
3401 multiple of 8, no change is needed.
3402
3403 This inconsistency is due to the different behaviors of the various
3404 native assemblers for these systems which GAS must emulate.
3405 GAS also provides @code{.balign} and @code{.p2align} directives,
3406 described later, which have a consistent behavior across all
3407 architectures (but are specific to GAS).
3408
3409 @node Ascii
3410 @section @code{.ascii "@var{string}"}@dots{}
3411
3412 @cindex @code{ascii} directive
3413 @cindex string literals
3414 @code{.ascii} expects zero or more string literals (@pxref{Strings})
3415 separated by commas.  It assembles each string (with no automatic
3416 trailing zero byte) into consecutive addresses.
3417
3418 @node Asciz
3419 @section @code{.asciz "@var{string}"}@dots{}
3420
3421 @cindex @code{asciz} directive
3422 @cindex zero-terminated strings
3423 @cindex null-terminated strings
3424 @code{.asciz} is just like @code{.ascii}, but each string is followed by
3425 a zero byte.  The ``z'' in @samp{.asciz} stands for ``zero''.
3426
3427 @node Balign
3428 @section @code{.balign[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
3429
3430 @cindex padding the location counter given number of bytes
3431 @cindex @code{balign} directive
3432 Pad the location counter (in the current subsection) to a particular
3433 storage boundary.  The first expression (which must be absolute) is the
3434 alignment request in bytes.  For example @samp{.balign 8} advances
3435 the location counter until it is a multiple of 8.  If the location counter
3436 is already a multiple of 8, no change is needed.
3437
3438 The second expression (also absolute) gives the fill value to be stored in the
3439 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
3440 padding bytes are normally zero.  However, on some systems, if the section is
3441 marked as containing code and the fill value is omitted, the space is filled
3442 with no-op instructions.
3443
3444 The third expression is also absolute, and is also optional.  If it is present,
3445 it is the maximum number of bytes that should be skipped by this alignment
3446 directive.  If doing the alignment would require skipping more bytes than the
3447 specified maximum, then the alignment is not done at all.  You can omit the
3448 fill value (the second argument) entirely by simply using two commas after the
3449 required alignment; this can be useful if you want the alignment to be filled
3450 with no-op instructions when appropriate.
3451
3452 @cindex @code{balignw} directive
3453 @cindex @code{balignl} directive
3454 The @code{.balignw} and @code{.balignl} directives are variants of the
3455 @code{.balign} directive.  The @code{.balignw} directive treats the fill
3456 pattern as a two byte word value.  The @code{.balignl} directives treats the
3457 fill pattern as a four byte longword value.  For example, @code{.balignw
3458 4,0x368d} will align to a multiple of 4.  If it skips two bytes, they will be
3459 filled in with the value 0x368d (the exact placement of the bytes depends upon
3460 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
3461 undefined.
3462
3463 @node Byte
3464 @section @code{.byte @var{expressions}}
3465
3466 @cindex @code{byte} directive
3467 @cindex integers, one byte
3468 @code{.byte} expects zero or more expressions, separated by commas.
3469 Each expression is assembled into the next byte.
3470
3471 @node Comm
3472 @section @code{.comm @var{symbol} , @var{length} }
3473
3474 @cindex @code{comm} directive
3475 @cindex symbol, common
3476 @code{.comm} declares a common symbol named @var{symbol}.  When linking, a
3477 common symbol in one object file may be merged with a defined or common symbol
3478 of the same name in another object file.  If @code{@value{LD}} does not see a
3479 definition for the symbol--just one or more common symbols--then it will
3480 allocate @var{length} bytes of uninitialized memory.  @var{length} must be an
3481 absolute expression.  If @code{@value{LD}} sees multiple common symbols with
3482 the same name, and they do not all have the same size, it will allocate space
3483 using the largest size.
3484
3485 @ifset ELF
3486 When using ELF, the @code{.comm} directive takes an optional third argument.
3487 This is the desired alignment of the symbol, specified as a byte boundary (for
3488 example, an alignment of 16 means that the least significant 4 bits of the
3489 address should be zero).  The alignment must be an absolute expression, and it
3490 must be a power of two.  If @code{@value{LD}} allocates uninitialized memory
3491 for the common symbol, it will use the alignment when placing the symbol.  If
3492 no alignment is specified, @code{@value{AS}} will set the alignment to the
3493 largest power of two less than or equal to the size of the symbol, up to a
3494 maximum of 16.
3495 @end ifset
3496
3497 @ifset HPPA
3498 The syntax for @code{.comm} differs slightly on the HPPA.  The syntax is
3499 @samp{@var{symbol} .comm, @var{length}}; @var{symbol} is optional.
3500 @end ifset
3501
3502 @node Data
3503 @section @code{.data @var{subsection}}
3504
3505 @cindex @code{data} directive
3506 @code{.data} tells @code{@value{AS}} to assemble the following statements onto the
3507 end of the data subsection numbered @var{subsection} (which is an
3508 absolute expression).  If @var{subsection} is omitted, it defaults
3509 to zero.
3510
3511 @ifset COFF
3512 @node Def
3513 @section @code{.def @var{name}}
3514
3515 @cindex @code{def} directive
3516 @cindex COFF symbols, debugging
3517 @cindex debugging COFF symbols
3518 Begin defining debugging information for a symbol @var{name}; the
3519 definition extends until the @code{.endef} directive is encountered.
3520 @ifset BOUT
3521
3522 This directive is only observed when @code{@value{AS}} is configured for COFF
3523 format output; when producing @code{b.out}, @samp{.def} is recognized,
3524 but ignored.
3525 @end ifset
3526 @end ifset
3527
3528 @ifset aout-bout
3529 @node Desc
3530 @section @code{.desc @var{symbol}, @var{abs-expression}}
3531
3532 @cindex @code{desc} directive
3533 @cindex COFF symbol descriptor
3534 @cindex symbol descriptor, COFF
3535 This directive sets the descriptor of the symbol (@pxref{Symbol Attributes})
3536 to the low 16 bits of an absolute expression.
3537
3538 @ifset COFF
3539 The @samp{.desc} directive is not available when @code{@value{AS}} is
3540 configured for COFF output; it is only for @code{a.out} or @code{b.out}
3541 object format.  For the sake of compatibility, @code{@value{AS}} accepts
3542 it, but produces no output, when configured for COFF.
3543 @end ifset
3544 @end ifset
3545
3546 @ifset COFF
3547 @node Dim
3548 @section @code{.dim}
3549
3550 @cindex @code{dim} directive
3551 @cindex COFF auxiliary symbol information
3552 @cindex auxiliary symbol information, COFF
3553 This directive is generated by compilers to include auxiliary debugging
3554 information in the symbol table.  It is only permitted inside
3555 @code{.def}/@code{.endef} pairs.
3556 @ifset BOUT
3557
3558 @samp{.dim} is only meaningful when generating COFF format output; when
3559 @code{@value{AS}} is generating @code{b.out}, it accepts this directive but
3560 ignores it.
3561 @end ifset
3562 @end ifset
3563
3564 @node Double
3565 @section @code{.double @var{flonums}}
3566
3567 @cindex @code{double} directive
3568 @cindex floating point numbers (double)
3569 @code{.double} expects zero or more flonums, separated by commas.  It
3570 assembles floating point numbers.
3571 @ifset GENERIC
3572 The exact kind of floating point numbers emitted depends on how
3573 @code{@value{AS}} is configured.  @xref{Machine Dependencies}.
3574 @end ifset
3575 @ifclear GENERIC
3576 @ifset IEEEFLOAT
3577 On the @value{TARGET} family @samp{.double} emits 64-bit floating-point numbers
3578 in @sc{ieee} format.
3579 @end ifset
3580 @end ifclear
3581
3582 @node Eject
3583 @section @code{.eject}
3584
3585 @cindex @code{eject} directive
3586 @cindex new page, in listings
3587 @cindex page, in listings
3588 @cindex listing control: new page
3589 Force a page break at this point, when generating assembly listings.
3590
3591 @node Else
3592 @section @code{.else}
3593
3594 @cindex @code{else} directive
3595 @code{.else} is part of the @code{@value{AS}} support for conditional
3596 assembly; @pxref{If,,@code{.if}}.  It marks the beginning of a section
3597 of code to be assembled if the condition for the preceding @code{.if}
3598 was false.
3599
3600 @node Elseif
3601 @section @code{.elseif}
3602
3603 @cindex @code{elseif} directive
3604 @code{.elseif} is part of the @code{@value{AS}} support for conditional
3605 assembly; @pxref{If,,@code{.if}}.  It is shorthand for beginning a new
3606 @code{.if} block that would otherwise fill the entire @code{.else} section.
3607
3608 @node End
3609 @section @code{.end}
3610
3611 @cindex @code{end} directive
3612 @code{.end} marks the end of the assembly file.  @code{@value{AS}} does not
3613 process anything in the file past the @code{.end} directive.
3614
3615 @ifset COFF
3616 @node Endef
3617 @section @code{.endef}
3618
3619 @cindex @code{endef} directive
3620 This directive flags the end of a symbol definition begun with
3621 @code{.def}.
3622 @ifset BOUT
3623
3624 @samp{.endef} is only meaningful when generating COFF format output; if
3625 @code{@value{AS}} is configured to generate @code{b.out}, it accepts this
3626 directive but ignores it.
3627 @end ifset
3628 @end ifset
3629
3630 @node Endfunc
3631 @section @code{.endfunc}
3632 @cindex @code{endfunc} directive
3633 @code{.endfunc} marks the end of a function specified with @code{.func}.
3634
3635 @node Endif
3636 @section @code{.endif}
3637
3638 @cindex @code{endif} directive
3639 @code{.endif} is part of the @code{@value{AS}} support for conditional assembly;
3640 it marks the end of a block of code that is only assembled
3641 conditionally.  @xref{If,,@code{.if}}.
3642
3643 @node Equ
3644 @section @code{.equ @var{symbol}, @var{expression}}
3645
3646 @cindex @code{equ} directive
3647 @cindex assigning values to symbols
3648 @cindex symbols, assigning values to
3649 This directive sets the value of @var{symbol} to @var{expression}.
3650 It is synonymous with @samp{.set}; @pxref{Set,,@code{.set}}.
3651
3652 @ifset HPPA
3653 The syntax for @code{equ} on the HPPA is 
3654 @samp{@var{symbol} .equ @var{expression}}.
3655 @end ifset
3656
3657 @node Equiv
3658 @section @code{.equiv @var{symbol}, @var{expression}}
3659 @cindex @code{equiv} directive
3660 The @code{.equiv} directive is like @code{.equ} and @code{.set}, except that
3661 the assembler will signal an error if @var{symbol} is already defined.
3662
3663 Except for the contents of the error message, this is roughly equivalent to 
3664 @smallexample
3665 .ifdef SYM
3666 .err
3667 .endif
3668 .equ SYM,VAL
3669 @end smallexample
3670
3671 @node Err
3672 @section @code{.err}
3673 @cindex @code{err} directive
3674 If @code{@value{AS}} assembles a @code{.err} directive, it will print an error
3675 message and, unless the @code{-Z} option was used, it will not generate an
3676 object file.  This can be used to signal error an conditionally compiled code.
3677
3678 @node Exitm
3679 @section @code{.exitm}
3680 Exit early from the current macro definition.  @xref{Macro}.
3681
3682 @node Extern
3683 @section @code{.extern}
3684
3685 @cindex @code{extern} directive
3686 @code{.extern} is accepted in the source program---for compatibility
3687 with other assemblers---but it is ignored.  @code{@value{AS}} treats
3688 all undefined symbols as external.
3689
3690 @node Fail
3691 @section @code{.fail @var{expression}}
3692
3693 @cindex @code{fail} directive
3694 Generates an error or a warning.  If the value of the @var{expression} is 500
3695 or more, @code{@value{AS}} will print a warning message.  If the value is less
3696 than 500, @code{@value{AS}} will print an error message.  The message will
3697 include the value of @var{expression}.  This can occasionally be useful inside
3698 complex nested macros or conditional assembly.
3699
3700 @ifclear no-file-dir
3701 @node File
3702 @section @code{.file @var{string}}
3703
3704 @cindex @code{file} directive
3705 @cindex logical file name
3706 @cindex file name, logical
3707 @code{.file} tells @code{@value{AS}} that we are about to start a new logical
3708 file.  @var{string} is the new file name.  In general, the filename is
3709 recognized whether or not it is surrounded by quotes @samp{"}; but if you wish
3710 to specify an empty file name, you must give the quotes--@code{""}.  This
3711 statement may go away in future: it is only recognized to be compatible with
3712 old @code{@value{AS}} programs.
3713 @ifset A29K
3714 In some configurations of @code{@value{AS}}, @code{.file} has already been
3715 removed to avoid conflicts with other assemblers.  @xref{Machine Dependencies}.
3716 @end ifset
3717 @end ifclear
3718
3719 @node Fill
3720 @section @code{.fill @var{repeat} , @var{size} , @var{value}}
3721
3722 @cindex @code{fill} directive
3723 @cindex writing patterns in memory
3724 @cindex patterns, writing in memory
3725 @var{result}, @var{size} and @var{value} are absolute expressions.
3726 This emits @var{repeat} copies of @var{size} bytes.  @var{Repeat}
3727 may be zero or more.  @var{Size} may be zero or more, but if it is
3728 more than 8, then it is deemed to have the value 8, compatible with
3729 other people's assemblers.  The contents of each @var{repeat} bytes
3730 is taken from an 8-byte number.  The highest order 4 bytes are
3731 zero.  The lowest order 4 bytes are @var{value} rendered in the
3732 byte-order of an integer on the computer @code{@value{AS}} is assembling for.
3733 Each @var{size} bytes in a repetition is taken from the lowest order
3734 @var{size} bytes of this number.  Again, this bizarre behavior is
3735 compatible with other people's assemblers.
3736
3737 @var{size} and @var{value} are optional.
3738 If the second comma and @var{value} are absent, @var{value} is
3739 assumed zero.  If the first comma and following tokens are absent,
3740 @var{size} is assumed to be 1.
3741
3742 @node Float
3743 @section @code{.float @var{flonums}}
3744
3745 @cindex floating point numbers (single)
3746 @cindex @code{float} directive
3747 This directive assembles zero or more flonums, separated by commas.  It
3748 has the same effect as @code{.single}.
3749 @ifset GENERIC
3750 The exact kind of floating point numbers emitted depends on how
3751 @code{@value{AS}} is configured.
3752 @xref{Machine Dependencies}.
3753 @end ifset
3754 @ifclear GENERIC
3755 @ifset IEEEFLOAT
3756 On the @value{TARGET} family, @code{.float} emits 32-bit floating point numbers
3757 in @sc{ieee} format.
3758 @end ifset
3759 @end ifclear
3760
3761 @node Func
3762 @section @code{.func @var{name}[,@var{label}]}
3763 @cindex @code{func} directive
3764 @code{.func} emits debugging information to denote function @var{name}, and
3765 is ignored unless the file is assembled with debugging enabled.
3766 Only @samp{--gstabs} is currently supported.
3767 @var{label} is the entry point of the function and if omitted @var{name}
3768 prepended with the @samp{leading char} is used.
3769 @samp{leading char} is usually @code{_} or nothing, depending on the target.
3770 All functions are currently defined to have @code{void} return type.
3771 The function must be terminated with @code{.endfunc}.
3772
3773 @node Global
3774 @section @code{.global @var{symbol}}, @code{.globl @var{symbol}}
3775
3776 @cindex @code{global} directive
3777 @cindex symbol, making visible to linker
3778 @code{.global} makes the symbol visible to @code{@value{LD}}.  If you define
3779 @var{symbol} in your partial program, its value is made available to
3780 other partial programs that are linked with it.  Otherwise,
3781 @var{symbol} takes its attributes from a symbol of the same name
3782 from another file linked into the same program.
3783
3784 Both spellings (@samp{.globl} and @samp{.global}) are accepted, for
3785 compatibility with other assemblers.
3786
3787 @ifset HPPA
3788 On the HPPA, @code{.global} is not always enough to make it accessible to other
3789 partial programs.  You may need the HPPA-only @code{.EXPORT} directive as well.
3790 @xref{HPPA Directives,, HPPA Assembler Directives}.
3791 @end ifset
3792
3793 @ifset ELF
3794 @node Hidden
3795 @section @code{.hidden @var{names}}
3796
3797 @cindex @code{.hidden} directive
3798 @cindex Visibility
3799 This one of the ELF visibility directives.  The other two are
3800 @pxref{Internal,,@code{.internal}} and @pxref{Protected,,@code{.protected}}
3801
3802 This directive overrides the named symbols default visibility (which is set by
3803 their binding: local, global or weak).  The directive sets the visibility to
3804 @code{hidden} which means that the symbols are not visible to other components.
3805 Such symbols are always considered to be @code{protected} as well. 
3806 @end ifset
3807
3808 @node hword
3809 @section @code{.hword @var{expressions}}
3810
3811 @cindex @code{hword} directive
3812 @cindex integers, 16-bit
3813 @cindex numbers, 16-bit
3814 @cindex sixteen bit integers
3815 This expects zero or more @var{expressions}, and emits
3816 a 16 bit number for each.
3817
3818 @ifset GENERIC
3819 This directive is a synonym for @samp{.short}; depending on the target
3820 architecture, it may also be a synonym for @samp{.word}.
3821 @end ifset
3822 @ifclear GENERIC
3823 @ifset W32
3824 This directive is a synonym for @samp{.short}.
3825 @end ifset
3826 @ifset W16
3827 This directive is a synonym for both @samp{.short} and @samp{.word}.
3828 @end ifset
3829 @end ifclear
3830
3831 @node Ident
3832 @section @code{.ident}
3833
3834 @cindex @code{ident} directive
3835 This directive is used by some assemblers to place tags in object files.
3836 @code{@value{AS}} simply accepts the directive for source-file
3837 compatibility with such assemblers, but does not actually emit anything
3838 for it.
3839
3840 @node If
3841 @section @code{.if @var{absolute expression}}
3842
3843 @cindex conditional assembly
3844 @cindex @code{if} directive
3845 @code{.if} marks the beginning of a section of code which is only
3846 considered part of the source program being assembled if the argument
3847 (which must be an @var{absolute expression}) is non-zero.  The end of
3848 the conditional section of code must be marked by @code{.endif}
3849 (@pxref{Endif,,@code{.endif}}); optionally, you may include code for the
3850 alternative condition, flagged by @code{.else} (@pxref{Else,,@code{.else}}).
3851 If you have several conditions to check, @code{.elseif} may be used to avoid
3852 nesting blocks if/else within each subsequent @code{.else} block.
3853
3854 The following variants of @code{.if} are also supported:
3855 @table @code
3856 @cindex @code{ifdef} directive
3857 @item .ifdef @var{symbol}
3858 Assembles the following section of code if the specified @var{symbol}
3859 has been defined.
3860
3861 @cindex @code{ifc} directive
3862 @item .ifc @var{string1},@var{string2}
3863 Assembles the following section of code if the two strings are the same.  The
3864 strings may be optionally quoted with single quotes.  If they are not quoted,
3865 the first string stops at the first comma, and the second string stops at the
3866 end of the line.  Strings which contain whitespace should be quoted.  The
3867 string comparison is case sensitive.
3868
3869 @cindex @code{ifeq} directive
3870 @item .ifeq @var{absolute expression}
3871 Assembles the following section of code if the argument is zero.
3872
3873 @cindex @code{ifeqs} directive
3874 @item .ifeqs @var{string1},@var{string2}
3875 Another form of @code{.ifc}.  The strings must be quoted using double quotes.
3876
3877 @cindex @code{ifge} directive
3878 @item .ifge @var{absolute expression}
3879 Assembles the following section of code if the argument is greater than or
3880 equal to zero.
3881
3882 @cindex @code{ifgt} directive
3883 @item .ifgt @var{absolute expression}
3884 Assembles the following section of code if the argument is greater than zero.
3885
3886 @cindex @code{ifle} directive
3887 @item .ifle @var{absolute expression}
3888 Assembles the following section of code if the argument is less than or equal
3889 to zero.
3890
3891 @cindex @code{iflt} directive
3892 @item .iflt @var{absolute expression}
3893 Assembles the following section of code if the argument is less than zero.
3894
3895 @cindex @code{ifnc} directive
3896 @item .ifnc @var{string1},@var{string2}.
3897 Like @code{.ifc}, but the sense of the test is reversed: this assembles the
3898 following section of code if the two strings are not the same.
3899
3900 @cindex @code{ifndef} directive
3901 @cindex @code{ifnotdef} directive
3902 @item .ifndef @var{symbol}
3903 @itemx .ifnotdef @var{symbol}
3904 Assembles the following section of code if the specified @var{symbol}
3905 has not been defined.  Both spelling variants are equivalent.
3906
3907 @cindex @code{ifne} directive
3908 @item .ifne @var{absolute expression}
3909 Assembles the following section of code if the argument is not equal to zero
3910 (in other words, this is equivalent to @code{.if}).
3911
3912 @cindex @code{ifnes} directive
3913 @item .ifnes @var{string1},@var{string2}
3914 Like @code{.ifeqs}, but the sense of the test is reversed: this assembles the
3915 following section of code if the two strings are not the same.
3916 @end table
3917
3918 @node Include
3919 @section @code{.include "@var{file}"}
3920
3921 @cindex @code{include} directive
3922 @cindex supporting files, including
3923 @cindex files, including
3924 This directive provides a way to include supporting files at specified
3925 points in your source program.  The code from @var{file} is assembled as
3926 if it followed the point of the @code{.include}; when the end of the
3927 included file is reached, assembly of the original file continues.  You
3928 can control the search paths used with the @samp{-I} command-line option
3929 (@pxref{Invoking,,Command-Line Options}).  Quotation marks are required
3930 around @var{file}.
3931
3932 @node Int
3933 @section @code{.int @var{expressions}}
3934
3935 @cindex @code{int} directive
3936 @cindex integers, 32-bit
3937 Expect zero or more @var{expressions}, of any section, separated by commas.
3938 For each expression, emit a number that, at run time, is the value of that
3939 expression.  The byte order and bit size of the number depends on what kind
3940 of target the assembly is for.
3941
3942 @ifclear GENERIC
3943 @ifset H8
3944 On the H8/500 and most forms of the H8/300, @code{.int} emits 16-bit
3945 integers.  On the H8/300H and the Hitachi SH, however, @code{.int} emits
3946 32-bit integers.
3947 @end ifset
3948 @end ifclear
3949
3950 @ifset ELF
3951 @node Internal
3952 @section @code{.internal @var{names}}
3953
3954 @cindex @code{.internal} directive
3955 @cindex Visibility
3956 This one of the ELF visibility directives.  The other two are
3957 @pxref{Hidden,,@code{.hidden}} and @pxref{Protected,,@code{.protected}}
3958
3959 This directive overrides the named symbols default visibility (which is set by
3960 their binding: local, global or weak).  The directive sets the visibility to
3961 @code{internal} which means that the symbols are considered to be @code{hidden}
3962 (ie not visible to other components), and that some extra, processor specific
3963 processing must also be performed upon the  symbols as well.
3964 @end ifset
3965
3966 @node Irp
3967 @section @code{.irp @var{symbol},@var{values}}@dots{}
3968
3969 @cindex @code{irp} directive
3970 Evaluate a sequence of statements assigning different values to @var{symbol}.
3971 The sequence of statements starts at the @code{.irp} directive, and is
3972 terminated by an @code{.endr} directive.  For each @var{value}, @var{symbol} is
3973 set to @var{value}, and the sequence of statements is assembled.  If no
3974 @var{value} is listed, the sequence of statements is assembled once, with
3975 @var{symbol} set to the null string.  To refer to @var{symbol} within the
3976 sequence of statements, use @var{\symbol}.
3977
3978 For example, assembling
3979
3980 @example
3981         .irp    param,1,2,3
3982         move    d\param,sp@@-
3983         .endr
3984 @end example
3985
3986 is equivalent to assembling
3987
3988 @example
3989         move    d1,sp@@-
3990         move    d2,sp@@-
3991         move    d3,sp@@-
3992 @end example
3993
3994 @node Irpc
3995 @section @code{.irpc @var{symbol},@var{values}}@dots{}
3996
3997 @cindex @code{irpc} directive
3998 Evaluate a sequence of statements assigning different values to @var{symbol}.
3999 The sequence of statements starts at the @code{.irpc} directive, and is
4000 terminated by an @code{.endr} directive.  For each character in @var{value},
4001 @var{symbol} is set to the character, and the sequence of statements is
4002 assembled.  If no @var{value} is listed, the sequence of statements is
4003 assembled once, with @var{symbol} set to the null string.  To refer to
4004 @var{symbol} within the sequence of statements, use @var{\symbol}.
4005
4006 For example, assembling
4007
4008 @example
4009         .irpc    param,123
4010         move    d\param,sp@@-
4011         .endr
4012 @end example
4013
4014 is equivalent to assembling
4015
4016 @example
4017         move    d1,sp@@-
4018         move    d2,sp@@-
4019         move    d3,sp@@-
4020 @end example
4021
4022 @node Lcomm
4023 @section @code{.lcomm @var{symbol} , @var{length}}
4024
4025 @cindex @code{lcomm} directive
4026 @cindex local common symbols
4027 @cindex symbols, local common
4028 Reserve @var{length} (an absolute expression) bytes for a local common
4029 denoted by @var{symbol}.  The section and value of @var{symbol} are
4030 those of the new local common.  The addresses are allocated in the bss
4031 section, so that at run-time the bytes start off zeroed.  @var{Symbol}
4032 is not declared global (@pxref{Global,,@code{.global}}), so is normally
4033 not visible to @code{@value{LD}}.
4034
4035 @ifset GENERIC
4036 Some targets permit a third argument to be used with @code{.lcomm}.  This
4037 argument specifies the desired alignment of the symbol in the bss section.
4038 @end ifset
4039
4040 @ifset HPPA
4041 The syntax for @code{.lcomm} differs slightly on the HPPA.  The syntax is
4042 @samp{@var{symbol} .lcomm, @var{length}}; @var{symbol} is optional.
4043 @end ifset
4044
4045 @node Lflags
4046 @section @code{.lflags}
4047
4048 @cindex @code{lflags} directive (ignored)
4049 @code{@value{AS}} accepts this directive, for compatibility with other
4050 assemblers, but ignores it.
4051
4052 @ifclear no-line-dir
4053 @node Line
4054 @section @code{.line @var{line-number}}
4055
4056 @cindex @code{line} directive
4057 @end ifclear
4058 @ifset no-line-dir
4059 @node Ln
4060 @section @code{.ln @var{line-number}}
4061
4062 @cindex @code{ln} directive
4063 @end ifset
4064 @cindex logical line number
4065 @ifset aout-bout
4066 Change the logical line number.  @var{line-number} must be an absolute
4067 expression.  The next line has that logical line number.  Therefore any other
4068 statements on the current line (after a statement separator character) are
4069 reported as on logical line number @var{line-number} @minus{} 1.  One day
4070 @code{@value{AS}} will no longer support this directive: it is recognized only
4071 for compatibility with existing assembler programs.
4072
4073 @ifset GENERIC
4074 @ifset A29K
4075 @emph{Warning:} In the AMD29K configuration of @value{AS}, this command is
4076 not available; use the synonym @code{.ln} in that context.
4077 @end ifset
4078 @end ifset
4079 @end ifset
4080
4081 @ifclear no-line-dir
4082 Even though this is a directive associated with the @code{a.out} or
4083 @code{b.out} object-code formats, @code{@value{AS}} still recognizes it
4084 when producing COFF output, and treats @samp{.line} as though it
4085 were the COFF @samp{.ln} @emph{if} it is found outside a
4086 @code{.def}/@code{.endef} pair.
4087
4088 Inside a @code{.def}, @samp{.line} is, instead, one of the directives
4089 used by compilers to generate auxiliary symbol information for
4090 debugging.
4091 @end ifclear
4092
4093 @node Linkonce
4094 @section @code{.linkonce [@var{type}]}
4095 @cindex COMDAT
4096 @cindex @code{linkonce} directive
4097 @cindex common sections
4098 Mark the current section so that the linker only includes a single copy of it.
4099 This may be used to include the same section in several different object files,
4100 but ensure that the linker will only include it once in the final output file.
4101 The @code{.linkonce} pseudo-op must be used for each instance of the section.
4102 Duplicate sections are detected based on the section name, so it should be
4103 unique.
4104
4105 This directive is only supported by a few object file formats; as of this
4106 writing, the only object file format which supports it is the Portable
4107 Executable format used on Windows NT.
4108
4109 The @var{type} argument is optional.  If specified, it must be one of the
4110 following strings.  For example:
4111 @smallexample
4112 .linkonce same_size
4113 @end smallexample
4114 Not all types may be supported on all object file formats.
4115
4116 @table @code
4117 @item discard
4118 Silently discard duplicate sections.  This is the default.
4119
4120 @item one_only
4121 Warn if there are duplicate sections, but still keep only one copy.
4122
4123 @item same_size
4124 Warn if any of the duplicates have different sizes.
4125
4126 @item same_contents
4127 Warn if any of the duplicates do not have exactly the same contents.
4128 @end table
4129
4130 @node Ln
4131 @section @code{.ln @var{line-number}}
4132
4133 @cindex @code{ln} directive
4134 @ifclear no-line-dir
4135 @samp{.ln} is a synonym for @samp{.line}.
4136 @end ifclear
4137 @ifset no-line-dir
4138 Tell @code{@value{AS}} to change the logical line number.  @var{line-number}
4139 must be an absolute expression.  The next line has that logical
4140 line number, so any other statements on the current line (after a
4141 statement separator character @code{;}) are reported as on logical
4142 line number @var{line-number} @minus{} 1.
4143 @ifset BOUT
4144
4145 This directive is accepted, but ignored, when @code{@value{AS}} is
4146 configured for @code{b.out}; its effect is only associated with COFF
4147 output format.
4148 @end ifset
4149 @end ifset
4150
4151 @node MRI
4152 @section @code{.mri @var{val}}
4153
4154 @cindex @code{mri} directive
4155 @cindex MRI mode, temporarily
4156 If @var{val} is non-zero, this tells @code{@value{AS}} to enter MRI mode.  If
4157 @var{val} is zero, this tells @code{@value{AS}} to exit MRI mode.  This change
4158 affects code assembled until the next @code{.mri} directive, or until the end
4159 of the file.  @xref{M, MRI mode, MRI mode}.
4160
4161 @node List
4162 @section @code{.list}
4163
4164 @cindex @code{list} directive
4165 @cindex listing control, turning on
4166 Control (in conjunction with the @code{.nolist} directive) whether or
4167 not assembly listings are generated.  These two directives maintain an
4168 internal counter (which is zero initially).   @code{.list} increments the
4169 counter, and @code{.nolist} decrements it.  Assembly listings are
4170 generated whenever the counter is greater than zero.
4171
4172 By default, listings are disabled.  When you enable them (with the
4173 @samp{-a} command line option; @pxref{Invoking,,Command-Line Options}),
4174 the initial value of the listing counter is one.
4175
4176 @node Long
4177 @section @code{.long @var{expressions}}
4178
4179 @cindex @code{long} directive
4180 @code{.long} is the same as @samp{.int}, @pxref{Int,,@code{.int}}.
4181
4182 @ignore
4183 @c no one seems to know what this is for or whether this description is
4184 @c what it really ought to do
4185 @node Lsym
4186 @section @code{.lsym @var{symbol}, @var{expression}}
4187
4188 @cindex @code{lsym} directive
4189 @cindex symbol, not referenced in assembly
4190 @code{.lsym} creates a new symbol named @var{symbol}, but does not put it in
4191 the hash table, ensuring it cannot be referenced by name during the
4192 rest of the assembly.  This sets the attributes of the symbol to be
4193 the same as the expression value:
4194 @smallexample
4195 @var{other} = @var{descriptor} = 0
4196 @var{type} = @r{(section of @var{expression})}
4197 @var{value} = @var{expression}
4198 @end smallexample
4199 @noindent
4200 The new symbol is not flagged as external.
4201 @end ignore
4202
4203 @node Macro
4204 @section @code{.macro}
4205
4206 @cindex macros
4207 The commands @code{.macro} and @code{.endm} allow you to define macros that
4208 generate assembly output.  For example, this definition specifies a macro
4209 @code{sum} that puts a sequence of numbers into memory:
4210
4211 @example
4212         .macro  sum from=0, to=5
4213         .long   \from
4214         .if     \to-\from
4215         sum     "(\from+1)",\to
4216         .endif
4217         .endm
4218 @end example
4219
4220 @noindent
4221 With that definition, @samp{SUM 0,5} is equivalent to this assembly input:
4222
4223 @example
4224         .long   0
4225         .long   1
4226         .long   2
4227         .long   3
4228         .long   4
4229         .long   5
4230 @end example
4231
4232 @ftable @code
4233 @item .macro @var{macname}
4234 @itemx .macro @var{macname} @var{macargs} @dots{}
4235 @cindex @code{macro} directive
4236 Begin the definition of a macro called @var{macname}.  If your macro
4237 definition requires arguments, specify their names after the macro name,
4238 separated by commas or spaces.  You can supply a default value for any
4239 macro argument by following the name with @samp{=@var{deflt}}.  For
4240 example, these are all valid @code{.macro} statements:
4241
4242 @table @code
4243 @item .macro comm
4244 Begin the definition of a macro called @code{comm}, which takes no
4245 arguments.
4246
4247 @item .macro plus1 p, p1
4248 @itemx .macro plus1 p p1
4249 Either statement begins the definition of a macro called @code{plus1},
4250 which takes two arguments; within the macro definition, write
4251 @samp{\p} or @samp{\p1} to evaluate the arguments.
4252
4253 @item .macro reserve_str p1=0 p2
4254 Begin the definition of a macro called @code{reserve_str}, with two
4255 arguments.  The first argument has a default value, but not the second.
4256 After the definition is complete, you can call the macro either as
4257 @samp{reserve_str @var{a},@var{b}} (with @samp{\p1} evaluating to
4258 @var{a} and @samp{\p2} evaluating to @var{b}), or as @samp{reserve_str
4259 ,@var{b}} (with @samp{\p1} evaluating as the default, in this case
4260 @samp{0}, and @samp{\p2} evaluating to @var{b}).
4261 @end table
4262
4263 When you call a macro, you can specify the argument values either by
4264 position, or by keyword.  For example, @samp{sum 9,17} is equivalent to
4265 @samp{sum to=17, from=9}.
4266
4267 @item .endm
4268 @cindex @code{endm} directive
4269 Mark the end of a macro definition.
4270
4271 @item .exitm
4272 @cindex @code{exitm} directive
4273 Exit early from the current macro definition.
4274
4275 @cindex number of macros executed
4276 @cindex macros, count executed
4277 @item \@@
4278 @code{@value{AS}} maintains a counter of how many macros it has
4279 executed in this pseudo-variable; you can copy that number to your
4280 output with @samp{\@@}, but @emph{only within a macro definition}.
4281
4282 @ignore
4283 @item LOCAL @var{name} [ , @dots{} ]
4284 @emph{Warning: @code{LOCAL} is only available if you select ``alternate
4285 macro syntax'' with @samp{-a} or @samp{--alternate}.}  @xref{Alternate,,
4286 Alternate macro syntax}.
4287
4288 Generate a string replacement for each of the @var{name} arguments, and
4289 replace any instances of @var{name} in each macro expansion.  The
4290 replacement string is unique in the assembly, and different for each
4291 separate macro expansion.  @code{LOCAL} allows you to write macros that
4292 define symbols, without fear of conflict between separate macro expansions.
4293 @end ignore
4294 @end ftable
4295
4296 @node Nolist
4297 @section @code{.nolist}
4298
4299 @cindex @code{nolist} directive
4300 @cindex listing control, turning off
4301 Control (in conjunction with the @code{.list} directive) whether or
4302 not assembly listings are generated.  These two directives maintain an
4303 internal counter (which is zero initially).   @code{.list} increments the
4304 counter, and @code{.nolist} decrements it.  Assembly listings are
4305 generated whenever the counter is greater than zero.
4306
4307 @node Octa
4308 @section @code{.octa @var{bignums}}
4309
4310 @c FIXME: double size emitted for "octa" on i960, others?  Or warn?
4311 @cindex @code{octa} directive
4312 @cindex integer, 16-byte
4313 @cindex sixteen byte integer
4314 This directive expects zero or more bignums, separated by commas.  For each
4315 bignum, it emits a 16-byte integer.
4316
4317 The term ``octa'' comes from contexts in which a ``word'' is two bytes;
4318 hence @emph{octa}-word for 16 bytes.
4319
4320 @node Org
4321 @section @code{.org @var{new-lc} , @var{fill}}
4322
4323 @cindex @code{org} directive
4324 @cindex location counter, advancing
4325 @cindex advancing location counter
4326 @cindex current address, advancing
4327 Advance the location counter of the current section to
4328 @var{new-lc}.  @var{new-lc} is either an absolute expression or an
4329 expression with the same section as the current subsection.  That is,
4330 you can't use @code{.org} to cross sections: if @var{new-lc} has the
4331 wrong section, the @code{.org} directive is ignored.  To be compatible
4332 with former assemblers, if the section of @var{new-lc} is absolute,
4333 @code{@value{AS}} issues a warning, then pretends the section of @var{new-lc}
4334 is the same as the current subsection.
4335
4336 @code{.org} may only increase the location counter, or leave it
4337 unchanged; you cannot use @code{.org} to move the location counter
4338 backwards.
4339
4340 @c double negative used below "not undefined" because this is a specific
4341 @c reference to "undefined" (as SEG_UNKNOWN is called in this manual)
4342 @c section. doc@cygnus.com 18feb91
4343 Because @code{@value{AS}} tries to assemble programs in one pass, @var{new-lc}
4344 may not be undefined.  If you really detest this restriction we eagerly await
4345 a chance to share your improved assembler.
4346
4347 Beware that the origin is relative to the start of the section, not
4348 to the start of the subsection.  This is compatible with other
4349 people's assemblers.
4350
4351 When the location counter (of the current subsection) is advanced, the
4352 intervening bytes are filled with @var{fill} which should be an
4353 absolute expression.  If the comma and @var{fill} are omitted,
4354 @var{fill} defaults to zero.
4355
4356 @node P2align
4357 @section @code{.p2align[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4358
4359 @cindex padding the location counter given a power of two
4360 @cindex @code{p2align} directive
4361 Pad the location counter (in the current subsection) to a particular
4362 storage boundary.  The first expression (which must be absolute) is the
4363 number of low-order zero bits the location counter must have after
4364 advancement.  For example @samp{.p2align 3} advances the location
4365 counter until it a multiple of 8.  If the location counter is already a
4366 multiple of 8, no change is needed.
4367
4368 The second expression (also absolute) gives the fill value to be stored in the
4369 padding bytes.  It (and the comma) may be omitted.  If it is omitted, the
4370 padding bytes are normally zero.  However, on some systems, if the section is
4371 marked as containing code and the fill value is omitted, the space is filled
4372 with no-op instructions.
4373
4374 The third expression is also absolute, and is also optional.  If it is present,
4375 it is the maximum number of bytes that should be skipped by this alignment
4376 directive.  If doing the alignment would require skipping more bytes than the
4377 specified maximum, then the alignment is not done at all.  You can omit the
4378 fill value (the second argument) entirely by simply using two commas after the
4379 required alignment; this can be useful if you want the alignment to be filled
4380 with no-op instructions when appropriate.
4381
4382 @cindex @code{p2alignw} directive
4383 @cindex @code{p2alignl} directive
4384 The @code{.p2alignw} and @code{.p2alignl} directives are variants of the
4385 @code{.p2align} directive.  The @code{.p2alignw} directive treats the fill
4386 pattern as a two byte word value.  The @code{.p2alignl} directives treats the
4387 fill pattern as a four byte longword value.  For example, @code{.p2alignw
4388 2,0x368d} will align to a multiple of 4.  If it skips two bytes, they will be
4389 filled in with the value 0x368d (the exact placement of the bytes depends upon
4390 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
4391 undefined.
4392
4393 @ifset ELF
4394 @node Previous
4395 @section @code{.previous}
4396
4397 @cindex @code{.previous} directive
4398 @cindex Section Stack
4399 This is one of the ELF section stack manipulation directives.  The others are
4400 @pxref{Section}, @xref{SubSection}, @pxref{PushSection}, and
4401 @pxref{PopSection}.
4402
4403 This directive swaps the current section (and subsection) with most recently
4404 referenced section (and subsection) prior to this one.  Multiple
4405 @code{.previous} directives in a row will flip between two sections (and their
4406 subsections).
4407
4408 In terms of the section stack, this directive swaps the current section with
4409 the top section on the section stack.
4410 @end ifset
4411
4412 @ifset ELF
4413 @node PopSection
4414 @section @code{.popsection}
4415
4416 @cindex @code{.popsection} directive
4417 @cindex Section Stack
4418 This is one of the ELF section stack manipulation directives.  The others are
4419 @pxref{Section}, @xref{SubSection}, @pxref{PushSection}, and
4420 @pxref{Previous}.
4421
4422 This directive replaces the current section (and subsection) with the top
4423 section (and subsection) on the section stack.  This section is popped off the
4424 stack. 
4425 @end ifset
4426
4427 @node Print
4428 @section @code{.print @var{string}}
4429
4430 @cindex @code{print} directive
4431 @code{@value{AS}} will print @var{string} on the standard output during
4432 assembly.  You must put @var{string} in double quotes.
4433
4434 @ifset ELF
4435 @node Protected
4436 @section @code{.protected @var{names}}
4437
4438 @cindex @code{.protected} directive
4439 @cindex Visibility
4440 This one of the ELF visibility directives.  The other two are
4441 @pxref{Hidden} and @pxref{Internal}
4442
4443 This directive overrides the named symbols default visibility (which is set by
4444 their binding: local, global or weak).  The directive sets the visibility to
4445 @code{protected} which means that any references to the symbols from within the
4446 components that defines them must be resolved to the definition in that
4447 component, even if a definition in another component would normally preempt
4448 this. 
4449 @end ifset
4450
4451 @node Psize
4452 @section @code{.psize @var{lines} , @var{columns}}
4453
4454 @cindex @code{psize} directive
4455 @cindex listing control: paper size
4456 @cindex paper size, for listings
4457 Use this directive to declare the number of lines---and, optionally, the
4458 number of columns---to use for each page, when generating listings.
4459
4460 If you do not use @code{.psize}, listings use a default line-count
4461 of 60.  You may omit the comma and @var{columns} specification; the
4462 default width is 200 columns.
4463
4464 @code{@value{AS}} generates formfeeds whenever the specified number of
4465 lines is exceeded (or whenever you explicitly request one, using
4466 @code{.eject}).
4467
4468 If you specify @var{lines} as @code{0}, no formfeeds are generated save
4469 those explicitly specified with @code{.eject}.
4470
4471 @node Purgem
4472 @section @code{.purgem @var{name}}
4473
4474 @cindex @code{purgem} directive
4475 Undefine the macro @var{name}, so that later uses of the string will not be
4476 expanded.  @xref{Macro}.
4477
4478 @ifset ELF
4479 @node PushSection
4480 @section @code{.pushsection @var{name} , @var{subsection}}
4481
4482 @cindex @code{.pushsection} directive
4483 @cindex Section Stack
4484 This is one of the ELF section stack manipulation directives.  The others are
4485 @pxref{Section}, @xref{SubSection}, @pxref{PopSection}, and
4486 @pxref{Previous}.
4487
4488 This directive is a synonym for @code{.section}.  It psuhes the current section
4489 (and subsection) onto the top of the section stack, and then replaces the
4490 current section and subsection with @code{name} and @code{subsection}.
4491 @end ifset
4492
4493 @node Quad
4494 @section @code{.quad @var{bignums}}
4495
4496 @cindex @code{quad} directive
4497 @code{.quad} expects zero or more bignums, separated by commas.  For
4498 each bignum, it emits
4499 @ifclear bignum-16
4500 an 8-byte integer.  If the bignum won't fit in 8 bytes, it prints a
4501 warning message; and just takes the lowest order 8 bytes of the bignum.
4502 @cindex eight-byte integer
4503 @cindex integer, 8-byte
4504
4505 The term ``quad'' comes from contexts in which a ``word'' is two bytes;
4506 hence @emph{quad}-word for 8 bytes.
4507 @end ifclear
4508 @ifset bignum-16
4509 a 16-byte integer.  If the bignum won't fit in 16 bytes, it prints a
4510 warning message; and just takes the lowest order 16 bytes of the bignum.
4511 @cindex sixteen-byte integer
4512 @cindex integer, 16-byte
4513 @end ifset
4514
4515 @node Rept
4516 @section @code{.rept @var{count}}
4517
4518 @cindex @code{rept} directive
4519 Repeat the sequence of lines between the @code{.rept} directive and the next
4520 @code{.endr} directive @var{count} times.
4521
4522 For example, assembling
4523
4524 @example
4525         .rept   3
4526         .long   0
4527         .endr
4528 @end example
4529
4530 is equivalent to assembling
4531
4532 @example
4533         .long   0
4534         .long   0
4535         .long   0
4536 @end example
4537
4538 @node Sbttl
4539 @section @code{.sbttl "@var{subheading}"}
4540
4541 @cindex @code{sbttl} directive
4542 @cindex subtitles for listings
4543 @cindex listing control: subtitle
4544 Use @var{subheading} as the title (third line, immediately after the
4545 title line) when generating assembly listings.
4546
4547 This directive affects subsequent pages, as well as the current page if
4548 it appears within ten lines of the top of a page.
4549
4550 @ifset COFF
4551 @node Scl
4552 @section @code{.scl @var{class}}
4553
4554 @cindex @code{scl} directive
4555 @cindex symbol storage class (COFF)
4556 @cindex COFF symbol storage class
4557 Set the storage-class value for a symbol.  This directive may only be
4558 used inside a @code{.def}/@code{.endef} pair.  Storage class may flag
4559 whether a symbol is static or external, or it may record further
4560 symbolic debugging information.
4561 @ifset BOUT
4562
4563 The @samp{.scl} directive is primarily associated with COFF output; when
4564 configured to generate @code{b.out} output format, @code{@value{AS}}
4565 accepts this directive but ignores it.
4566 @end ifset
4567 @end ifset
4568
4569 @node Section
4570 @section @code{.section @var{name}} (COFF version)
4571
4572 @cindex @code{section} directive
4573 @cindex named section
4574 Use the @code{.section} directive to assemble the following code into a section
4575 named @var{name}.
4576
4577 This directive is only supported for targets that actually support arbitrarily
4578 named sections; on @code{a.out} targets, for example, it is not accepted, even
4579 with a standard @code{a.out} section name.
4580
4581 For COFF targets, the @code{.section} directive is used in one of the following
4582 ways:
4583
4584 @smallexample
4585 .section @var{name}[, "@var{flags}"]
4586 .section @var{name}[, @var{subsegment}]
4587 @end smallexample
4588
4589 If the optional argument is quoted, it is taken as flags to use for the
4590 section.  Each flag is a single character.  The following flags are recognized:
4591 @table @code
4592 @item b
4593 bss section (uninitialized data)
4594 @item n
4595 section is not loaded
4596 @item w
4597 writable section
4598 @item d
4599 data section
4600 @item r
4601 read-only section
4602 @item x
4603 executable section
4604 @item s
4605 shared section (meaningful for PE targets)
4606 @end table
4607
4608 If no flags are specified, the default flags depend upon the section name.  If
4609 the section name is not recognized, the default will be for the section to be
4610 loaded and writable.
4611
4612 If the optional argument to the @code{.section} directive is not quoted, it is
4613 taken as a subsegment number (@pxref{Sub-Sections}).
4614
4615
4616 @section @code{.section @var{name}} (ELF version)
4617
4618 @cindex @code{section} directive
4619 @cindex named section
4620 @ifset ELF
4621 @cindex Section Stack
4622 This is one of the ELF section stack manipulation directives.  The others are
4623 @xref{SubSection}, @pxref{PushSection}@pxref{PopSection}, and
4624 @pxref{Previous}.
4625 @end ifset
4626
4627 For ELF targets, the @code{.section} directive is used like this:
4628
4629 @smallexample
4630 .section @var{name} [, "@var{flags}"[, @@@var{type}]]
4631 @end smallexample
4632
4633 The optional @var{flags} argument is a quoted string which may contain any
4634 combintion of the following characters:
4635 @table @code
4636 @item a
4637 section is allocatable
4638 @item w
4639 section is writable
4640 @item x
4641 section is executable
4642 @end table
4643
4644 The optional @var{type} argument may contain one of the following constants:
4645 @table @code
4646 @item @@progbits
4647 section contains data
4648 @item @@nobits
4649 section does not contain data (i.e., section only occupies space)
4650 @end table
4651
4652 If no flags are specified, the default flags depend upon the section name.  If
4653 the section name is not recognized, the default will be for the section to have
4654 none of the above flags: it will not be allocated in memory, nor writable, nor
4655 executable.  The section will contain data.
4656
4657 For ELF targets, the assembler supports another type of @code{.section}
4658 directive for compatibility with the Solaris assembler:
4659
4660 @smallexample
4661 .section "@var{name}"[, @var{flags}...]
4662 @end smallexample
4663
4664 Note that the section name is quoted.  There may be a sequence of comma
4665 separated flags:
4666 @table @code
4667 @item #alloc
4668 section is allocatable
4669 @item #write
4670 section is writable
4671 @item #execinstr
4672 section is executable
4673 @end table
4674
4675 This directive replaces the current section and subsection.  The replaced
4676 section and subsection are pushed onto the section stack.  See the contents of
4677 the gas testsuite directory @code{gas/testsuite/gas/elf} for some examples of
4678 how this directive and the other section stack directives work.
4679
4680 @node Set
4681 @section @code{.set @var{symbol}, @var{expression}}
4682
4683 @cindex @code{set} directive
4684 @cindex symbol value, setting
4685 Set the value of @var{symbol} to @var{expression}.  This
4686 changes @var{symbol}'s value and type to conform to
4687 @var{expression}.  If @var{symbol} was flagged as external, it remains
4688 flagged (@pxref{Symbol Attributes}).
4689
4690 You may @code{.set} a symbol many times in the same assembly.
4691
4692 If you @code{.set} a global symbol, the value stored in the object
4693 file is the last value stored into it.
4694
4695 @ifset HPPA
4696 The syntax for @code{set} on the HPPA is
4697 @samp{@var{symbol} .set @var{expression}}.
4698 @end ifset
4699
4700 @node Short
4701 @section @code{.short @var{expressions}}
4702
4703 @cindex @code{short} directive
4704 @ifset GENERIC
4705 @code{.short} is normally the same as @samp{.word}.
4706 @xref{Word,,@code{.word}}.
4707
4708 In some configurations, however, @code{.short} and @code{.word} generate
4709 numbers of different lengths; @pxref{Machine Dependencies}.
4710 @end ifset
4711 @ifclear GENERIC
4712 @ifset W16
4713 @code{.short} is the same as @samp{.word}.  @xref{Word,,@code{.word}}.
4714 @end ifset
4715 @ifset W32
4716 This expects zero or more @var{expressions}, and emits
4717 a 16 bit number for each.
4718 @end ifset
4719 @end ifclear
4720
4721 @node Single
4722 @section @code{.single @var{flonums}}
4723
4724 @cindex @code{single} directive
4725 @cindex floating point numbers (single)
4726 This directive assembles zero or more flonums, separated by commas.  It
4727 has the same effect as @code{.float}.
4728 @ifset GENERIC
4729 The exact kind of floating point numbers emitted depends on how
4730 @code{@value{AS}} is configured.  @xref{Machine Dependencies}.
4731 @end ifset
4732 @ifclear GENERIC
4733 @ifset IEEEFLOAT
4734 On the @value{TARGET} family, @code{.single} emits 32-bit floating point
4735 numbers in @sc{ieee} format.
4736 @end ifset
4737 @end ifclear
4738
4739 @node Size
4740 @section @code{.size} (COFF version)
4741
4742 @cindex @code{size} directive
4743 This directive is generated by compilers to include auxiliary debugging
4744 information in the symbol table.  It is only permitted inside
4745 @code{.def}/@code{.endef} pairs.
4746
4747 @ifset BOUT
4748 @samp{.size} is only meaningful when generating COFF format output; when
4749 @code{@value{AS}} is generating @code{b.out}, it accepts this directive but
4750 ignores it.
4751 @end ifset
4752
4753 @section @code{.size @var{name} , @var{expression}} (ELF version)
4754 @cindex @code{size} directive
4755
4756 This directive is used to set the size associated with a symbol @var{name}.
4757 The size in bytes is computed from @var{expression} which can make use of label
4758 arithmetic.  This directive is typically used to set the size of function
4759 symbols.
4760
4761 @node Sleb128
4762 @section @code{.sleb128 @var{expressions}}
4763
4764 @cindex @code{sleb128} directive
4765 @var{sleb128} stands for ``signed little endian base 128.''  This is a 
4766 compact, variable length representation of numbers used by the DWARF
4767 symbolic debugging format.  @xref{Uleb128,@code{.uleb128}}.
4768
4769 @ifclear no-space-dir
4770 @node Skip
4771 @section @code{.skip @var{size} , @var{fill}}
4772
4773 @cindex @code{skip} directive
4774 @cindex filling memory
4775 This directive emits @var{size} bytes, each of value @var{fill}.  Both
4776 @var{size} and @var{fill} are absolute expressions.  If the comma and
4777 @var{fill} are omitted, @var{fill} is assumed to be zero.  This is the same as
4778 @samp{.space}.
4779
4780 @node Space
4781 @section @code{.space @var{size} , @var{fill}}
4782
4783 @cindex @code{space} directive
4784 @cindex filling memory
4785 This directive emits @var{size} bytes, each of value @var{fill}.  Both
4786 @var{size} and @var{fill} are absolute expressions.  If the comma
4787 and @var{fill} are omitted, @var{fill} is assumed to be zero.  This is the same
4788 as @samp{.skip}.
4789
4790 @ifset HPPA
4791 @quotation
4792 @emph{Warning:} @code{.space} has a completely different meaning for HPPA
4793 targets; use @code{.block} as a substitute.  See @cite{HP9000 Series 800
4794 Assembly Language Reference Manual} (HP 92432-90001) for the meaning of the
4795 @code{.space} directive.  @xref{HPPA Directives,,HPPA Assembler Directives},
4796 for a summary.
4797 @end quotation
4798 @end ifset
4799 @end ifclear
4800
4801 @ifset A29K
4802 @ifclear GENERIC
4803 @node Space
4804 @section @code{.space}
4805 @cindex @code{space} directive
4806 @end ifclear
4807 On the AMD 29K, this directive is ignored; it is accepted for
4808 compatibility with other AMD 29K assemblers.
4809
4810 @quotation
4811 @emph{Warning:} In most versions of the @sc{gnu} assembler, the directive
4812 @code{.space} has the effect of @code{.block}  @xref{Machine Dependencies}.
4813 @end quotation
4814 @end ifset
4815
4816 @ifset have-stabs
4817 @node Stab
4818 @section @code{.stabd, .stabn, .stabs}
4819
4820 @cindex symbolic debuggers, information for
4821 @cindex @code{stab@var{x}} directives
4822 There are three directives that begin @samp{.stab}.
4823 All emit symbols (@pxref{Symbols}), for use by symbolic debuggers.
4824 The symbols are not entered in the @code{@value{AS}} hash table: they
4825 cannot be referenced elsewhere in the source file.
4826 Up to five fields are required:
4827
4828 @table @var
4829 @item string
4830 This is the symbol's name.  It may contain any character except
4831 @samp{\000}, so is more general than ordinary symbol names.  Some
4832 debuggers used to code arbitrarily complex structures into symbol names
4833 using this field.
4834
4835 @item type
4836 An absolute expression.  The symbol's type is set to the low 8 bits of
4837 this expression.  Any bit pattern is permitted, but @code{@value{LD}}
4838 and debuggers choke on silly bit patterns.
4839
4840 @item other
4841 An absolute expression.  The symbol's ``other'' attribute is set to the
4842 low 8 bits of this expression.
4843
4844 @item desc
4845 An absolute expression.  The symbol's descriptor is set to the low 16
4846 bits of this expression.
4847
4848 @item value
4849 An absolute expression which becomes the symbol's value.
4850 @end table
4851
4852 If a warning is detected while reading a @code{.stabd}, @code{.stabn},
4853 or @code{.stabs} statement, the symbol has probably already been created;
4854 you get a half-formed symbol in your object file.  This is
4855 compatible with earlier assemblers!
4856
4857 @table @code
4858 @cindex @code{stabd} directive
4859 @item .stabd @var{type} , @var{other} , @var{desc}
4860
4861 The ``name'' of the symbol generated is not even an empty string.
4862 It is a null pointer, for compatibility.  Older assemblers used a
4863 null pointer so they didn't waste space in object files with empty
4864 strings.
4865
4866 The symbol's value is set to the location counter,
4867 relocatably.  When your program is linked, the value of this symbol
4868 is the address of the location counter when the @code{.stabd} was
4869 assembled.
4870
4871 @cindex @code{stabn} directive
4872 @item .stabn @var{type} , @var{other} , @var{desc} , @var{value}
4873 The name of the symbol is set to the empty string @code{""}.
4874
4875 @cindex @code{stabs} directive
4876 @item .stabs @var{string} ,  @var{type} , @var{other} , @var{desc} , @var{value}
4877 All five fields are specified.
4878 @end table
4879 @end ifset
4880 @c end     have-stabs
4881
4882 @node String
4883 @section @code{.string} "@var{str}"
4884
4885 @cindex string, copying to object file
4886 @cindex @code{string} directive
4887
4888 Copy the characters in @var{str} to the object file.  You may specify more than
4889 one string to copy, separated by commas.  Unless otherwise specified for a
4890 particular machine, the assembler marks the end of each string with a 0 byte.
4891 You can use any of the escape sequences described in @ref{Strings,,Strings}.
4892
4893 @node Struct
4894 @section @code{.struct @var{expression}}
4895
4896 @cindex @code{struct} directive
4897 Switch to the absolute section, and set the section offset to @var{expression},
4898 which must be an absolute expression.  You might use this as follows:
4899 @smallexample
4900         .struct 0
4901 field1:
4902         .struct field1 + 4
4903 field2:
4904         .struct field2 + 4
4905 field3:
4906 @end smallexample
4907 This would define the symbol @code{field1} to have the value 0, the symbol
4908 @code{field2} to have the value 4, and the symbol @code{field3} to have the
4909 value 8.  Assembly would be left in the absolute section, and you would need to
4910 use a @code{.section} directive of some sort to change to some other section
4911 before further assembly.
4912
4913 @ifset ELF
4914 @node SubSection
4915 @section @code{.subsection @var{name}}
4916
4917 @cindex @code{.subsection} directive
4918 @cindex Section Stack
4919 This is one of the ELF section stack manipulation directives.  The others are
4920 @pxref{Section}, @xref{PushSection}, @pxref{PopSection}, and
4921 @pxref{Previous}.
4922
4923 This directive replaces the current subsection with @code{name}.  The current
4924 section is not changed.  The replaced subsection is put onto the section stack
4925 in place of the then current top of stack subsection.
4926 @end ifset
4927
4928 @ifset ELF
4929 @node Symver
4930 @section @code{.symver}
4931 @cindex @code{symver} directive
4932 @cindex symbol versioning
4933 @cindex versions of symbols
4934 Use the @code{.symver} directive to bind symbols to specific version nodes
4935 within a source file.  This is only supported on ELF platforms, and is
4936 typically used when assembling files to be linked into a shared library.
4937 There are cases where it may make sense to use this in objects to be bound
4938 into an application itself so as to override a versioned symbol from a
4939 shared library.
4940
4941 For ELF targets, the @code{.symver} directive can be used like this:
4942 @smallexample
4943 .symver @var{name}, @var{name2@@nodename}
4944 @end smallexample
4945 If the symbol @var{name} is defined within the file
4946 being assembled, the @code{.symver} directive effectively creates a symbol
4947 alias with the name @var{name2@@nodename}, and in fact the main reason that we
4948 just don't try and create a regular alias is that the @var{@@} character isn't
4949 permitted in symbol names.  The @var{name2} part of the name is the actual name
4950 of the symbol by which it will be externally referenced.  The name @var{name}
4951 itself is merely a name of convenience that is used so that it is possible to
4952 have definitions for multiple versions of a function within a single source
4953 file, and so that the compiler can unambiguously know which version of a
4954 function is being mentioned.  The @var{nodename} portion of the alias should be
4955 the name of a node specified in the version script supplied to the linker when
4956 building a shared library.  If you are attempting to override a versioned
4957 symbol from a shared library, then @var{nodename} should correspond to the
4958 nodename of the symbol you are trying to override.
4959
4960 If the symbol @var{name} is not defined within the file being assembled, all
4961 references to @var{name} will be changed to @var{name2@@nodename}.  If no
4962 reference to @var{name} is made, @var{name2@@nodename} will be removed from the
4963 symbol table.
4964
4965 Another usage of the @code{.symver} directive is:
4966 @smallexample
4967 .symver @var{name}, @var{name2@@@@nodename}
4968 @end smallexample
4969 In this case, the symbol @var{name} must exist and be defined within
4970 the file being assembled. It is similiar to @var{name2@@nodename}. The
4971 difference is @var{name2@@@@nodename} will also be used to resolve
4972 references to @var{name2} by the linker.
4973
4974 The third usage of the @code{.symver} directive is:
4975 @smallexample
4976 .symver @var{name}, @var{name2@@@@@@nodename}
4977 @end smallexample
4978 When @var{name} is not defined within the
4979 file being assembled, it is treated as @var{name2@@nodename}. When
4980 @var{name} is defined within the file being assembled, the symbol
4981 name, @var{name}, will be changed to @var{name2@@@@nodename}.
4982 @end ifset
4983
4984 @ifset COFF
4985 @node Tag
4986 @section @code{.tag @var{structname}}
4987
4988 @cindex COFF structure debugging
4989 @cindex structure debugging, COFF
4990 @cindex @code{tag} directive
4991 This directive is generated by compilers to include auxiliary debugging
4992 information in the symbol table.  It is only permitted inside
4993 @code{.def}/@code{.endef} pairs.  Tags are used to link structure
4994 definitions in the symbol table with instances of those structures.
4995 @ifset BOUT
4996
4997 @samp{.tag} is only used when generating COFF format output; when
4998 @code{@value{AS}} is generating @code{b.out}, it accepts this directive but
4999 ignores it.
5000 @end ifset
5001 @end ifset
5002
5003 @node Text
5004 @section @code{.text @var{subsection}}
5005
5006 @cindex @code{text} directive
5007 Tells @code{@value{AS}} to assemble the following statements onto the end of
5008 the text subsection numbered @var{subsection}, which is an absolute
5009 expression.  If @var{subsection} is omitted, subsection number zero
5010 is used.
5011
5012 @node Title
5013 @section @code{.title "@var{heading}"}
5014
5015 @cindex @code{title} directive
5016 @cindex listing control: title line
5017 Use @var{heading} as the title (second line, immediately after the
5018 source file name and pagenumber) when generating assembly listings.
5019
5020 This directive affects subsequent pages, as well as the current page if
5021 it appears within ten lines of the top of a page.
5022
5023 @node Type
5024 @section @code{.type @var{int}} (COFF version)
5025
5026 @cindex COFF symbol type
5027 @cindex symbol type, COFF
5028 @cindex @code{type} directive
5029 This directive, permitted only within @code{.def}/@code{.endef} pairs,
5030 records the integer @var{int} as the type attribute of a symbol table entry.
5031
5032 @ifset BOUT
5033 @samp{.type} is associated only with COFF format output; when
5034 @code{@value{AS}} is configured for @code{b.out} output, it accepts this
5035 directive but ignores it.
5036 @end ifset
5037
5038 @section @code{.type @var{name} , @var{type description}} (ELF version)
5039
5040 @cindex ELF symbol type
5041 @cindex symbol type, ELF
5042 @cindex @code{type} directive
5043 This directive is used to set the type of symbol @var{name} to be either a
5044 function symbol or an ojbect symbol.  There are five different syntaxes
5045 supported for the @var{type description} field, in order to provide
5046 comptability with various other assemblers.  The syntaxes supported are:
5047
5048 @smallexample
5049   .type <name>,#function
5050   .type <name>,#object
5051
5052   .type <name>,@@function
5053   .type <name>,@@object
5054
5055   .type <name>,%function
5056   .type <name>,%object
5057   
5058   .type <name>,"function"
5059   .type <name>,"object"
5060   
5061   .type <name> STT_FUNCTION
5062   .type <name> STT_OBJECT
5063 @end smallexample
5064
5065 @node Uleb128
5066 @section @code{.uleb128 @var{expressions}}
5067
5068 @cindex @code{uleb128} directive
5069 @var{uleb128} stands for ``unsigned little endian base 128.''  This is a 
5070 compact, variable length representation of numbers used by the DWARF
5071 symbolic debugging format.  @xref{Sleb128,@code{.sleb128}}.
5072
5073 @ifset COFF
5074 @node Val
5075 @section @code{.val @var{addr}}
5076
5077 @cindex @code{val} directive
5078 @cindex COFF value attribute
5079 @cindex value attribute, COFF
5080 This directive, permitted only within @code{.def}/@code{.endef} pairs,
5081 records the address @var{addr} as the value attribute of a symbol table
5082 entry.
5083 @ifset BOUT
5084
5085 @samp{.val} is used only for COFF output; when @code{@value{AS}} is
5086 configured for @code{b.out}, it accepts this directive but ignores it.
5087 @end ifset
5088 @end ifset
5089
5090 @ifset ELF
5091 @node Version
5092 @section @code{.version "@var{string}"}
5093
5094 @cindex @code{.version}
5095 This directive creates a @code{.note} section and places into it an ELF
5096 formatted note of type NT_VERSION.  The note's name is set to @code{string}.
5097 @end ifset
5098
5099 @ifset ELF
5100 @node VTableEntry
5101 @section @code{.vtable_entry @var{table}, @var{offset}}
5102
5103 @cindex @code{.vtable_entry}
5104 This directive finds or creates a symbol @code{table} and creates a
5105 @code{VTABLE_ENTRY} relocation for it with an addend of @code{offset}.
5106
5107 @node VTableInherit
5108 @section @code{.vtable_inherit @var{child}, @var{parent}}
5109
5110 @cindex @code{.vtable_inherit}
5111 This directive finds the symbol @code{child} and finds or creates the symbol
5112 @code{parent} and then creates a @code{VTABLE_INHERIT} relocation for the
5113 parent whoes addend is the value of the child symbol.  As a special case the
5114 parent name of @code{0} is treated as refering the @code{*ABS*} section.
5115 @end ifset
5116
5117 @ifset ELF
5118 @node Weak
5119 @section @code{.weak @var{names}}
5120
5121 @cindex @code{.weak}
5122 This directive sets the weak attribute on the comma seperated list of symbol
5123 @code{names}.  If the symbols do not already exist, they will be created.
5124 @end ifset
5125
5126 @node Word
5127 @section @code{.word @var{expressions}}
5128
5129 @cindex @code{word} directive
5130 This directive expects zero or more @var{expressions}, of any section,
5131 separated by commas.
5132 @ifclear GENERIC
5133 @ifset W32
5134 For each expression, @code{@value{AS}} emits a 32-bit number.
5135 @end ifset
5136 @ifset W16
5137 For each expression, @code{@value{AS}} emits a 16-bit number.
5138 @end ifset
5139 @end ifclear
5140 @ifset GENERIC
5141
5142 The size of the number emitted, and its byte order,
5143 depend on what target computer the assembly is for.
5144 @end ifset
5145
5146 @c on amd29k, i960, sparc the "special treatment to support compilers" doesn't
5147 @c happen---32-bit addressability, period; no long/short jumps.
5148 @ifset DIFF-TBL-KLUGE
5149 @cindex difference tables altered
5150 @cindex altered difference tables
5151 @quotation
5152 @emph{Warning: Special Treatment to support Compilers}
5153 @end quotation
5154
5155 @ifset GENERIC
5156 Machines with a 32-bit address space, but that do less than 32-bit
5157 addressing, require the following special treatment.  If the machine of
5158 interest to you does 32-bit addressing (or doesn't require it;
5159 @pxref{Machine Dependencies}), you can ignore this issue.
5160
5161 @end ifset
5162 In order to assemble compiler output into something that works,
5163 @code{@value{AS}} occasionlly does strange things to @samp{.word} directives.
5164 Directives of the form @samp{.word sym1-sym2} are often emitted by
5165 compilers as part of jump tables.  Therefore, when @code{@value{AS}} assembles a
5166 directive of the form @samp{.word sym1-sym2}, and the difference between
5167 @code{sym1} and @code{sym2} does not fit in 16 bits, @code{@value{AS}}
5168 creates a @dfn{secondary jump table}, immediately before the next label.
5169 This secondary jump table is preceded by a short-jump to the
5170 first byte after the secondary table.  This short-jump prevents the flow
5171 of control from accidentally falling into the new table.  Inside the
5172 table is a long-jump to @code{sym2}.  The original @samp{.word}
5173 contains @code{sym1} minus the address of the long-jump to
5174 @code{sym2}.
5175
5176 If there were several occurrences of @samp{.word sym1-sym2} before the
5177 secondary jump table, all of them are adjusted.  If there was a
5178 @samp{.word sym3-sym4}, that also did not fit in sixteen bits, a
5179 long-jump to @code{sym4} is included in the secondary jump table,
5180 and the @code{.word} directives are adjusted to contain @code{sym3}
5181 minus the address of the long-jump to @code{sym4}; and so on, for as many
5182 entries in the original jump table as necessary.
5183
5184 @ifset INTERNALS
5185 @emph{This feature may be disabled by compiling @code{@value{AS}} with the
5186 @samp{-DWORKING_DOT_WORD} option.} This feature is likely to confuse
5187 assembly language programmers.
5188 @end ifset
5189 @end ifset
5190 @c end     DIFF-TBL-KLUGE
5191
5192 @node Deprecated
5193 @section Deprecated Directives
5194
5195 @cindex deprecated directives
5196 @cindex obsolescent directives
5197 One day these directives won't work.
5198 They are included for compatibility with older assemblers.
5199 @table @t
5200 @item .abort
5201 @item .line
5202 @end table
5203
5204 @ifset GENERIC
5205 @node Machine Dependencies
5206 @chapter Machine Dependent Features
5207
5208 @cindex machine dependencies
5209 The machine instruction sets are (almost by definition) different on
5210 each machine where @code{@value{AS}} runs.  Floating point representations
5211 vary as well, and @code{@value{AS}} often supports a few additional
5212 directives or command-line options for compatibility with other
5213 assemblers on a particular platform.  Finally, some versions of
5214 @code{@value{AS}} support special pseudo-instructions for branch
5215 optimization.
5216
5217 This chapter discusses most of these differences, though it does not
5218 include details on any machine's instruction set.  For details on that
5219 subject, see the hardware manufacturer's manual.
5220
5221 @menu
5222 @ifset A29K
5223 * AMD29K-Dependent::            AMD 29K Dependent Features
5224 @end ifset
5225 @ifset ARC
5226 * ARC-Dependent::               ARC Dependent Features
5227 @end ifset
5228 @ifset ARM
5229 * ARM-Dependent::               ARM Dependent Features
5230 @end ifset
5231 @ifset D10V
5232 * D10V-Dependent::              D10V Dependent Features
5233 @end ifset
5234 @ifset D30V
5235 * D30V-Dependent::              D30V Dependent Features
5236 @end ifset
5237 @ifset H8/300
5238 * H8/300-Dependent::            Hitachi H8/300 Dependent Features
5239 @end ifset
5240 @ifset H8/500
5241 * H8/500-Dependent::            Hitachi H8/500 Dependent Features
5242 @end ifset
5243 @ifset HPPA
5244 * HPPA-Dependent::              HPPA Dependent Features
5245 @end ifset
5246 @ifset I370
5247 * ESA/390-Dependent::           IBM ESA/390 Dependent Features
5248 @end ifset
5249 @ifset I80386
5250 * i386-Dependent::              Intel 80386 and AMD x86-64 Dependent Features
5251 @end ifset
5252 @ifset I860
5253 * i860-Dependent::              Intel 80860 Dependent Features
5254 @end ifset
5255 @ifset I960
5256 * i960-Dependent::              Intel 80960 Dependent Features
5257 @end ifset
5258 @ifset M32R
5259 * M32R-Dependent::              M32R Dependent Features
5260 @end ifset
5261 @ifset M680X0
5262 * M68K-Dependent::              M680x0 Dependent Features
5263 @end ifset
5264 @ifset M68HC11
5265 * M68HC11-Dependent::           M68HC11 and 68HC12 Dependent Features
5266 @end ifset
5267 @ifset MIPS
5268 * MIPS-Dependent::              MIPS Dependent Features
5269 @end ifset
5270 @ifset SH
5271 * SH-Dependent::                Hitachi SH Dependent Features
5272 @end ifset
5273 @ifset PJ
5274 * PJ-Dependent::                picoJava Dependent Features
5275 @end ifset
5276 @ifset SPARC
5277 * Sparc-Dependent::             SPARC Dependent Features
5278 @end ifset
5279 @ifset TIC54X
5280 * TIC54X-Dependent::            TI TMS320C54x Dependent Features
5281 @end ifset
5282 @ifset V850
5283 * V850-Dependent::              V850 Dependent Features
5284 @end ifset
5285 @ifset Z8000
5286 * Z8000-Dependent::             Z8000 Dependent Features
5287 @end ifset
5288 @ifset VAX
5289 * Vax-Dependent::               VAX Dependent Features
5290 @end ifset
5291 @end menu
5292
5293 @lowersections
5294 @end ifset
5295
5296 @c The following major nodes are *sections* in the GENERIC version, *chapters*
5297 @c in single-cpu versions.  This is mainly achieved by @lowersections.  There is a
5298 @c peculiarity: to preserve cross-references, there must be a node called
5299 @c "Machine Dependencies".  Hence the conditional nodenames in each
5300 @c major node below.  Node defaulting in makeinfo requires adjacency of
5301 @c node and sectioning commands; hence the repetition of @chapter BLAH
5302 @c in both conditional blocks.
5303
5304 @ifset ARC
5305 @ifset GENERIC
5306 @page
5307 @node ARC-Dependent
5308 @chapter ARC Dependent Features
5309 @end ifset
5310 @ifclear GENERIC
5311 @node Machine Dependencies
5312 @chapter ARC Dependent Features
5313 @end ifclear
5314
5315 @cindex ARC support
5316 @menu
5317 * ARC-Opts::                    Options
5318 * ARC-Float::                   Floating Point
5319 * ARC-Directives::              Sparc Machine Directives
5320 @end menu
5321
5322 @node ARC-Opts
5323 @section Options
5324
5325 @cindex options for ARC
5326 @cindex ARC options
5327 @cindex architectures, ARC
5328 @cindex ARC architectures
5329 The ARC chip family includes several successive levels (or other
5330 variants) of chip, using the same core instruction set, but including
5331 a few additional instructions at each level.
5332
5333 By default, @code{@value{AS}} assumes the core instruction set (ARC
5334 base).  The @code{.cpu} pseudo-op is intended to be used to select
5335 the variant.
5336
5337 @table @code
5338 @cindex @code{-mbig-endian} option (ARC)
5339 @cindex @code{-mlittle-endian} option (ARC)
5340 @cindex ARC big-endian output
5341 @cindex ARC little-endian output
5342 @cindex big-endian output, ARC
5343 @cindex little-endian output, ARC
5344 @item -mbig-endian
5345 @itemx -mlittle-endian
5346 Any @sc{arc} configuration of @code{@value{AS}} can select big-endian or
5347 little-endian output at run time (unlike most other @sc{gnu} development
5348 tools, which must be configured for one or the other).  Use
5349 @samp{-mbig-endian} to select big-endian output, and @samp{-mlittle-endian}
5350 for little-endian.
5351 @end table
5352
5353 @node ARC-Float
5354 @section Floating Point
5355
5356 @cindex floating point, ARC (@sc{ieee})
5357 @cindex ARC floating point (@sc{ieee})
5358 The ARC cpu family currently does not have hardware floating point
5359 support.  Software floating point support is provided by @code{GCC}
5360 and uses @sc{ieee} floating-point numbers.
5361
5362 @node ARC-Directives
5363 @section ARC Machine Directives
5364
5365 @cindex ARC machine directives
5366 @cindex machine directives, ARC
5367 The ARC version of @code{@value{AS}} supports the following additional
5368 machine directives:
5369
5370 @table @code
5371 @item .cpu
5372 @cindex @code{cpu} directive, SPARC
5373 This must be followed by the desired cpu.
5374 The ARC is intended to be customizable, @code{.cpu} is used to
5375 select the desired variant [though currently there are none].
5376
5377 @end table
5378
5379 @end ifset
5380
5381 @ifset A29K
5382 @include c-a29k.texi
5383 @end ifset
5384
5385 @ifset ARM
5386 @include c-arm.texi
5387 @end ifset
5388
5389 @ifset Hitachi-all
5390 @ifclear GENERIC
5391 @node Machine Dependencies
5392 @chapter Machine Dependent Features
5393
5394 The machine instruction sets are different on each Hitachi chip family,
5395 and there are also some syntax differences among the families.  This
5396 chapter describes the specific @code{@value{AS}} features for each
5397 family.
5398
5399 @menu
5400 * H8/300-Dependent::            Hitachi H8/300 Dependent Features
5401 * H8/500-Dependent::            Hitachi H8/500 Dependent Features
5402 * SH-Dependent::                Hitachi SH Dependent Features
5403 @end menu
5404 @lowersections
5405 @end ifclear
5406 @end ifset
5407
5408 @ifset D10V
5409 @include c-d10v.texi
5410 @end ifset
5411
5412 @ifset D30V
5413 @include c-d30v.texi
5414 @end ifset
5415
5416 @ifset H8/300
5417 @include c-h8300.texi
5418 @end ifset
5419
5420 @ifset H8/500
5421 @include c-h8500.texi
5422 @end ifset
5423
5424 @ifset HPPA
5425 @include c-hppa.texi
5426 @end ifset
5427
5428 @ifset I370
5429 @include c-i370.texi
5430 @end ifset
5431
5432 @ifset I80386
5433 @include c-i386.texi
5434 @end ifset
5435
5436 @ifset I860
5437 @include c-i860.texi
5438 @end ifset
5439
5440 @ifset I960
5441 @include c-i960.texi
5442 @end ifset
5443
5444 @ifset M32R
5445 @include c-m32r.texi
5446 @end ifset
5447
5448 @ifset M680X0
5449 @include c-m68k.texi
5450 @end ifset
5451
5452 @ifset M68HC11
5453 @include c-m68hc11.texi
5454 @end ifset
5455
5456 @ifset MIPS
5457 @include c-mips.texi
5458 @end ifset
5459
5460 @ifset NS32K
5461 @include c-ns32k.texi
5462 @end ifset
5463
5464 @ifset PJ
5465 @include c-pj.texi
5466 @end ifset
5467
5468 @ifset SH
5469 @include c-sh.texi
5470 @end ifset
5471
5472 @ifset SPARC
5473 @include c-sparc.texi
5474 @end ifset
5475
5476 @ifset TIC54X
5477 @include c-tic54x.texi
5478 @end ifset
5479
5480 @ifset Z8000
5481 @include c-z8k.texi
5482 @end ifset
5483
5484 @ifset VAX
5485 @include c-vax.texi
5486 @end ifset
5487
5488 @ifset V850
5489 @include c-v850.texi
5490 @end ifset
5491
5492 @ifset GENERIC
5493 @c reverse effect of @down at top of generic Machine-Dep chapter
5494 @raisesections
5495 @end ifset
5496
5497 @node Reporting Bugs
5498 @chapter Reporting Bugs
5499 @cindex bugs in assembler
5500 @cindex reporting bugs in assembler
5501
5502 Your bug reports play an essential role in making @code{@value{AS}} reliable.
5503
5504 Reporting a bug may help you by bringing a solution to your problem, or it may
5505 not.  But in any case the principal function of a bug report is to help the
5506 entire community by making the next version of @code{@value{AS}} work better.
5507 Bug reports are your contribution to the maintenance of @code{@value{AS}}.
5508
5509 In order for a bug report to serve its purpose, you must include the
5510 information that enables us to fix the bug.
5511
5512 @menu
5513 * Bug Criteria::                Have you found a bug?
5514 * Bug Reporting::               How to report bugs
5515 @end menu
5516
5517 @node Bug Criteria
5518 @section Have you found a bug?
5519 @cindex bug criteria
5520
5521 If you are not sure whether you have found a bug, here are some guidelines:
5522
5523 @itemize @bullet
5524 @cindex fatal signal
5525 @cindex assembler crash
5526 @cindex crash of assembler
5527 @item
5528 If the assembler gets a fatal signal, for any input whatever, that is a
5529 @code{@value{AS}} bug.  Reliable assemblers never crash.
5530
5531 @cindex error on valid input
5532 @item
5533 If @code{@value{AS}} produces an error message for valid input, that is a bug.
5534
5535 @cindex invalid input
5536 @item
5537 If @code{@value{AS}} does not produce an error message for invalid input, that
5538 is a bug.  However, you should note that your idea of ``invalid input'' might
5539 be our idea of ``an extension'' or ``support for traditional practice''.
5540
5541 @item
5542 If you are an experienced user of assemblers, your suggestions for improvement
5543 of @code{@value{AS}} are welcome in any case.
5544 @end itemize
5545
5546 @node Bug Reporting
5547 @section How to report bugs
5548 @cindex bug reports
5549 @cindex assembler bugs, reporting
5550
5551 A number of companies and individuals offer support for @sc{gnu} products.  If
5552 you obtained @code{@value{AS}} from a support organization, we recommend you
5553 contact that organization first.
5554
5555 You can find contact information for many support companies and
5556 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5557 distribution.
5558
5559 In any event, we also recommend that you send bug reports for @code{@value{AS}}
5560 to @samp{bug-gnu-utils@@gnu.org}.
5561
5562 The fundamental principle of reporting bugs usefully is this:
5563 @strong{report all the facts}.  If you are not sure whether to state a
5564 fact or leave it out, state it!
5565
5566 Often people omit facts because they think they know what causes the problem
5567 and assume that some details do not matter.  Thus, you might assume that the
5568 name of a symbol you use in an example does not matter.  Well, probably it does
5569 not, but one cannot be sure.  Perhaps the bug is a stray memory reference which
5570 happens to fetch from the location where that name is stored in memory;
5571 perhaps, if the name were different, the contents of that location would fool
5572 the assembler into doing the right thing despite the bug.  Play it safe and
5573 give a specific, complete example.  That is the easiest thing for you to do,
5574 and the most helpful.
5575
5576 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5577 it is new to us.  Therefore, always write your bug reports on the assumption
5578 that the bug has not been reported previously.
5579
5580 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5581 bell?''  Those bug reports are useless, and we urge everyone to
5582 @emph{refuse to respond to them} except to chide the sender to report
5583 bugs properly.
5584
5585 To enable us to fix the bug, you should include all these things:
5586
5587 @itemize @bullet
5588 @item
5589 The version of @code{@value{AS}}.  @code{@value{AS}} announces it if you start
5590 it with the @samp{--version} argument.
5591
5592 Without this, we will not know whether there is any point in looking for
5593 the bug in the current version of @code{@value{AS}}.
5594
5595 @item
5596 Any patches you may have applied to the @code{@value{AS}} source.
5597
5598 @item
5599 The type of machine you are using, and the operating system name and
5600 version number.
5601
5602 @item
5603 What compiler (and its version) was used to compile @code{@value{AS}}---e.g.
5604 ``@code{gcc-2.7}''.
5605
5606 @item
5607 The command arguments you gave the assembler to assemble your example and
5608 observe the bug.  To guarantee you will not omit something important, list them
5609 all.  A copy of the Makefile (or the output from make) is sufficient.
5610
5611 If we were to try to guess the arguments, we would probably guess wrong
5612 and then we might not encounter the bug.
5613
5614 @item
5615 A complete input file that will reproduce the bug.  If the bug is observed when
5616 the assembler is invoked via a compiler, send the assembler source, not the
5617 high level language source.  Most compilers will produce the assembler source
5618 when run with the @samp{-S} option.  If you are using @code{@value{GCC}}, use
5619 the options @samp{-v --save-temps}; this will save the assembler source in a
5620 file with an extension of @file{.s}, and also show you exactly how
5621 @code{@value{AS}} is being run.
5622
5623 @item
5624 A description of what behavior you observe that you believe is
5625 incorrect.  For example, ``It gets a fatal signal.''
5626
5627 Of course, if the bug is that @code{@value{AS}} gets a fatal signal, then we
5628 will certainly notice it.  But if the bug is incorrect output, we might not
5629 notice unless it is glaringly wrong.  You might as well not give us a chance to
5630 make a mistake.
5631
5632 Even if the problem you experience is a fatal signal, you should still say so
5633 explicitly.  Suppose something strange is going on, such as, your copy of
5634 @code{@value{AS}} is out of synch, or you have encountered a bug in the C
5635 library on your system.  (This has happened!)  Your copy might crash and ours
5636 would not.  If you told us to expect a crash, then when ours fails to crash, we
5637 would know that the bug was not happening for us.  If you had not told us to
5638 expect a crash, then we would not be able to draw any conclusion from our
5639 observations.
5640
5641 @item
5642 If you wish to suggest changes to the @code{@value{AS}} source, send us context
5643 diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
5644 option.  Always send diffs from the old file to the new file.  If you even
5645 discuss something in the @code{@value{AS}} source, refer to it by context, not
5646 by line number.
5647
5648 The line numbers in our development sources will not match those in your
5649 sources.  Your line numbers would convey no useful information to us.
5650 @end itemize
5651
5652 Here are some things that are not necessary:
5653
5654 @itemize @bullet
5655 @item
5656 A description of the envelope of the bug.
5657
5658 Often people who encounter a bug spend a lot of time investigating
5659 which changes to the input file will make the bug go away and which
5660 changes will not affect it.
5661
5662 This is often time consuming and not very useful, because the way we
5663 will find the bug is by running a single example under the debugger
5664 with breakpoints, not by pure deduction from a series of examples.
5665 We recommend that you save your time for something else.
5666
5667 Of course, if you can find a simpler example to report @emph{instead}
5668 of the original one, that is a convenience for us.  Errors in the
5669 output will be easier to spot, running under the debugger will take
5670 less time, and so on.
5671
5672 However, simplification is not vital; if you do not want to do this,
5673 report the bug anyway and send us the entire test case you used.
5674
5675 @item
5676 A patch for the bug.
5677
5678 A patch for the bug does help us if it is a good one.  But do not omit
5679 the necessary information, such as the test case, on the assumption that
5680 a patch is all we need.  We might see problems with your patch and decide
5681 to fix the problem another way, or we might not understand it at all.
5682
5683 Sometimes with a program as complicated as @code{@value{AS}} it is very hard to
5684 construct an example that will make the program follow a certain path through
5685 the code.  If you do not send us the example, we will not be able to construct
5686 one, so we will not be able to verify that the bug is fixed.
5687
5688 And if we cannot understand what bug you are trying to fix, or why your
5689 patch should be an improvement, we will not install it.  A test case will
5690 help us to understand.
5691
5692 @item
5693 A guess about what the bug is or what it depends on.
5694
5695 Such guesses are usually wrong.  Even we cannot guess right about such
5696 things without first using the debugger to find the facts.
5697 @end itemize
5698
5699 @node Acknowledgements
5700 @chapter Acknowledgements
5701
5702 If you have contributed to @code{@value{AS}} and your name isn't listed here,
5703 it is not meant as a slight.  We just don't know about it.  Send mail to the
5704 maintainer, and we'll correct the situation.  Currently 
5705 @c (January 1994), 
5706 the maintainer is Ken Raeburn (email address @code{raeburn@@cygnus.com}).
5707
5708 Dean Elsner wrote the original @sc{gnu} assembler for the VAX.@footnote{Any
5709 more details?}
5710
5711 Jay Fenlason maintained GAS for a while, adding support for GDB-specific debug
5712 information and the 68k series machines, most of the preprocessing pass, and
5713 extensive changes in @file{messages.c}, @file{input-file.c}, @file{write.c}.
5714
5715 K. Richard Pixley maintained GAS for a while, adding various enhancements and
5716 many bug fixes, including merging support for several processors, breaking GAS
5717 up to handle multiple object file format back ends (including heavy rewrite,
5718 testing, an integration of the coff and b.out back ends), adding configuration
5719 including heavy testing and verification of cross assemblers and file splits
5720 and renaming, converted GAS to strictly ANSI C including full prototypes, added
5721 support for m680[34]0 and cpu32, did considerable work on i960 including a COFF
5722 port (including considerable amounts of reverse engineering), a SPARC opcode
5723 file rewrite, DECstation, rs6000, and hp300hpux host ports, updated ``know''
5724 assertions and made them work, much other reorganization, cleanup, and lint.
5725
5726 Ken Raeburn wrote the high-level BFD interface code to replace most of the code
5727 in format-specific I/O modules.
5728
5729 The original VMS support was contributed by David L. Kashtan.  Eric Youngdale
5730 has done much work with it since.
5731
5732 The Intel 80386 machine description was written by Eliot Dresselhaus.
5733
5734 Minh Tran-Le at IntelliCorp contributed some AIX 386 support.
5735
5736 The Motorola 88k machine description was contributed by Devon Bowen of Buffalo
5737 University and Torbjorn Granlund of the Swedish Institute of Computer Science.
5738
5739 Keith Knowles at the Open Software Foundation wrote the original MIPS back end
5740 (@file{tc-mips.c}, @file{tc-mips.h}), and contributed Rose format support
5741 (which hasn't been merged in yet).  Ralph Campbell worked with the MIPS code to
5742 support a.out format.
5743
5744 Support for the Zilog Z8k and Hitachi H8/300 and H8/500 processors (tc-z8k,
5745 tc-h8300, tc-h8500), and IEEE 695 object file format (obj-ieee), was written by
5746 Steve Chamberlain of Cygnus Support.  Steve also modified the COFF back end to
5747 use BFD for some low-level operations, for use with the H8/300 and AMD 29k
5748 targets.
5749
5750 John Gilmore built the AMD 29000 support, added @code{.include} support, and
5751 simplified the configuration of which versions accept which directives.  He
5752 updated the 68k machine description so that Motorola's opcodes always produced
5753 fixed-size instructions (e.g. @code{jsr}), while synthetic instructions
5754 remained shrinkable (@code{jbsr}).  John fixed many bugs, including true tested
5755 cross-compilation support, and one bug in relaxation that took a week and
5756 required the proverbial one-bit fix.
5757
5758 Ian Lance Taylor of Cygnus Support merged the Motorola and MIT syntax for the
5759 68k, completed support for some COFF targets (68k, i386 SVR3, and SCO Unix),
5760 added support for MIPS ECOFF and ELF targets, wrote the initial RS/6000 and
5761 PowerPC assembler, and made a few other minor patches.
5762
5763 Steve Chamberlain made @code{@value{AS}} able to generate listings.
5764
5765 Hewlett-Packard contributed support for the HP9000/300.
5766
5767 Jeff Law wrote GAS and BFD support for the native HPPA object format (SOM)
5768 along with a fairly extensive HPPA testsuite (for both SOM and ELF object
5769 formats).  This work was supported by both the Center for Software Science at
5770 the University of Utah and Cygnus Support.
5771
5772 Support for ELF format files has been worked on by Mark Eichin of Cygnus
5773 Support (original, incomplete implementation for SPARC), Pete Hoogenboom and
5774 Jeff Law at the University of Utah (HPPA mainly), Michael Meissner of the Open
5775 Software Foundation (i386 mainly), and Ken Raeburn of Cygnus Support (sparc,
5776 and some initial 64-bit support).
5777
5778 Linas Vepstas added GAS support for the ESA/390 "IBM 370" architecture.
5779
5780 Richard Henderson rewrote the Alpha assembler. Klaus Kaempf wrote GAS and BFD
5781 support for openVMS/Alpha.
5782
5783 Timothy Wall, Michael Hayes, and Greg Smart contributed to the various tic*
5784 flavors.
5785
5786 Several engineers at Cygnus Support have also provided many small bug fixes and
5787 configuration enhancements.
5788
5789 Many others have contributed large or small bugfixes and enhancements.  If
5790 you have contributed significant work and are not mentioned on this list, and
5791 want to be, let us know.  Some of the history has been lost; we are not
5792 intentionally leaving anyone out.
5793
5794 @node GNU Free Documentation License
5795 @chapter GNU Free Documentation License
5796
5797                 GNU Free Documentation License
5798                 
5799                    Version 1.1, March 2000
5800
5801  Copyright (C) 2000  Free Software Foundation, Inc.
5802   59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
5803      
5804  Everyone is permitted to copy and distribute verbatim copies
5805  of this license document, but changing it is not allowed.
5806
5807
5808 0. PREAMBLE
5809
5810 The purpose of this License is to make a manual, textbook, or other
5811 written document "free" in the sense of freedom: to assure everyone
5812 the effective freedom to copy and redistribute it, with or without
5813 modifying it, either commercially or noncommercially.  Secondarily,
5814 this License preserves for the author and publisher a way to get
5815 credit for their work, while not being considered responsible for
5816 modifications made by others.
5817
5818 This License is a kind of "copyleft", which means that derivative
5819 works of the document must themselves be free in the same sense.  It
5820 complements the GNU General Public License, which is a copyleft
5821 license designed for free software.
5822
5823 We have designed this License in order to use it for manuals for free
5824 software, because free software needs free documentation: a free
5825 program should come with manuals providing the same freedoms that the
5826 software does.  But this License is not limited to software manuals;
5827 it can be used for any textual work, regardless of subject matter or
5828 whether it is published as a printed book.  We recommend this License
5829 principally for works whose purpose is instruction or reference.
5830
5831
5832 1. APPLICABILITY AND DEFINITIONS
5833
5834 This License applies to any manual or other work that contains a
5835 notice placed by the copyright holder saying it can be distributed
5836 under the terms of this License.  The "Document", below, refers to any
5837 such manual or work.  Any member of the public is a licensee, and is
5838 addressed as "you".
5839
5840 A "Modified Version" of the Document means any work containing the
5841 Document or a portion of it, either copied verbatim, or with
5842 modifications and/or translated into another language.
5843
5844 A "Secondary Section" is a named appendix or a front-matter section of
5845 the Document that deals exclusively with the relationship of the
5846 publishers or authors of the Document to the Document's overall subject
5847 (or to related matters) and contains nothing that could fall directly
5848 within that overall subject.  (For example, if the Document is in part a
5849 textbook of mathematics, a Secondary Section may not explain any
5850 mathematics.)  The relationship could be a matter of historical
5851 connection with the subject or with related matters, or of legal,
5852 commercial, philosophical, ethical or political position regarding
5853 them.
5854
5855 The "Invariant Sections" are certain Secondary Sections whose titles
5856 are designated, as being those of Invariant Sections, in the notice
5857 that says that the Document is released under this License.
5858
5859 The "Cover Texts" are certain short passages of text that are listed,
5860 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
5861 the Document is released under this License.
5862
5863 A "Transparent" copy of the Document means a machine-readable copy,
5864 represented in a format whose specification is available to the
5865 general public, whose contents can be viewed and edited directly and
5866 straightforwardly with generic text editors or (for images composed of
5867 pixels) generic paint programs or (for drawings) some widely available
5868 drawing editor, and that is suitable for input to text formatters or
5869 for automatic translation to a variety of formats suitable for input
5870 to text formatters.  A copy made in an otherwise Transparent file
5871 format whose markup has been designed to thwart or discourage
5872 subsequent modification by readers is not Transparent.  A copy that is
5873 not "Transparent" is called "Opaque".
5874
5875 Examples of suitable formats for Transparent copies include plain
5876 ASCII without markup, Texinfo input format, LaTeX input format, SGML
5877 or XML using a publicly available DTD, and standard-conforming simple
5878 HTML designed for human modification.  Opaque formats include
5879 PostScript, PDF, proprietary formats that can be read and edited only
5880 by proprietary word processors, SGML or XML for which the DTD and/or
5881 processing tools are not generally available, and the
5882 machine-generated HTML produced by some word processors for output
5883 purposes only.
5884
5885 The "Title Page" means, for a printed book, the title page itself,
5886 plus such following pages as are needed to hold, legibly, the material
5887 this License requires to appear in the title page.  For works in
5888 formats which do not have any title page as such, "Title Page" means
5889 the text near the most prominent appearance of the work's title,
5890 preceding the beginning of the body of the text.
5891
5892
5893 2. VERBATIM COPYING
5894
5895 You may copy and distribute the Document in any medium, either
5896 commercially or noncommercially, provided that this License, the
5897 copyright notices, and the license notice saying this License applies
5898 to the Document are reproduced in all copies, and that you add no other
5899 conditions whatsoever to those of this License.  You may not use
5900 technical measures to obstruct or control the reading or further
5901 copying of the copies you make or distribute.  However, you may accept
5902 compensation in exchange for copies.  If you distribute a large enough
5903 number of copies you must also follow the conditions in section 3.
5904
5905 You may also lend copies, under the same conditions stated above, and
5906 you may publicly display copies.
5907
5908
5909 3. COPYING IN QUANTITY
5910
5911 If you publish printed copies of the Document numbering more than 100,
5912 and the Document's license notice requires Cover Texts, you must enclose
5913 the copies in covers that carry, clearly and legibly, all these Cover
5914 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
5915 the back cover.  Both covers must also clearly and legibly identify
5916 you as the publisher of these copies.  The front cover must present
5917 the full title with all words of the title equally prominent and
5918 visible.  You may add other material on the covers in addition.
5919 Copying with changes limited to the covers, as long as they preserve
5920 the title of the Document and satisfy these conditions, can be treated
5921 as verbatim copying in other respects.
5922
5923 If the required texts for either cover are too voluminous to fit
5924 legibly, you should put the first ones listed (as many as fit
5925 reasonably) on the actual cover, and continue the rest onto adjacent
5926 pages.
5927
5928 If you publish or distribute Opaque copies of the Document numbering
5929 more than 100, you must either include a machine-readable Transparent
5930 copy along with each Opaque copy, or state in or with each Opaque copy
5931 a publicly-accessible computer-network location containing a complete
5932 Transparent copy of the Document, free of added material, which the
5933 general network-using public has access to download anonymously at no
5934 charge using public-standard network protocols.  If you use the latter
5935 option, you must take reasonably prudent steps, when you begin
5936 distribution of Opaque copies in quantity, to ensure that this
5937 Transparent copy will remain thus accessible at the stated location
5938 until at least one year after the last time you distribute an Opaque
5939 copy (directly or through your agents or retailers) of that edition to
5940 the public.
5941
5942 It is requested, but not required, that you contact the authors of the
5943 Document well before redistributing any large number of copies, to give
5944 them a chance to provide you with an updated version of the Document.
5945
5946
5947 4. MODIFICATIONS
5948
5949 You may copy and distribute a Modified Version of the Document under
5950 the conditions of sections 2 and 3 above, provided that you release
5951 the Modified Version under precisely this License, with the Modified
5952 Version filling the role of the Document, thus licensing distribution
5953 and modification of the Modified Version to whoever possesses a copy
5954 of it.  In addition, you must do these things in the Modified Version:
5955
5956 A. Use in the Title Page (and on the covers, if any) a title distinct
5957    from that of the Document, and from those of previous versions
5958    (which should, if there were any, be listed in the History section
5959    of the Document).  You may use the same title as a previous version
5960    if the original publisher of that version gives permission.
5961 B. List on the Title Page, as authors, one or more persons or entities
5962    responsible for authorship of the modifications in the Modified
5963    Version, together with at least five of the principal authors of the
5964    Document (all of its principal authors, if it has less than five).
5965 C. State on the Title page the name of the publisher of the
5966    Modified Version, as the publisher.
5967 D. Preserve all the copyright notices of the Document.
5968 E. Add an appropriate copyright notice for your modifications
5969    adjacent to the other copyright notices.
5970 F. Include, immediately after the copyright notices, a license notice
5971    giving the public permission to use the Modified Version under the
5972    terms of this License, in the form shown in the Addendum below.
5973 G. Preserve in that license notice the full lists of Invariant Sections
5974    and required Cover Texts given in the Document's license notice.
5975 H. Include an unaltered copy of this License.
5976 I. Preserve the section entitled "History", and its title, and add to
5977    it an item stating at least the title, year, new authors, and
5978    publisher of the Modified Version as given on the Title Page.  If
5979    there is no section entitled "History" in the Document, create one
5980    stating the title, year, authors, and publisher of the Document as
5981    given on its Title Page, then add an item describing the Modified
5982    Version as stated in the previous sentence.
5983 J. Preserve the network location, if any, given in the Document for
5984    public access to a Transparent copy of the Document, and likewise
5985    the network locations given in the Document for previous versions
5986    it was based on.  These may be placed in the "History" section.
5987    You may omit a network location for a work that was published at
5988    least four years before the Document itself, or if the original
5989    publisher of the version it refers to gives permission.
5990 K. In any section entitled "Acknowledgements" or "Dedications",
5991    preserve the section's title, and preserve in the section all the
5992    substance and tone of each of the contributor acknowledgements
5993    and/or dedications given therein.
5994 L. Preserve all the Invariant Sections of the Document,
5995    unaltered in their text and in their titles.  Section numbers
5996    or the equivalent are not considered part of the section titles.
5997 M. Delete any section entitled "Endorsements".  Such a section
5998    may not be included in the Modified Version.
5999 N. Do not retitle any existing section as "Endorsements"
6000    or to conflict in title with any Invariant Section.
6001
6002 If the Modified Version includes new front-matter sections or
6003 appendices that qualify as Secondary Sections and contain no material
6004 copied from the Document, you may at your option designate some or all
6005 of these sections as invariant.  To do this, add their titles to the
6006 list of Invariant Sections in the Modified Version's license notice.
6007 These titles must be distinct from any other section titles.
6008
6009 You may add a section entitled "Endorsements", provided it contains
6010 nothing but endorsements of your Modified Version by various
6011 parties--for example, statements of peer review or that the text has
6012 been approved by an organization as the authoritative definition of a
6013 standard.
6014
6015 You may add a passage of up to five words as a Front-Cover Text, and a
6016 passage of up to 25 words as a Back-Cover Text, to the end of the list
6017 of Cover Texts in the Modified Version.  Only one passage of
6018 Front-Cover Text and one of Back-Cover Text may be added by (or
6019 through arrangements made by) any one entity.  If the Document already
6020 includes a cover text for the same cover, previously added by you or
6021 by arrangement made by the same entity you are acting on behalf of,
6022 you may not add another; but you may replace the old one, on explicit
6023 permission from the previous publisher that added the old one.
6024
6025 The author(s) and publisher(s) of the Document do not by this License
6026 give permission to use their names for publicity for or to assert or
6027 imply endorsement of any Modified Version.
6028
6029
6030 5. COMBINING DOCUMENTS
6031
6032 You may combine the Document with other documents released under this
6033 License, under the terms defined in section 4 above for modified
6034 versions, provided that you include in the combination all of the
6035 Invariant Sections of all of the original documents, unmodified, and
6036 list them all as Invariant Sections of your combined work in its
6037 license notice.
6038
6039 The combined work need only contain one copy of this License, and
6040 multiple identical Invariant Sections may be replaced with a single
6041 copy.  If there are multiple Invariant Sections with the same name but
6042 different contents, make the title of each such section unique by
6043 adding at the end of it, in parentheses, the name of the original
6044 author or publisher of that section if known, or else a unique number.
6045 Make the same adjustment to the section titles in the list of
6046 Invariant Sections in the license notice of the combined work.
6047
6048 In the combination, you must combine any sections entitled "History"
6049 in the various original documents, forming one section entitled
6050 "History"; likewise combine any sections entitled "Acknowledgements",
6051 and any sections entitled "Dedications".  You must delete all sections
6052 entitled "Endorsements."
6053
6054
6055 6. COLLECTIONS OF DOCUMENTS
6056
6057 You may make a collection consisting of the Document and other documents
6058 released under this License, and replace the individual copies of this
6059 License in the various documents with a single copy that is included in
6060 the collection, provided that you follow the rules of this License for
6061 verbatim copying of each of the documents in all other respects.
6062
6063 You may extract a single document from such a collection, and distribute
6064 it individually under this License, provided you insert a copy of this
6065 License into the extracted document, and follow this License in all
6066 other respects regarding verbatim copying of that document.
6067
6068
6069 7. AGGREGATION WITH INDEPENDENT WORKS
6070
6071 A compilation of the Document or its derivatives with other separate
6072 and independent documents or works, in or on a volume of a storage or
6073 distribution medium, does not as a whole count as a Modified Version
6074 of the Document, provided no compilation copyright is claimed for the
6075 compilation.  Such a compilation is called an "aggregate", and this
6076 License does not apply to the other self-contained works thus compiled
6077 with the Document, on account of their being thus compiled, if they
6078 are not themselves derivative works of the Document.
6079
6080 If the Cover Text requirement of section 3 is applicable to these
6081 copies of the Document, then if the Document is less than one quarter
6082 of the entire aggregate, the Document's Cover Texts may be placed on
6083 covers that surround only the Document within the aggregate.
6084 Otherwise they must appear on covers around the whole aggregate.
6085
6086
6087 8. TRANSLATION
6088
6089 Translation is considered a kind of modification, so you may
6090 distribute translations of the Document under the terms of section 4.
6091 Replacing Invariant Sections with translations requires special
6092 permission from their copyright holders, but you may include
6093 translations of some or all Invariant Sections in addition to the
6094 original versions of these Invariant Sections.  You may include a
6095 translation of this License provided that you also include the
6096 original English version of this License.  In case of a disagreement
6097 between the translation and the original English version of this
6098 License, the original English version will prevail.
6099
6100
6101 9. TERMINATION
6102
6103 You may not copy, modify, sublicense, or distribute the Document except
6104 as expressly provided for under this License.  Any other attempt to
6105 copy, modify, sublicense or distribute the Document is void, and will
6106 automatically terminate your rights under this License.  However,
6107 parties who have received copies, or rights, from you under this
6108 License will not have their licenses terminated so long as such
6109 parties remain in full compliance.
6110
6111
6112 10. FUTURE REVISIONS OF THIS LICENSE
6113
6114 The Free Software Foundation may publish new, revised versions
6115 of the GNU Free Documentation License from time to time.  Such new
6116 versions will be similar in spirit to the present version, but may
6117 differ in detail to address new problems or concerns.  See
6118 http://www.gnu.org/copyleft/.
6119
6120 Each version of the License is given a distinguishing version number.
6121 If the Document specifies that a particular numbered version of this
6122 License "or any later version" applies to it, you have the option of
6123 following the terms and conditions either of that specified version or
6124 of any later version that has been published (not as a draft) by the
6125 Free Software Foundation.  If the Document does not specify a version
6126 number of this License, you may choose any version ever published (not
6127 as a draft) by the Free Software Foundation.
6128
6129
6130 ADDENDUM: How to use this License for your documents
6131
6132 To use this License in a document you have written, include a copy of
6133 the License in the document and put the following copyright and
6134 license notices just after the title page:
6135
6136 @smallexample
6137     Copyright (c)  YEAR  YOUR NAME.
6138     Permission is granted to copy, distribute and/or modify this document
6139     under the terms of the GNU Free Documentation License, Version 1.1
6140     or any later version published by the Free Software Foundation;
6141     with the Invariant Sections being LIST THEIR TITLES, with the
6142     Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
6143     A copy of the license is included in the section entitled "GNU
6144     Free Documentation License".
6145 @end smallexample
6146
6147 If you have no Invariant Sections, write "with no Invariant Sections"
6148 instead of saying which ones are invariant.  If you have no
6149 Front-Cover Texts, write "no Front-Cover Texts" instead of
6150 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
6151
6152 If your document contains nontrivial examples of program code, we
6153 recommend releasing these examples in parallel under your choice of
6154 free software license, such as the GNU General Public License,
6155 to permit their use in free software.
6156
6157 @node Index
6158 @unnumbered Index
6159
6160 @printindex cp
6161
6162 @contents
6163 @bye
6164 @c Local Variables:
6165 @c fill-column: 79
6166 @c End: