Add man page for zilasm

[zilutils.git] / zilasm / zilasm.1

diff --git a/zilasm/zilasm.1 b/zilasm/zilasm.1
new file mode 100644 (file)
index 0000000..f974eeb
--- /dev/null
+++ b/zilasm/zilasm.1
@@ -0,0 +1,63 @@
+.\" Copyright (C) 2019 Jason Self <j@jxself.org>
+.\"
+.\" This file is part of zilutils/zilasm.
+.\"
+.\" You can redistribute and/or modify this file under the terms of
+.\" the GNU Affero General Public License as published by the Free
+.\" Software Foundation, either version 3 of the License, or (at your
+.\" option) any later version.
+.\"
+.\" This file is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+.\" Affero General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU Affero General Public
+.\" License along with zilasm. If not, see
+.\" <http://www.gnu.org/licenses/>.
+.TH zilasm 1
+.SH NAME
+zilasm \- an assembler that targets the Z-Machine
+.SH SYNOPSIS
+.B zilasm
+[OPTIONS]
+.IR files
+.SH DESCRIPTION
+.BR zilasm
+is part of the zilutils package. The zilutils comprise a compiler and
+assembler that target the Z-Machine.
+.SH OPTIONS
+.TP
+.BR \-\-version
+Display assembler version and exit
+.TP
+.BR \-\-zversion
+Set the Z-Machine version target. Accepts numbers 1 - 8, defaults to
+6 if not specified.
+.TP
+.BR \-\-zorkid
+Set the release number of the assembled program. Accepts an integer
+between 0 and 65535, defaults to 0 if not specified.
+.TP
+.BR \-\-serial
+Sets the serial number for the assembled program using six characters
+of ASCII, defaults to current date in the form YYMMDD if not
+specified.
+.SH REPORTING BUGS
+Report bugs to Jason Self <j@jxself.org>
+.SH COPYRIGHT
+This file is part of zilasm. zilasm is free software: you can
+redistribute it and/or modify it under the terms of the GNU Affero
+General Public License as published by the Free Software Foundation,
+either version 3 of the License, or (at your option) any later
+version.
+.PP
+zilasm is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+.PP
+You should have received a copy of the GNU General Public License
+along with zilasm. If not, see <http://www.gnu.org/licenses/>.
+.SH SEE ALSO
+.BR zilc(1)