Command-Line Options

This chapter describes command-line options available in all versions of the GNU assembler; @xref{Machine Dependencies}, for options specific to the .

If you are invoking via the GNU C compiler (version 2), you can use the `-Wa' option to pass arguments through to the assembler. The assembler arguments must be separated from each other (and the `-Wa') by commas. For example:

gcc -c -g -O -Wa,-alh,-L file.c

emits a listing to standard output with high-level and assembly source.

Usually you do not need to use this `-Wa' mechanism, since many compiler command-line options are automatically passed to the assembler by the compiler. (You can call the GNU compiler driver with the `-v' option to see precisely what options it passes to each compilation pass, including the assembler.)

• a: -a[dhlns] enable listings
• D: -D for compatibility
• f: -f to work faster
• I: -I for .include search path
• K: -K for compatibility
• L: -L to retain local labels
• M: -M or --mri to assemble in MRI compatibility mode
• o: -o to name the object file
• R: -R to join data and text sections
• statistics: --statistics to see statistics about assembly
• v: -v to announce version
• W: -W to suppress warnings
• Z: -Z to make object file even after errors

Enable Listings: -a[dhlns]

These options enable listing output from the assembler. By itself, `-a' requests high-level, assembly, and symbols listing. You can use other letters to select specific options for the list: `-ah' requests a high-level language listing, `-al' requests an output-program assembly listing, and `-as' requests a symbol table listing. High-level listings require that a compiler debugging option like `-g' be used, and that assembly listings (`-al') be requested also.

Use the `-ad' option to omit debugging directives from the listing.

Once you have specified one of these options, you can further control listing output and its appearance using the directives .list, .nolist, .psize, .eject, .title, and .sbttl. The `-an' option turns off all forms processing. If you do not request listing output with one of the `-a' options, the listing-control directives have no effect.

The letters after `-a' may be combined into one option, e.g., `-aln'.

-D

This option has no effect whatsoever, but it is accepted to make it more likely that scripts written for other assemblers also work with .

Work Faster: -f

`-f' should only be used when assembling programs written by a (trusted) compiler. `-f' stops the assembler from doing whitespace and comment preprocessing on the input file(s) before assembling them. See section Preprocessing.

Warning: if you use `-f' when the files actually need to be preprocessed (if they contain comments, for example), does not work correctly.

.include search path: -I path

Use this option to add a path to the list of directories searches for files specified in .include directives (see section .include "file"). You may use -I as many times as necessary to include a variety of paths. The current working directory is always searched first; after that, searches any `-I' directories in the same order as they were specified (left to right) on the command line.

Difference Tables: -K

On the family, this option is allowed, but has no effect. It is permitted for compatibility with the GNU assembler on other platforms, where it can be used to warn when the assembler alters the machine code generated for `.word' directives in difference tables. The family does not have the addressing limitations that sometimes lead to this alteration on other platforms.

Include Local Labels: -L

Labels beginning with `L' (upper case only) are called local labels. See section Symbol Names. Normally you do not see such labels when debugging, because they are intended for the use of programs (like compilers) that compose assembler programs, not for your notice. Normally both and discard such labels, so you do not normally debug with them.

This option tells to retain those `L...' symbols in the object file. Usually if you do this you also tell the linker to preserve symbols whose names begin with `L'.

