gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2025-11-20 10:12:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify at-files documentation

Browse Source
This commit is contained in:
ISSOtm
2022-09-13 08:34:41 +02:00
parent 6df75f7af3
commit 0794da22bc
1 changed files with 25 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
man/rgbgfx.1
View File

@@ -321,7 +321,22 @@ any command-line argument that begins with an at sign
.Pq Ql @ .Pq Ql @
is interpreted as one. is interpreted as one.
The rest of the argument (without the @, that is) is interpreted as the path to a file, whose contents are interpreted as if given on the command line. The rest of the argument (without the @, that is) is interpreted as the path to a file, whose contents are interpreted as if given on the command line.
At-files can be stored right next to the corresponding image, for example. At-files can be stored right next to the corresponding image, for example:
.Pp
.Dl $ rgbgfx -o image.2bpp -t image.tilemap @image.flags image.png
.Pp
This will read additional flags from file
.Ql image.flags ,
which could contains for example
.Ql -b 128
to specify a base offset for the image's tiles.
The above command could be generated from the following
.Xr make 1
rule, for example:
.Bd -literal -offset indent
%.2bpp %.tilemap: %.flags %.png
rgbgfx -o $*.2bpp -t $*.tilemap @$*.flags $*.png
.Ed
.Pp .Pp
Since the contents of at-files are interpreted by Since the contents of at-files are interpreted by
.Nm , .Nm ,
@@ -336,17 +351,19 @@ optionally preceded by whitespace, are considered comments and also ignored.
Each line can contain any number of arguments, which are separated by whitespace. Each line can contain any number of arguments, which are separated by whitespace.
.Pq \&No quoting feature to prevent this is provided. .Pq \&No quoting feature to prevent this is provided.
.Pp .Pp
Note that this special meaning given to arguments has less precedence than option arguments, and that the standard Note that a leading
.Ql @
has no special meaning on option arguments, and that the standard
.Ql -- .Ql --
to stop option processing also disables at-file processing. to stop option processing also disables at-file processing.
For example, the following command line processes For example, the following command line reads command-line options from
.Ql @tilesets/town.png ,
outputs tile data to
.Ql @tilesets/town.2bpp ,
and reads command-line options from
.Ql tilesets/town.flags .Ql tilesets/town.flags
then then
.Ql tilesets.flags : .Ql tilesets.flags ,
but processes
.Ql @tilesets/town.png
as the input image and outputs tile data to
.Ql @tilesets/town.2bpp :
.Pp .Pp
.Dl $ rgbgfx -o @tilesets/town.2bpp @tilesets/town.flags @tilesets.flags -- @tilesets/town.png .Dl $ rgbgfx -o @tilesets/town.2bpp @tilesets/town.flags @tilesets.flags -- @tilesets/town.png
.Pp .Pp