|
Packit Service |
3b8507 |
'\" t
|
|
Packit Service |
3b8507 |
.\" Title: nasm
|
|
Packit Service |
3b8507 |
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
|
|
Packit Service |
3b8507 |
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
|
|
Packit Service |
3b8507 |
.\" Date: 07/17/2020
|
|
Packit Service |
3b8507 |
.\" Manual: The Netwide Assembler Project
|
|
Packit Service |
3b8507 |
.\" Source: NASM
|
|
Packit Service |
3b8507 |
.\" Language: English
|
|
Packit Service |
3b8507 |
.\"
|
|
Packit Service |
3b8507 |
.TH "NASM" "1" "07/17/2020" "NASM" "The Netwide Assembler Project"
|
|
Packit Service |
3b8507 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
3b8507 |
.\" * Define some portability stuff
|
|
Packit Service |
3b8507 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
3b8507 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Packit Service |
3b8507 |
.\" http://bugs.debian.org/507673
|
|
Packit Service |
3b8507 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
Packit Service |
3b8507 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Packit Service |
3b8507 |
.ie \n(.g .ds Aq \(aq
|
|
Packit Service |
3b8507 |
.el .ds Aq '
|
|
Packit Service |
3b8507 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
3b8507 |
.\" * set default formatting
|
|
Packit Service |
3b8507 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
3b8507 |
.\" disable hyphenation
|
|
Packit Service |
3b8507 |
.nh
|
|
Packit Service |
3b8507 |
.\" disable justification (adjust text to left margin only)
|
|
Packit Service |
3b8507 |
.ad l
|
|
Packit Service |
3b8507 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
3b8507 |
.\" * MAIN CONTENT STARTS HERE *
|
|
Packit Service |
3b8507 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
3b8507 |
.SH "NAME"
|
|
Packit Service |
3b8507 |
nasm \- the Netwide Assembler, a portable 80x86 assembler
|
|
Packit Service |
3b8507 |
.SH "SYNOPSIS"
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fBnasm\fR [\fB\-@\fR response file] [\fB\-f\fR format] [\fB\-o\fR outfile] [\fB\-l\fR listfile] [\fIoptions\fR\&...] filename
|
|
Packit Service |
3b8507 |
.SH "DESCRIPTION"
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
The \fBnasm\fR command assembles the file \fIfilename\fR and directs output to the file \fIoutfile\fR if specified\&. If \fIoutfile\fR is not specified, \fBnasm\fR will derive a default output file name from the name of its input file, usually by appending \(oq\&.o\(cq or \(oq\&.obj\(cq, or by removing all extensions for a raw binary file\&. Failing that, the output file name will be \(oqnasm\&.out\(cq\&.
|
|
Packit Service |
3b8507 |
.SH "OPTIONS"
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-@\fR \fIfilename\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to process options from filename as if they were included on the command line\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-a\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to assemble the given input file without first applying the macro preprocessor\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-D\fR|\fB\-d\fR \fImacro[=value]\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Pre\-defines a single\-line macro\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-E\fR|\fB\-e\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to preprocess the given input file, and write the output to
|
|
Packit Service |
3b8507 |
\fIstdout\fR
|
|
Packit Service |
3b8507 |
(or the specified output file name), and not actually assemble anything\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-f\fR \fIformat\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Specifies the output file format\&. To see a list of valid output formats, use the
|
|
Packit Service |
3b8507 |
\fB\-hf\fR
|
|
Packit Service |
3b8507 |
option\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-F\fR \fIformat\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Specifies the debug information format\&. To see a list of valid output formats, use the
|
|
Packit Service |
3b8507 |
\fB\-y\fR
|
|
Packit Service |
3b8507 |
option (for example
|
|
Packit Service |
3b8507 |
\fB\-felf \-y\fR)\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-g\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to generate debug information\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-g\fR\fIformat\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Equivalent to
|
|
Packit Service |
3b8507 |
\fB\-g \-F\fR\fI format\fR\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-h\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to exit immediately, after giving a summary of its invocation options\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-hf\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Same as
|
|
Packit Service |
3b8507 |
\fB\-h\fR
|
|
Packit Service |
3b8507 |
, but also lists all valid output formats\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-I\fR|\fB\-i\fR \fIdirectory\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Adds a directory to the search path for include files\&. The directory specification must include the trailing slash, as it will be directly prepended to the name of the include file\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-l\fR \fIlistfile\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes an assembly listing to be directed to the given file, in which the original source is displayed on the right hand side (plus the source for included files and the expansions of multi\-line macros) and the generated code is shown in hex on the left\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-M\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to output Makefile\-style dependencies to stdout; normal output is suppressed\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-MG\fR \fIfile\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Same as
|
|
Packit Service |
3b8507 |
\fB\-M\fR
|
|
Packit Service |
3b8507 |
but assumes that missing Makefile dependecies are generated and added to dependency list without a prefix\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-MF\fR \fIfile\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Output Makefile\-style dependencies to the specified file\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-MD\fR \fIfile\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Same as a combination of
|
|
Packit Service |
3b8507 |
\fB\-M\fR
|
|
Packit Service |
3b8507 |
and
|
|
Packit Service |
3b8507 |
\fB\-MF\fR
|
|
Packit Service |
3b8507 |
options\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-MT\fR \fIfile\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Override the default name of the dependency target dependency target name\&. This is normally the same as the output filename, specified by the
|
|
Packit Service |
3b8507 |
\fB\-o\fR
|
|
Packit Service |
3b8507 |
option\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-MQ\fR \fIfile\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
The same as
|
|
Packit Service |
3b8507 |
\fB\-MT\fR
|
|
Packit Service |
3b8507 |
except it tries to quote characters that have special meaning in Makefile syntax\&. This is not foolproof, as not all characters with special meaning are quotable in Make\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-MP\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Emit phony target\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-O\fR \fInumber\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Optimize branch offsets\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
.ie n \{\
|
|
Packit Service |
3b8507 |
\h'-04'\(bu\h'+03'\c
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.el \{\
|
|
Packit Service |
3b8507 |
.sp -1
|
|
Packit Service |
3b8507 |
.IP \(bu 2.3
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
\fB\-O0\fR: No optimization
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
.ie n \{\
|
|
Packit Service |
3b8507 |
\h'-04'\(bu\h'+03'\c
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.el \{\
|
|
Packit Service |
3b8507 |
.sp -1
|
|
Packit Service |
3b8507 |
.IP \(bu 2.3
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
\fB\-O1\fR: Minimal optimization
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
.ie n \{\
|
|
Packit Service |
3b8507 |
\h'-04'\(bu\h'+03'\c
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.el \{\
|
|
Packit Service |
3b8507 |
.sp -1
|
|
Packit Service |
3b8507 |
.IP \(bu 2.3
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
\fB\-Ox\fR: Multipass optimization (default)
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-o\fR \fIoutfile\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Specifies a precise name for the output file, overriding
|
|
Packit Service |
3b8507 |
\fBnasm\fR\*(Aqs default means of determining it\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-P\fR|\fB\-p\fR \fIfile\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Specifies a file to be pre\-included, before the main source file starts to be processed\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-s\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to send its error messages and/or help text to stdout instead of stderr\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-t\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to assemble in SciTech TASM compatible mode\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-U\fR|\fB\-u\fR \fImacro\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Undefines a single\-line macro\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-v\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to exit immediately, after displaying its version number\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
*\-W[no\-]foo\*(Aq
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to enable or disable certain classes of warning messages, in gcc\-like style, for example
|
|
Packit Service |
3b8507 |
\fB\-Wlabel\-orphan\fR
|
|
Packit Service |
3b8507 |
or
|
|
Packit Service |
3b8507 |
\fB\-Wno\-orphan\-labels\fR\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-w\fR\fI[+\-]foo\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to enable or disable certain classes of warning messages, for example
|
|
Packit Service |
3b8507 |
\fB\-w+label\-orphan\fR
|
|
Packit Service |
3b8507 |
or
|
|
Packit Service |
3b8507 |
\fB\-w\-macro\-params\fR\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-X\fR \fIformat\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Specifies error reporting format (gnu or vc)\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-y\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to list supported debug formats\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\fB\-Z\fR \fIfilename\fR
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Causes
|
|
Packit Service |
3b8507 |
\fBnasm\fR
|
|
Packit Service |
3b8507 |
to redirect error messages to
|
|
Packit Service |
3b8507 |
\fIfilename\fR\&. This option exists to support operating systems on which stderr is not easily redirected\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.PP
|
|
Packit Service |
3b8507 |
\-\-prefix, \-\-postfix
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
Prepend or append (respectively) the given argument to all global or extern variables\&.
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.SH "SYNTAX"
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
This man page does not fully describe the syntax of \fBnasm\fR\*(Aqs assembly language, but does give a summary of the differences from other assemblers\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fIRegisters\fR have no leading \(oq%\(cq sign, unlike \fBgas\fR, and floating\-point stack registers are referred to as \fIst0\fR, \fIst1\fR, and so on\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fIFloating\-point instructions\fR may use either the single\-operand form or the double\&. A \fITO\fR keyword is provided; thus, one could either write
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.nf
|
|
Packit Service |
3b8507 |
fadd st0,st1
|
|
Packit Service |
3b8507 |
fadd st1,st0
|
|
Packit Service |
3b8507 |
.fi
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
or one could use the alternative single\-operand forms
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.nf
|
|
Packit Service |
3b8507 |
fadd st1
|
|
Packit Service |
3b8507 |
fadd to st1
|
|
Packit Service |
3b8507 |
.fi
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fIUninitialised storage\fR is reserved using the \fIRESB\fR, \fIRESW\fR, \fIRESD\fR, \fIRESQ\fR, \fIREST\fR and \fIRESO\fR pseudo\-opcodes, each taking one parameter which gives the number of bytes, words, doublewords, quadwords or ten\-byte words to reserve\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fIRepetition\fR of data items is not done by the \fIDUP\fR keyword as seen in DOS assemblers, but by the use of the \fITIMES\fR prefix, like this:
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.nf
|
|
Packit Service |
3b8507 |
message: times 3 db \*(Aqabc\*(Aq
|
|
Packit Service |
3b8507 |
times 64\-$+message db 0
|
|
Packit Service |
3b8507 |
.fi
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
which defines the string abcabcabc, followed by the right number of zero bytes to make the total length up to 64 bytes\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fISymbol references\fR are always understood to be immediate (i\&.e\&. the address of the symbol), unless square brackets are used, in which case the contents of the memory location are used\&. Thus:
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.nf
|
|
Packit Service |
3b8507 |
mov ax,wordvar
|
|
Packit Service |
3b8507 |
.fi
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
loads AX with the address of the variable wordvar, whereas
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.nf
|
|
Packit Service |
3b8507 |
mov ax,[wordvar]
|
|
Packit Service |
3b8507 |
mov ax,[wordvar+1]
|
|
Packit Service |
3b8507 |
mov ax,[es:wordvar+bx]
|
|
Packit Service |
3b8507 |
.fi
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
all refer to the \fIcontents\fR of memory locations\&. The syntaxes
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.nf
|
|
Packit Service |
3b8507 |
mov ax,es:wordvar[bx]
|
|
Packit Service |
3b8507 |
es mov ax,wordvar[1]
|
|
Packit Service |
3b8507 |
.fi
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
are not legal at all, although the use of a segment register name as an instruction prefix is valid, and can be used with instructions such as \fILODSB\fR which can\(cqt be overridden any other way\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fIConstants\fR may be expressed numerically in most formats: a trailing H, Q or B denotes hex, octal or binary respectively, and a leading \(oq0x\(cq or \(oq$\(cq denotes hex as well\&. Leading zeros are not treated specially at all\&. Character constants may be enclosed in single or double quotes; there is no escape character\&. The ordering is little\-endian (reversed), so that the character constant \fI\*(Aqabcd\fR\*(Aq denotes 0x64636261 and not 0x61626364\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
Local labels begin with a period, and their \(oqlocality\(cq is granted by the assembler prepending the name of the previous non\-local symbol\&. Thus declaring a label \(oq\&.loop\(cq after a label \(oqlabel\(cq has actually defined a symbol called \(oqlabel\&.loop\(cq\&.
|
|
Packit Service |
3b8507 |
.SH "DIRECTIVES"
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fISECTION\fR \fIname\fR or \fISEGMENT\fR \fIname\fR causes \fBnasm\fR to direct all following code to the named section\&. Section names vary with output file format, although most formats support the names \fI\&.text\fR, \fI\&.data\fR and \fI\&.bss\fR\&. (The exception is the \fIobj\fR format, in which all segments are user\-definable\&.)
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fIABSOLUTE\fR \fIaddress\fR causes \fBnasm\fR to position its notional assembly point at an absolute address: so no code or data may be generated, but you can use \fIRESB\fR, \fIRESW\fR and \fIRESD\fR to move the assembly point further on, and you can define labels\&. So this directive may be used to define data structures\&. When you have finished doing absolute assembly, you must issue another \fISECTION\fR directive to return to normal assembly\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fIBITS\fR \fI16\fR, \fIBITS\fR \fI32\fR or \fIBITS\fR \fI64\fR switches the default processor mode for which \fBnasm\fR is generating code: it is equivalent to \fIUSE16\fR or \fIUSE32\fR in DOS assemblers\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fIEXTERN\fR \fIsymbol\fR and \fIGLOBAL\fR \fIsymbol\fR import and export symbol definitions, respectively, from and to other modules\&. Note that the \fIGLOBAL\fR directive must appear before the definition of the symbol it refers to\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fISTRUC\fR \fIstrucname\fR and \fIENDSTRUC\fR, when used to bracket a number of \fIRESB\fR, \fIRESW\fR or similar instructions, define a data structure\&. In addition to defining the offsets of the structure members, the construct also defines a symbol for the size of the structure, which is simply the structure name with \fIsize\fR tacked on to the end\&.
|
|
Packit Service |
3b8507 |
.SH "FORMAT\-SPECIFIC DIRECTIVES"
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fIORG\fR \fIaddress\fR is used by the \fIbin\fR flat\-form binary output format, and specifies the address at which the output code will eventually be loaded\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fIGROUP\fR \fIgrpname\fR \fIseg1\fR \fIseg2\fR\&... is used by the obj (Microsoft 16\-bit) output format, and defines segment groups\&. This format also uses \fIUPPERCASE\fR, which directs that all segment, group and symbol names output to the object file should be in uppercase\&. Note that the actual assembly is still case sensitive\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fILIBRARY\fR \fIlibname\fR is used by the \fIrdf\fR output format, and causes a dependency record to be written to the output file which indicates that the program requires a certain library in order to run\&.
|
|
Packit Service |
3b8507 |
.SH "MACRO PREPROCESSOR"
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
Single\-line macros are defined using the \fI%define\fR or \fI%idefine\fR commands, in a similar fashion to the C preprocessor\&. They can be overloaded with respect to number of parameters, although defining a macro with no parameters prevents the definition of any macro with the same name taking parameters, and vice versa\&. \fI%define\fR defines macros whose names match case\-sensitively, whereas \fI%idefine\fR defines case\-insensitive macros\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
Multi\-line macros are defined using \fI%macro\fR and \fI%imacro\fR (the distinction is the same as that between \fI%define\fR and \fI%idefine\fR), whose syntax is as follows
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RS 4
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.nf
|
|
Packit Service |
3b8507 |
%macro name minprm[\-maxprm][+][\&.nolist] [defaults]
|
|
Packit Service |
3b8507 |
<some lines of macro expansion text>
|
|
Packit Service |
3b8507 |
%endmacro
|
|
Packit Service |
3b8507 |
.fi
|
|
Packit Service |
3b8507 |
.if n \{\
|
|
Packit Service |
3b8507 |
.RE
|
|
Packit Service |
3b8507 |
.\}
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
Again, these macros may be overloaded\&. The trailing plus sign indicates that any parameters after the last one get subsumed, with their separating commas, into the last parameter\&. The \fIdefaults\fR part can be used to specify defaults for unspecified macro parameters after \fIminparam\fR\&. \fI%endm\fR is a valid synonym for \fI%endmacro\fR\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
To refer to the macro parameters within a macro expansion, you use \fI%1\fR, \fI%2\fR and so on\&. You can also enforce that a macro parameter should contain a condition code by using \fI%+1\fR, and you can invert the condition code by using \fI%\-1\fR\&. You can also define a label specific to a macro invocation by prefixing it with a double \(oq%\(cq sign\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
Files can be included using the \fI%include\fR directive, which works like C\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
The preprocessor has a \(oqcontext stack\(cq, which may be used by one macro to store information that a later one will retrieve\&. You can push a context on the stack using \fI%push\fR, remove one using \fI%pop\fR, and change the name of the top context (without disturbing any associated definitions) using \fI%repl\fR\&. Labels and \fI%define\fR macros specific to the top context may be defined by prefixing their names with %$, and things specific to the next context down with %$$, and so on\&.
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
Conditional assembly is done by means of \fI%ifdef\fR, \fI%ifndef\fR, \fI%else\fR and \fI%endif\fR as in C\&. (Except that \fI%ifdef\fR can accept several putative macro names, and will evaluate TRUE if any of them is defined\&.) In addition, the directives \fI%ifctx\fR and \fI%ifnctx\fR can be used to condition on the name of the top context on the context stack\&. The obvious set of \(oqelse\-if\(cq directives, \fI%elifdef\fR, \fI%elifndef\fR, \fI%elifctx\fR and \fI%elifnctx\fR are also supported\&.
|
|
Packit Service |
3b8507 |
.SH "BUGS"
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
Please report bugs through the bug tracker function at \m[blue]\fBhttp://nasm\&.us\fR\m[]\&.
|
|
Packit Service |
3b8507 |
.SH "SEE ALSO"
|
|
Packit Service |
3b8507 |
.sp
|
|
Packit Service |
3b8507 |
\fBas\fR(1), \fBld\fR(1)\&.
|