Importing zdevtools release 20110529 from https://zdevtools.codeplex.com/ minus the...
[zdevtools.git] / za / za.1
1 .\" Copyright (c) 2011 Chris Spiegel.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .Dd May 29, 2011
26 .Dt ZA 1
27 .Os
28 .Sh NAME
29 .Nm za
30 .Nd Z\-machine assembler
31 .Sh SYNOPSIS
32 .Nm
33 .Op Fl o Ar outfile
34 .Op Fl r Ar release
35 .Op Fl s Ar serial
36 .Op Fl v Ar version
37 .Ar file
38 .Sh DESCRIPTION
39 The
40 .Nm
41 utility assembles Z\-machine stories.
42 .Pp
43 The following options are available:
44 .Bl -tag -width indent
45 .It Fl o Ar outfile
46 Specify the filename of the resulting story file.  The default is
47 .Pa out.z5 ,
48 regardless of the Z-machine version.
49 .It Fl r Ar release
50 Set the release number.  This must be a value between 0 and 65535.  The default
51 is
52 .Ar 1 .
53 .It Fl s Ar serial
54 Set the serial number.  This must be a string of six characters.  The default is
55 the current date in the traditional Z\-machine format.
56 .It Fl v Ar version
57 Set the Z\-machine version.  Versions 1\-8 are supported.  The default is
58 .Ar 8 .
59 .El
60 .Sh AUTHORS
61 .An "Chris Spiegel" Aq cspiegel@gmail.com
62 .Sh SEE ALSO
63 .Xr zd 1