Browse Source

Moved to swim-doc/html

master
freesource 23 years ago
parent
commit
35d5eb9cc1
  1. 206
      QUICKSTART.html
  2. 139
      REQUIREMENTS.html

206
QUICKSTART.html

@ -1,206 +0,0 @@
<html>
<head><title>Quickstart</title></head>
<body text="#000000" bgcolor="#FFFFFF" link="#0000EF" vlink="#51188E"
alink="#FF0000">
<br><br><br>
<h1 align=center>QUICKSTART</h1>
<br><br>
<h5>READ THE <A HREF="REQUIREMENTS.html">REQUIREMENTS</A></h5>
Now you can skip the next three steps if you have an installed Debian
distribution and you are in a hurry for a demonstration, but you will miss
out on swim's more awesome capabilities. With that said.....
<p>
<b>FIRST GET SWIMRC PREPARED</b>
<p> Edit the swimrc configution file, you should read <A
HREF="swimrc.html/index.html">swimrc(5)</A>, but I'll ask you some
question right now. You can find swimrc in /etc/swim, and swimrc can be
placed in your home directory in the subdirectory .swim. Entries in the
home directory swimrc override ones in /etc/swim.
<p>
Are you using an installed Debian system? If so, you almost definitely
have dpkg installed. So uncomment this line in /etc/swim/swimrc by
removing the pound sign.
<p>
<code>$package_tool = "/usr/bin/dpkg";</code>
<p>otherwise
<p>
<code>$package_tool = "/usr/bin/ar";</code>
<p>
Do you have the apt package installed? Configure this, or -xyz will not
work.
<p>
<code>$apt = "yes";</code>
<p>
Now you need to decide what architecture you would like to be swim's
default value when you download, build, and query the not-installed
databases.
<p>
What flavor, do you want alpha, arm, hurd-i386, i386, m68k, powerpc,
or sparc? (more coming :*) I decided on .....
<p>
<code>$architecture = "i386";</code>
<p>
What kind of distribution do you want to be your default? stable,
unstable, frozen, or experimental (rare) I like the ever changing ...
<p>
<code>$distribution = "unstable";</code>
<p>
Decide which sections you want? You can have this
<p>
<code>@user_defined_section = qw(main contrib non-free);</code>
<p>
or this.
<p>
<code>@user_defined_section = qw(main);</code>
<p>
or .....
<p>
<b>SECOND GET SWIMZ.LIST PREPARED</b>
<p> Now grab a copy of the <A
HREF="http://www.debian.org/misc/README.mirrors">README.mirrors</A> from
http://www.debian.org/misc/README.mirrors",
you will need this to set-up the configuration file /etc/swim/swimz.list.
<p> If your using apt make sure to read <A
HREF="swim.html/index.html">swim(8)</A> to get the nitty gritty on how you
can synchronize swim along with apt :*} using <A
HREF="swim.html/ch-important.html#s5.6">swimz.list</A>.
<p>
Humm, you found a site which has the distribution you want, and you know
which section you want, and you are happy knowing about packages which can
install on the architecture you computer happens to have.
<p>
So what site is that?
<p>
<code>deb ftp://ftp.swimz.org</code>
<p>
What was the directory you happened to notice in the README.mirrors page?
<p>
<code>deb ftp://ftp.swimz.org/pub/debian</code>
<p>
What distribution did you want? Note: You won't want to use the Release
code name for the distribution, see
<A HREF="swim.html/ch-important.html#s5.6">swimz.list</A>.
<p>
<code>deb ftp://ftp.swimz.org/pub/debian unstable</code>
<p>
What sections did you want?
<p>
<code>deb ftp://ftp.swimz.org/pub/debian unstable main contrib
non-free</code>
<p>
Now put this line in the swimz.list, exactly like written, and ofcourse
use the values you want.
<p>
<b>THIRD GET THE DEBIAN DATABASE WITH FTP</b>
<p>
Just issue this command.
<p>
<kbd>swim --ftp --Contents DF --Packages DF</kbd>
<p>
and wait a little bit.
<p>
<b>FOURTH BUILD THE DATABASES</b>
<p>
This is for a computer system with a Debian distribution installed.
<p>
<kbd>swim --initdb</kbd>
<p>
This next part applies to people who followed all the steps to get here,
and also read the important requirements at the top. This makes the
not-installed databases. Go take a walk, or a swim :*}
<p>
<kbd>swim --initndb --Contents DF DF</kbd>
<p>
When either of these commands are complete they will say "<samp>over and
out</samp>".
<p>
<b>NOW WHAT?</b>
<p> Now the real fun begins. If you happen to have some experience with
rpm you already know some of the options which swim uses, but be prepared
for surpises. <A HREF="swim.html/index.html">swim(8)</A> goes into more detail, the
<A HREF="http://www.rpm.org/maximum-rpm.ps.gz">"<cite>Maximum
RPM</cite>"</A> book by Edward C. Bailey which is freely available may
provide help for swim's <kbd>--query</kbd> option, but you will find that
swim greatly diverges from rpm.
<p> Try something like this, and do not use the <kbd>-n</kbd> unless you
made the not-installed databases, on the other hand, <em>REMEMBER</em> to
use <kbd>-n</kbd> if you do not have an installed Debian system....
<p>
<kbd>swim -n --search swim</kbd>
<p>
now do this..
<p>
<kbd>swim -qnSi</kbd> or <kbd>swim -hn</kbd>
<p>
go to the directory /usr/bin and do
<p>
<kbd>swim -qnf</kbd> <b>.</b>
<p>
you probably will have to do
<p>
<kbd>swim -qnft</kbd> <b>.</b>
<p>
<b>...the fun is just beginning...</b>
<p>
<em>Where are you swimming to today?</em>
</body>
</html>

