Skip to content

Commit 73aecba

Browse files
DominusExultDominusExult
committed
* tools/*.1: finally added Robert Bihlmeyer man pages. Added them
to /tools as the *txt files are there too.
1 parent a277c79 commit 73aecba

File tree

6 files changed

+538
-0
lines changed

6 files changed

+538
-0
lines changed

‎ChangeLog‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
2002-05-03 Dominik Reichardt <[email protected]>
2+
* tools/*.1: finally added Robert Bihlmeyer man pages. Added them
3+
to /tools as the *txt files are there too.
4+
15
2002-05-01 Jeff Freedman <jsf@usf-cf-x86-linux-1>
26

37
* usecode/compiler/uclex.ll,ucmain.cc: Added "-o outfile" option

‎tools/expack.1‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
.\" -*- nroff -*-
2+
.TH expack 1 2002-03-23 Exult
3+
4+
.SH NAME
5+
expack \- manipulate Flex files
6+
7+
.SH SYNOPSIS
8+
.B expack -a
9+
.IR "FLEXFILE FILE" ...
10+
11+
.B expack -c
12+
.IR "FLEXFILE FILE" ...
13+
14+
.B expack -x
15+
.IR FLEXFILE " [" INDEX ]
16+
17+
.B expack -i
18+
.I MANIFEST
19+
20+
.B expack -l
21+
.I FLEXFILE
22+
23+
.SH DESCRIPTION
24+
.B expack
25+
is a command-line utility that lets you extract and create Flex files.
26+
Flex files are archives (which means that they act as containers for
27+
other files, somewhat like directories) used by
28+
.I Ultima 7
29+
to store most of its data. Note that the names of the original files
30+
are not stored in the Flex \(em files are only retrievable by their
31+
index.
32+
33+
.SS Modes of operation
34+
35+
.TP
36+
.BR -a " Add"
37+
--NOT IMPLEMENTED YET. FUTURE ENHANCEMENT--
38+
This command adds one or more
39+
.IR FILE s
40+
to the end of
41+
.IR FLEXFILE .
42+
43+
.TP
44+
.BR -c " Create"
45+
This command takes one or more
46+
.IR FILE s
47+
and bundles them into
48+
.IR FLEXFILE ,
49+
overwriting it in the process.
50+
51+
.TP
52+
.BR -x " Extract"
53+
Lets you extract the files contained within
54+
.IR FLEXFILE .
55+
If
56+
.I INDEX
57+
is given only the file at this position will be unpacked, otherwise all
58+
files are extracted. The created files will be named \fIindex\fB.u7o\fR.
59+
60+
.TP
61+
.BR -i " Input"
62+
Similar to "Create", this command creates
63+
.I FLEXFILE
64+
from a number of input files. However, "Input" takes the names of the
65+
input files from
66+
.I MANIFEST
67+
instead of the command line.
68+
69+
.I MANIFEST
70+
must be a list of file names, one per line. The first name
71+
is that of the Flex file that is to be created, the rest are the input
72+
files used in building it.
73+
74+
.TP
75+
.BR -l " List"
76+
This command lists the contents of a
77+
.IR FLEXFILE .
78+
It gives you the
79+
number of files contained within the Flex file, as well as the length
80+
of each file.
81+
82+
.SH EXAMPLES
83+
.TP
84+
.B expack -a animals.flx bee.wav
85+
Adds
86+
.B bee.wav
87+
to the Flex file
88+
.BR animals.flx .
89+
90+
.TP
91+
.B expack -a animals.flx hamster.wav snake.wav donkey.wav
92+
Adds
93+
.BR hamster.wav ", " snake.wav ", and " donkey.wav
94+
to the Flex file
95+
.BR animals.flx .
96+
97+
.TP
98+
.B expack -c animals.flx duck.wav cat.wav cow.wav dog.wav
99+
Creates a new Flex file
100+
.B animals.flx
101+
containing
102+
.BR duck.wav ", " cat.wav ", " cow.wav ", and " dog.wav .
103+
104+
.TP
105+
.B expack -x text.flx 17
106+
Extracts the file at position
107+
.BR 17 from text.flx into 17.u7o .
108+
109+
.TP
110+
.B expack -x text.flx
111+
Extracts all files from
112+
.B text.flx
113+
into files named
114+
.BR 0.u7o ", " 1.u7o ", " 2.u7o ", etc."
115+
116+
.TP
117+
.B expack -i wavlist
118+
With
119+
.B wavlist
120+
reading:
121+
122+
jmsfx.flx
123+
.br
124+
ant.wav
125+
.br
126+
bee.wav
127+
.br
128+
cat.wav
129+
130+
will create a new Flex file
131+
.B jmsfx.flx
132+
consisting of
133+
.BR ant.wav ", " bee.wav ", and" cat.wav .
134+
135+
.TP
136+
.B expack -l text.flx
137+
Lists the number and lenghts of files contained in
138+
.BR text.flx .
139+
140+
.SH BUGS
141+
The "Add" command
142+
.RB ( -a )
143+
does not work yet.
144+
145+
.SH AUTHOR
146+
This manpage was written by Robert Bihlmeyer based on a text by Marc
147+
Winterrowd. It may be freely redistributed and modified under the
148+
terms of the GNU General Public License version 2 or higher.

‎tools/ipack.1‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
.\" -*- nroff -*-
2+
.TH ipack 1 2002-03-24 Exult
3+
4+
.SH NAME
5+
ipack \- Manipulate Flex files containing Shapes
6+
7+
.SH SYNOPSIS
8+
.B ipack -c
9+
.I SCRIPT
10+
11+
.B ipack -x
12+
.I SCRIPT
13+
14+
.B ipack -u
15+
.I SCRIPT
16+
17+
.SH DESCRIPTION
18+
Flex files containing Shapes are used for the storage visual elements
19+
by the games
20+
.I Exult
21+
supports. While
22+
.BR expack (1)
23+
can operate on such files, using
24+
.B ipack
25+
is more comfortable. It can extract images from the Flex file
26+
directly into PNG-format, and create or update Flex files from a list
27+
of PNG files.
28+
29+
The first parameter determines the mode of operation:
30+
31+
.TP
32+
.BR -c " Creation"
33+
New Flex and palette files are created according to the instructions
34+
contained in the
35+
.I SCRIPT
36+
file.
37+
38+
.TP
39+
.BR -u " Update"
40+
Works like Creation, but updates an existing Flex file.
41+
42+
.TP
43+
.BR -x " Extraction"
44+
The contents of the Flex file described in the
45+
.I SCRIPT
46+
file are extracted as PNG is dissected into its contents, as described in this script file.
47+
48+
.SS Script File Format
49+
Empty lines, and lines starting with a pound sign
50+
.RB ( # )
51+
are ignored.
52+
53+
The names of the associated Flex archive and palette files are
54+
given in lines containing optional whitespace, one of the tokens
55+
.BR archive " or " palette ,
56+
whitespace, and the filename.
57+
58+
Other lines define one shape each, and must begin with an image slot
59+
number, followed by a slash
60+
.RB ( / ),
61+
the number of frames, a colon
62+
.RB ( : ),
63+
and finally the PNG file specification.
64+
The numbers may be given either in
65+
decimal, in octal prefixed with
66+
.BR 0 ;
67+
or in hexadecimal prefixed with
68+
.BR 0x .
69+
The file specification consists of the filename
70+
.IR PREFIX ,
71+
optionally
72+
followed by a number and direction in brackets, optionally followed by
73+
whitespace and the word
74+
.BR flat .
75+
76+
Per default, each shape corresponds to a number of PNG files (one for
77+
each frame) named
78+
.IB PREFIXnn .png
79+
with
80+
.I nn
81+
replaced by the frame number. If the optional bracket expression is
82+
used in the specification the Shape corresponds to a single PNG file
83+
instead. This file contains all frames, each of which is 8 by 8 pixels
84+
in size, arranged next to each other in a rectangular grid. The number
85+
in the bracket expression gives the size of this grid in the direction
86+
indicated. The direction can be either
87+
.B down
88+
or
89+
.BR across .
90+
91+
.SH EXAMPLES
92+
.TP
93+
.B ipack -c island.scr
94+
Creates a Flex file and a palette file as specified by
95+
.BR island.scr .
96+
97+
.TP
98+
.B ipack -x island.scr
99+
Extracts all components described in
100+
.B island.scr
101+
from the Flex file given therein.
102+
103+
.SS Example script
104+
# script file for island.flx
105+
.br
106+
archive island.flx
107+
.br
108+
# put the palette into this file
109+
.br
110+
palette island.pal
111+
.br
112+
# the zeroth image has 32 frames in the files
113+
.br
114+
# zero00.png to zero31.png
115+
.br
116+
0/32:zero
117+
.br
118+
# image 5 consists of 22 frames stored in file
119+
.br
120+
# five.png in a grid 5 frames across (which means
121+
.br
122+
# 5 rows of which the last holds only 2 frames)
123+
.br
124+
5/22:five(5 across) flat
125+
.br
126+
# image 4 consists of 12 frames stored in file
127+
.br
128+
# four.png in a 3 by 4 grid
129+
.br
130+
4/12:four(4 down) flat
131+
.br
132+
# images 1 to 3 are unspecified
133+
134+
.SH BUGS
135+
Tiled Shapes are currently extracted into multiple PNG files, not a
136+
single file as expected during Create/Update.
137+
138+
.SH AUTHOR
139+
This manpage was written by Robert Bihlmeyer. It may be freely
140+
redistributed and modified under the terms of the GNU General Public
141+
License version 2 or higher.
142+
143+
.SH SEE ALSO
144+
.BR expack "(1), " exult (6)
145+

‎tools/shp2pcx.1‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.\" -*- nroff -*-
2+
.TH shp2pcx 1 2002-03-24 Exult
3+
4+
.SH NAME
5+
shp2pcx \- extract images from a Shape (SHP) file into PCX files
6+
7+
.SH SYNOPSIS
8+
.B shp2pcx
9+
.I SHAPE PREFIX PALETTE
10+
11+
.SH DESCRIPTION
12+
.B shp2pcx
13+
converts all frames contained in a Shape file into PCX-format image
14+
files. Shape files are used for storage of all visible elements (from
15+
UI buttons to terrain features) of the games
16+
.I Exult
17+
supports.
18+
19+
.I SHAPE
20+
is the name of the Shape file acting as the source. Frames contained
21+
therein are saved as PCX files named
22+
.IB PREFIXnn .pcx
23+
with
24+
.I nn
25+
replaced by the frame number (counting from zero). All PCX files get
26+
their palette from
27+
.IR PALETTE .
28+
29+
Before extraction the number of frames, and the Shape's origin
30+
coordinates are shown. Additionally, extraction progress is
31+
communicated by printing a message containing the resulting file's
32+
name for every processed frame.
33+
34+
.SH EXAMPLES
35+
.TP
36+
.B shp2pcx orc.shp orc std.pal
37+
Takes the frames contained in the Shape file
38+
.BR orc.shp ,
39+
and saves them with the palette from
40+
.B std.pal
41+
into PCX files
42+
.BR orc00.pcx ", " orc01.pcx ", " orc02.pcx ", etc."
43+
44+
.SH AUTHOR
45+
This manpage was written by Robert Bihlmeyer. It may be freely
46+
redistributed and modified under the terms of the GNU General Public
47+
License version 2 or higher.
48+
49+
.SH SEE ALSO
50+
.BR exult "(6), " pcxtoppm "(1), " splitshp (1)
51+

0 commit comments

Comments
 (0)