sup -- A Sloup dump-format package extractor
Contents:
 - What is sup?
 - How to use sup
 - What is included?
 - Copyleft information

What is sup?
sup is a utility to generate a Newton package from a Sloup package
dump.
I wrote this because I didn't have a good way to get books made with
NewtsCape back out of my Newton. I tried some of the other available
options without success. If you're unfamiliar with Steve Weyer's excellent 
Sloup utility, here's a little background:
(From Steve Weyer's Sloup website) Sloup is a utility for transferring 
data or text between desktop filesand Newton "soups" (object-oriented
databases).
One of the powerful things Sloup can do is to dump a Newton package in
an encoded binary format into a terminal emulator. Since it only requires
a terminal program on the desktop side, it works on any computer -- not
just Windows and Mac. Once you capture the package dump from sloup, sup
can convert this dump back into a Newton package.


How to use sup
I'll use a real life example here. I generated a Newton Book version of
the Intercal programming manual using NewtsCape. I fired up sloup on my
Newt, ran a terminal emulator on my desktop, and told it to capture text
to a file called "intercal.txt". I then sent it this command:

Package
{packageName: "INTERCAL", packageEntry: "binary:packageEntry"}
DUMP!

Sloup then dumped the package into the file intercal.txt. When it was
done, I shut down both the terminal emulator and sloup. Then I ran sup,
telling it to extract the package "intercal.pkg" from intercal.txt:

sup intercal.txt intercal.pkg

Thats it!


Whats included?
I've generated a couple of precompiled binaries for sup, for Linux and
Windows. Sup itself only uses standard C library routines, so it should
compile on just about anything. 

 - ReadMe.txt -- this file
 - license.txt -- A copy of the GNU general license. See copyleft
information below.
 - sup -- a precompiled Linux binary.
 - sup.exe -- Windows binary.
 - The complete source code for sup.


Copyleft information

Copyright (c)2000, J.B. Hemlock <blag@narcosislabs.org>. All rights
reversed.
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.
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.
You should have received a copy of the GNU General Public License along
with this program (see license.txt); if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.


Last updated 1 Sep 2000
Questions, comments and suggestins to J.B. Hemlock <blag@narcosislabs.org>