139
REQUIREMENTS.html

@ -1,139 +0,0 @@
<html>
<head><title>Requirements</title></head>
<body text="#000000" bgcolor="#FFFFFF" link="#0000EF" vlink="#51188E"
alink="#FF0000">
<br><br><br>
<h2>REQUIRMENTS:</h2>
<p>
Don't get intimidated, this is just to cover all bases, most computer
systems meet the requirements.<p>
<b>PERL</b>: Yes, preferably Perl 5.004.04 or greater.
<p> <b>FTP CAPABILITIES (optional)</b>: You may need to get <A
HREF="ftp://www.perl.com/pub/perl/CPAN/modules/by-category/05_Networking_Devices_IPC/Net/libnet-1.0606.tar.gz">Net::FTP</A>
(Debian libnet-perl package) which depends on Data::Dumper (Debian
data-dumper package). You also need <b>gcc</b> if you do not have a
Debian system so that <em>swim</em> can figure out what architecture your
machine is. You can also find these modules at the <A
HREF="http://www.perl.com">CPAN mirrors</A> or the PACKAGES below.
<p> <b>READLINE CAPABILITIES (optional)</b>: For nice readline
cpabilities get <A
HREF="ftp://www.perl.com/pub/perl/CPAN/modules/by-module/Term/Term-ReadLine-Gnu-1.03.tar.gz">Term::ReadLine::Gnu</A>
or alternatively <A
HREF="ftp://www.perl.com/pub/perl/CPAN/modules/by-module/Term/Term-ReadLine-Perl-0.990
6.tar.gz">Term::ReadLine::Perl</A> which depends on <A
HREF="ftp://www.perl.com/pub/perl/CPAN/modules/by-module/Term/TermReadKey-2.12.tar.gz">Term::ReadKey</A>
. <em>Term::ReadLine::Gnu</em> may be tricky to set-up on non Debian
systems because it depends on <em>ncurses3.4</em> and the <em>GNU Readline
Library version 2.1 or later</em>, but <em>Term::ReadLine::Perl</em> is
much easier to set-up and allows a huge amount of package names to be
present on the command line without a segmentation fault. You could get
swim's ftp capabilities working first, and then just fetch the Debian
ReadLine package(s) and then use swim's --extract option to set the
package(s) up, but, it is sure fun doing a 'make test' when setting up the
ReadLine modules! You can also find these modules at the <A
HREF="http://www.perl.com">CPAN mirrors</A> or the PACKAGES below. <p>
<b>DATABASE CAPABILITIES</b>: DB_File comes standard with Perl. But,
this doesn't mean it is compiled for the newer Berkeley Database
Libraries. DB 1.85 has
known <A
HREF="http://www.sleepycat.com/historic.html">
bugs</A> which effect SWIM. SWIM can work with
1.85, but <kbd>--rebuildflatdb</kbd> and <kbd>--rebuildflatndb</kbd> will
not work properly. You can run a test to find out whether or not you need
to make the change if you have db_dump available on your system (which
db_dump). Enter this:
<P>
<code>perl -e 'use DB_File; tie %testdb,'DB_File',"testdb";';<br>
db_dump testdb</code>
<P>If 'db_dump testdb' produces an error you need to make the change by
installing the newest DB_File. If you have a version of libc6 less than
2.1, first, install a new version ( 2.3.4 or greater) of the <A
HREF="http://www.sleepycat.com">Berkeley DB</A> if you don't already
have it installed. If you get
<A
HREF="ftp://www.perl.com/pub/perl/CPAN/modules/by-module/DB_File/DB_File-1.65.tar.gz">
DB_File</A>
from CPAN you will need to edit
config.in to point to the location of where libdb2 installed db.h, where
libdb2 is installed on your system, and the name of the library. For
Debian this would be:
<P><code>INCLUDE = /usr/include/db2<br>
LIB = /usr/lib<br>
DBNAME = -ldb2</code>
<p><b>PACKAGES</b>: You can get the CPAN modules in some package formats.
Debian 2.1 and Red Hat 5.0 have been tested with these packages:
<p>
<u><em>Debian</em></u><br>
<A
HREF="http://www.debian.org/Packages/unstable/base/libnet-perl.html">libnet-perl</A>
and<br>
<A
HREF="http://www.debian.org/Packages/unstable/base/data-dumper.html">data-dumper</A>
and<br>
<A
HREF="http://www.debian.org/Packages/unstable/interpreters/libterm-readline-gnu-perl.html">libterm-readline-gnu-perl</A>
(plus a lot more) or<br>
<A
HREF="http://www.debian.org/Packages/unstable/interpreters/libterm-readline-perl-perl.html">libterm-readline-perl-perl</A>
and<br>
<A
HREF="http://www.debian.org/Packages/unstable/libs/libterm-readkey-perl.html">libterm-readkey-perl</A><br>
<A HREF="http://www.debian.org/Packages/unstable/libs/libdb2.html">libdb2</A>
(dump_db utility is now part of libc6 2.1)<br>
<p>
<u><em>Red Hat</em></u><br>
<A
HREF="http://filewatcher.org/filename-search/?q=perl-libnet">perl-libnet</A>
and<br>
<A
HREF="http://filewatcher.org/filename-search/?q=perl-Data-Dumper">perl-Data-Dumper</A><br>
<A HREF="http://filewatcher.org/description-search/?q=libdb">db-?</a>
<p>
<b>USER</b>: root. Some of swim's most important functions will not work
properly unless you are running the program as root.
<p><b>HARD DRIVE SPACE</b>: Make sure you have enough hard drive space.
1500
installed packages produces a 10MB fileindex.deb, and the virtual
not-installed filesystem database for the unstable distribution is now
over 40MB. 100MB of free space on your hard drive is probably a good
safety margin, if you run out of hard drive space the program will just
hang or quit.
<p>
<b>MEMORY</b>: Databases made for an installed Debian system require
memory in proportion to the amount of packages actually installed; the
<kbd>--lowmem</kbd> option is an excellent alternative for making the
databases if the computer system is either overloaded or low on memory.
If you get "out of memory" warnings try to free up some memory first then
make the databases. You can also avoid making the virtual filesystem by
not using the <kbd>--Contents</kbd> option or using the FDB argument for
that option. Updating the databases uses very little memory.
<p> <b>OTHER SWIM FUNCTIONS</b>: Most free operating systems have these
packages installed: On a non Debian system, <b>ar</b> from
<em>binutils</em> is used to query Debian binary packages. These next
packages are essential in a free operating system (Linux) -
<em>textutils</em>, <em>fileutils</em>, <em>grep</em>, <em>tar</em>,
<em>gzip</em>, and <em>mount</em>.
<p>
</body>
</html>
Loading…
Cancel
Save