By default, a local label is any label beginning with `L', but each target is allowed to redefine the local label prefix.

Assemble in MRI Compatibility Mode: -M

The -M or --mri option selects MRI compatibility mode. This changes the syntax and pseudo-op handling of to make it compatible with the ASM68K or the ASM960 (depending upon the configured target) assembler from Microtec Research. The exact nature of the MRI syntax will not be documented here; see the MRI manuals for more information. The purpose of this option is to permit assembling existing MRI assembler code using .

The MRI compatibility is not complete. Certain operations of the MRI assembler depend upon its object file format, and can not be supported using other object file formats. Supporting these would require enhancing each object file format individually. These are:

• global symbols in common section The m68k MRI assembler supports common sections which are merged by the linker. Other object file formats do not support this. handles common sections by treating them as a single common symbol. It permits local symbols to be defined within a common section, but it can not support global symbols, since it has no way to describe them.
• complex relocations The MRI assemblers support relocations against a negated section address, and relocations which combine the start addresses of two or more sections. These are not support by other object file formats.
• END pseudo-op specifying start address The MRI END pseudo-op permits the specification of a start address. This is not supported by other object file formats. The start address may instead be specified using the -e option to the linker, or in a linker script.
• IDNT, .ident and NAME pseudo-ops The MRI IDNT, .ident and NAME pseudo-ops assign a module name to the output file. This is not supported by other object file formats.
• ORG pseudo-op The m68k MRI ORG pseudo-op begins an absolute section at a given address. This differs from the usual .org pseudo-op, which changes the location within the current section. Absolute sections are not supported by other object file formats. The address of a section may be assigned within a linker script.

There are some other features of the MRI assembler which are not supported by , typically either because they are difficult or because they seem of little consequence. Some of these may be supported in future releases.

• EBCDIC strings EBCDIC strings are not supported.
• packed binary coded decimal Packed binary coded decimal is not supported. This means that the DC.P and DCB.P pseudo-ops are not supported.
• FEQU pseudo-op The m68k FEQU pseudo-op is not supported.
• NOOBJ pseudo-op The m68k NOOBJ pseudo-op is not supported.
• OPT branch control options The m68k OPT branch control options---B, BRS, BRB, BRL, and BRW---are ignored. automatically relaxes all branches, whether forward or backward, to an appropriate size, so these options serve no purpose.
• OPT list control options The following m68k OPT list control options are ignored: C, CEX, CL, CRE, E, G, I, M, MEX, MC, MD, X.
• other OPT options The following m68k OPT options are ignored: NEST, O, OLD, OP, P, PCO, PCR, PCS, R.
• OPT D option is default The m68k OPT D option is the default, unlike the MRI assembler. OPT NOD may be used to turn it off.
• XREF pseudo-op. The m68k XREF pseudo-op is ignored.
• .debug pseudo-op The i960 .debug pseudo-op is not supported.
• .extended pseudo-op The i960 .extended pseudo-op is not supported.
• .list pseudo-op. The various options of the i960 .list pseudo-op are not supported.
• .optimize pseudo-op The i960 .optimize pseudo-op is not supported.
• .output pseudo-op The i960 .output pseudo-op is not supported.
• .setreal pseudo-op The i960 .setreal pseudo-op is not supported.

Name the Object File: -o

There is always one object file output when you run . By default it has the name `a.out'. `a.out'. You use this option (which takes exactly one filename) to give the object file a different name.

Whatever the object file is called, overwrites any existing file of the same name.

Join Data and Text Sections: -R

-R tells to write the object file as if all data-section data lives in the text section. This is only done at the very last moment: your binary data are the same, but data section parts are relocated differently. The data section part of your object file is zero bytes long because all its bytes are appended to the text section. (See section Sections and Relocation.)

When you specify -R it would be possible to generate shorter address displacements (because we do not have to cross between text and data section). We refrain from doing this simply for compatibility with older versions of . In future, -R may work this way.

Display Assembly Statistics: --statistics

Use `--statistics' to display two statistics about the resources used by : the maximum amount of space allocated during the assembly (in bytes), and the total execution time taken for the assembly (in CPU seconds).

Announce Version: -v

You can find out what version of as is running by including the option `-v' (which you can also spell as `-version') on the command line.

Suppress Warnings: -W

should never give a warning or error message when assembling compiler output. But programs written by people often cause to give a warning that a particular assumption was made. All such warnings are directed to the standard error file. If you use this option, no warnings are issued. This option only affects the warning messages: it does not change any particular of how assembles your file. Errors, which stop the assembly, are still reported.

Generate Object File in Spite of Errors: -Z

After an error message, normally produces no output. If for some reason you are interested in object file output even after gives an error message on your program, use the `-Z' option. If there are any errors, continues anyways, and writes an object file after a final warning message of the form `n errors, m warnings, generating bad object file.'