mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-20 10:12:06 +00:00
74 lines
1.5 KiB
Groff
74 lines
1.5 KiB
Groff
.Dd February 26, 2015
|
|
.Dt RGBASM 1
|
|
.Os RGBDS Manual
|
|
.Sh NAME
|
|
.Nm rgbasm
|
|
.Nd Game Boy assembler
|
|
.Sh SYNOPSIS
|
|
.Nm rgbasm
|
|
.Op Fl hv
|
|
.Op Fl b Ar chars
|
|
.Op Fl D Ar name Ns Op = Ns Ar value
|
|
.Op Fl g Ar chars
|
|
.Op Fl i Ar path
|
|
.Op Fl o Ar outfile
|
|
.Op Fl p Ar pad_value
|
|
.Ar file
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
program creates an object file from an assembly source file.
|
|
Its arguments are as follows:
|
|
.Bl -tag -width Ds
|
|
.It Fl b Ar chars
|
|
Change the two characters used for binary constants.
|
|
The defaults are 01.
|
|
.It Fl D Ar name Ns Op = Ns Ar value
|
|
Add string symbol to the compiled source code. This is equivalent to
|
|
.Ar name
|
|
.Cm EQUS
|
|
.Qq Ar "value"
|
|
in code. If a value is not specified, a value of 1 is given.
|
|
.It Fl g Ar chars
|
|
Change the four characters used for binary constants.
|
|
The defaults are 0123.
|
|
.It Fl h
|
|
By default,
|
|
.Nm
|
|
inserts a
|
|
.Sq nop
|
|
instruction immediately after any
|
|
.Sq halt
|
|
instruction.
|
|
The
|
|
.Fl h
|
|
option disables this behavior.
|
|
.It Fl i Ar path
|
|
Add an include path.
|
|
.It Fl o Ar outfile
|
|
Write an object file to the given filename.
|
|
.It Fl p Ar pad_value
|
|
When padding an image, pad with this value.
|
|
The default is 0x00.
|
|
.It Fl v
|
|
Be verbose.
|
|
.El
|
|
.Sh EXAMPLES
|
|
Assembling a basic source file is simple:
|
|
.Pp
|
|
.D1 $ rgbasm -o bar.o foo.asm
|
|
.Pp
|
|
The resulting object file is not yet a usable ROM image \(em it must first be
|
|
run through
|
|
.Xr rgblink 1
|
|
and
|
|
.Xr rgbfix 1 .
|
|
.Sh SEE ALSO
|
|
.Xr rgbfix 1 ,
|
|
.Xr rgblink 1 ,
|
|
.Xr rgbds 7
|
|
.Sh HISTORY
|
|
.Nm
|
|
was originally written by Carsten S\(/orensen as part of the ASMotor package,
|
|
and was later packaged in RGBDS by Justin Lloyd.
|