Kart-Public/tools/lumpmod/lumpmod.html
2014-03-15 13:11:35 -04:00

82 lines
4.6 KiB
HTML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head><meta http-equiv="content-type"
content="application/xhtml+xml; charset=utf-8" />
<title>LumpMod v0.2.1 Documentation</title></head><body>
<h1>LumpMod v0.2.1</h1>
<p>LumpMod is a small command-line utility for working with lumps in wad
files in the format used by DOOM and DOOM 2. It can add, delete, extract,
rename, list, and update individual lumps. It can also add sections
(XX_START and XX_END, for instance) and delete entire sections.</p>
<h2>Usage</h2>
<p><code>lumpmod [wadfile] [command] [-s section] [parameters]</code></p>
<p>Sections are MAPxx (xx = 01-99, where that map exists in the file), ExMy
(x, y = 1-9, where that map exists in the file), and anything else will be
the section between WHATEVER_START and WHATEVER_END. Sections that do not
exist in the wad file cannot be used. The section part can be left out to
work with the whole file. Any section specified here while using the addsect
or delsect commands will cause an error.</p>
<p>Note that the []... parameters in the command listings can be repeated.
For example, you can use <code>lumpmod clowns.wad add CLOWNS clowns.lmp</code> to
add a CLOWNS lump, or <code>lumpmod clowns.wad add CLOWN1 clown1.lmp CLOWN2
clown2.lmp</code> to add two clown-related lumps.</p>
<p>Note also that lump names and commands are case sensitive. There is an
<code>update</code> command, but no <code>UPDATE</code> command.</p>
<h2>Commands</h2>
<p><code>add [-a lumpname] [-b] [-d] [-n] [LUMPNAME FILENAME]...</code></p>
<p>Add a lump to the end of the wad, or after the lump specified with the -a
option. If the lump already exists, it will be overwritten (with its position
unchanged) unless the -n option is specified, in which case no action will be
taken, or the -d option is specified, in which case an additional lump with
the same name will be added. If the lump specified in the -a option does not
exist, an error will occur. The -b option will add the lump at the beginning,
overriding the -a option.</p>
<p><code>addsect [SECTNAME]...</code></p>
<p>Add a section. The name must be one or two characters long. If section
name is HX, zero-length entries HX_START and HX_END will be added to the end
of the wad file. If this section already exists, no action will be taken.</p>
<p><code>delete [LUMPNAME]...</code></p>
<p>Remove LUMPNAME from the wad.</p>
<p><code>delsect [SECTNAME]...</code></p>
<p>Delete a section and anything inside it. If the section doesn't exist, no
action will be taken.</p>
<p><code>extract [LUMPNAME FILENAME]...</code></p>
<p>Save the contents of LUMPNAME to the file named FILENAME. (Wad file will
not be changed in any way.)</p>
<p><code>list [-v]</code></p>
<p>List all lumps in the wad, in the order they appear in the directory.
With the -v option, include numbers and lump lengths.</p>
<p><code>rename [OLDNAME NEWNAME]...</code></p>
<p>Rename a lump in the wad.</p>
<p><code>update [LUMPNAME FILENAME]...</code></p>
<p>Update LUMPNAME with the contents of FILENAME. If no lump named LUMPNAME
exists in the wad, no action will be taken.</p>
<h2>Changes</h2>
<p>Version 0.2.1 adds the -d option to the add command.</p>
<p>Version 0.2 contains a fix to a bug involving empty sections. The initial
public release was version 0.1.</p>
<h2>Bugs</h2>
<p>LumpMod currently chokes on completely empty wad files (i.e., those that
contain absolutely no lumps). Let me know if you find any other bugs.</p>
<h2>Author</h2>
<p>Catatonic Porpoise, &lt;<a href="mailto:graue@oceanbase.org">graue@oceanbase.org</a>&gt;.
Updates can be found at <a href="http://www.thunderpalace.com/software/">http://www.thunderpalace.com/software/</a>.</p>
<h2>Thanks</h2>
<p>Thanks to Matthew S. Fell for writing &quot;The Unofficial DOOM
Specs,&quot; which were very helpful in making this program.</p>
<h2>License</h2>
<p>Copyright &copy; 2003 Thunder Palace Entertainment.</p>
<p>This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.</p>
<p>This program 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.</p>
<p>You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>
</body></html>