Add a small Hello World program to be assembled
[zilutils.git] / zilasm / zilasm.1
1 .\" Copyright (C) 2019 Jason Self <j@jxself.org>
2 .\"
3 .\" This file is part of zilutils/zilasm.
4 .\"
5 .\" You can redistribute and/or modify this file under the terms of
6 .\" the GNU Affero General Public License as published by the Free
7 .\" Software Foundation, either version 3 of the License, or (at your
8 .\" option) any later version.
9 .\"
10 .\" This file is distributed in the hope that it will be useful, but
11 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 .\" Affero General Public License for more details.
14 .\"
15 .\" You should have received a copy of the GNU Affero General Public
16 .\" License along with zilasm. If not, see
17 .\" <http://www.gnu.org/licenses/>.
18 .TH zilasm 1
19 .SH NAME
20 zilasm \- an assembler that targets the Z-Machine
21 .SH SYNOPSIS
22 .B zilasm
23 [OPTIONS]
24 .IR files
25 .SH DESCRIPTION
26 .BR zilasm
27 is part of the zilutils package. The zilutils comprise a compiler and
28 assembler that target the Z-Machine.
29 .SH OPTIONS
30 .TP
31 .BR \-\-version
32 Display assembler version and exit
33 .TP
34 .BR \-\-zversion
35 Set the Z-Machine version target. Accepts numbers 1 - 8, defaults to
36 6 if not specified.
37 .TP
38 .BR \-\-zorkid
39 Set the release number of the assembled program. Accepts an integer
40 between 0 and 65535, defaults to 0 if not specified.
41 .TP
42 .BR \-\-serial
43 Sets the serial number for the assembled program using six characters
44 of ASCII, defaults to current date in the form YYMMDD if not
45 specified.
46 .SH REPORTING BUGS
47 Report bugs to Jason Self <j@jxself.org>
48 .SH COPYRIGHT
49 This file is part of zilasm. zilasm is free software: you can
50 redistribute it and/or modify it under the terms of the GNU Affero
51 General Public License as published by the Free Software Foundation,
52 either version 3 of the License, or (at your option) any later
53 version.
54 .PP
55 zilasm is distributed in the hope that it will be useful, but
56 WITHOUT ANY WARRANTY; without even the implied warranty of
57 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
58 General Public License for more details.
59 .PP
60 You should have received a copy of the GNU General Public License
61 along with zilasm. If not, see <http://www.gnu.org/licenses/>.
62 .SH SEE ALSO
63 .BR zilc(1)