Installing Unformat

From AdamWiki

Unformat should be easy to use. It was designed to be easier to use than its predecessor, amolitor_mush_unformatter.c.

System Requirements

Unformat (all versions) requires Perl 4 or later.

Unformat is typically used on UNIX and Linux systems, but it can be used on any system that runs Perl and Perl is available for Microsoft Windows, Mac, and so on.

Installing

Install Unformat by placing the script in a file named "unformat.pl" on your file system somewhere, preferably within your PATH. If you name it something else, that's fine, but some of the instructions on this web site might not apply in their exact form.

Edit the file to configure it. Don't change anything after the line that says "End of configuration stuff" unless you really know what you're doing.

Path Information. The first line — #!/usr/bin/perl — should point to the location of your Perl command. You can type which perl on a UNIX or Linux box to find out where Perl is installed. You can ignore this step if you're running Perl from Windows.

Extra Spaces. By default, Unformat spits out a blank line between each command it unformats. Most MUSHes and MUXes ignore this blank line. If you don't want it, set $extraspace to No.

Output Command. Unformat sends some messages to you when you use it. By default, it uses the "think" command to do this. If you want it to use a different command, like "@pemit %# = " or something else, set the $outputcommand variable.

Done Command. When Unformat finishes unformatting a file or set of files, it outputs a message to you. By default, it uses "think Uploaded." If you want to change this command or message to something else, set $donecommand.

Postpone Command. (v2.0+) Sometimes your code file contains interactive commands that enqueue other commands. For example, you might put a @dolist or @trigger in your file and have it run interactively. In these cases, the Done Command might run before your code completes, and that's confusing. To deal with this, Unformat v2+ prepends a Postpone Command before the Done Command to delay the "Uploaded" message a few queue cycles and get everything back in the right order. By default, Unformat prepends "@wait 0 = @wait 0 = @wait 0 = " before the Done Command. This delays it 3 queue cycles (and handles most practical cases). If you want to delay less or more, or change it altogether, set the $postpone_command variable if you know what you're doing.