From f40b8ad8b9610311028b93f107a13ad21966ff23 Mon Sep 17 00:00:00 2001 From: freesource Date: Fri, 12 Oct 2001 02:52:41 +0000 Subject: [PATCH] Some more stuff. --- swim-doc/html/QUICKSTART.html | 206 ++++++++++++++++++++++++++++++++ swim-doc/html/REQUIREMENTS.html | 139 +++++++++++++++++++++ 2 files changed, 345 insertions(+) create mode 100644 swim-doc/html/QUICKSTART.html create mode 100644 swim-doc/html/REQUIREMENTS.html diff --git a/swim-doc/html/QUICKSTART.html b/swim-doc/html/QUICKSTART.html new file mode 100644 index 0000000..eac3184 --- /dev/null +++ b/swim-doc/html/QUICKSTART.html @@ -0,0 +1,206 @@ + +Quickstart + + +


+ +

QUICKSTART

+ +

+ +
READ THE REQUIREMENTS
+ +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..... + +

+FIRST GET SWIMRC PREPARED + +

Edit the swimrc configution file, you should read swimrc(5), 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. + +

+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. + +

+$package_tool = "/usr/bin/dpkg"; + +

otherwise + +

+$package_tool = "/usr/bin/ar"; + +

+Do you have the apt package installed? Configure this, or -xyz will not +work. + +

+$apt = "yes"; + +

+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. + +

+What flavor, do you want alpha, arm, hurd-i386, i386, m68k, powerpc, +or sparc? (more coming :*) I decided on ..... + +

+$architecture = "i386"; + +

+What kind of distribution do you want to be your default? stable, +unstable, frozen, or experimental (rare) I like the ever changing ... + +

+$distribution = "unstable"; + +

+Decide which sections you want? You can have this + +

+@user_defined_section = qw(main contrib non-free); + +

+or this. + +

+@user_defined_section = qw(main); + +

+or ..... + +

+SECOND GET SWIMZ.LIST PREPARED + +

Now grab a copy of the README.mirrors from +http://www.debian.org/misc/README.mirrors", +you will need this to set-up the configuration file /etc/swim/swimz.list. + +

If your using apt make sure to read swim(8) to get the nitty gritty on how you +can synchronize swim along with apt :*} using swimz.list. + +

+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. + +

+So what site is that? + +

+deb ftp://ftp.swimz.org + +

+What was the directory you happened to notice in the README.mirrors page? + +

+deb ftp://ftp.swimz.org/pub/debian + +

+What distribution did you want? Note: You won't want to use the Release +code name for the distribution, see +swimz.list. + +

+deb ftp://ftp.swimz.org/pub/debian unstable + +

+What sections did you want? + +

+deb ftp://ftp.swimz.org/pub/debian unstable main contrib +non-free + +

+Now put this line in the swimz.list, exactly like written, and ofcourse +use the values you want. + +

+THIRD GET THE DEBIAN DATABASE WITH FTP + +

+Just issue this command. + +

+swim --ftp --Contents DF --Packages DF + +

+and wait a little bit. + +

+FOURTH BUILD THE DATABASES + +

+This is for a computer system with a Debian distribution installed. + +

+swim --initdb + +

+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 :*} + +

+swim --initndb --Contents DF DF + +

+When either of these commands are complete they will say "over and +out". + +

+NOW WHAT? + +

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. swim(8) goes into more detail, the +"Maximum +RPM" book by Edward C. Bailey which is freely available may +provide help for swim's --query option, but you will find that +swim greatly diverges from rpm. + +

Try something like this, and do not use the -n unless you +made the not-installed databases, on the other hand, REMEMBER to +use -n if you do not have an installed Debian system.... + +

+swim -n --search swim + +

+now do this.. + +

+swim -qnSi or swim -hn + +

+go to the directory /usr/bin and do + +

+swim -qnf . + +

+you probably will have to do + +

+swim -qnft . + +

+...the fun is just beginning... + +

+Where are you swimming to today? + + + diff --git a/swim-doc/html/REQUIREMENTS.html b/swim-doc/html/REQUIREMENTS.html new file mode 100644 index 0000000..fa87fac --- /dev/null +++ b/swim-doc/html/REQUIREMENTS.html @@ -0,0 +1,139 @@ + +Requirements + + +


+ + +

REQUIRMENTS:

+ +

+Don't get intimidated, this is just to cover all bases, most computer +systems meet the requirements.

+ +PERL: Yes, preferably Perl 5.004.04 or greater. + +

FTP CAPABILITIES (optional): You may need to get Net::FTP +(Debian libnet-perl package) which depends on Data::Dumper (Debian +data-dumper package). You also need gcc if you do not have a +Debian system so that swim can figure out what architecture your +machine is. You can also find these modules at the CPAN mirrors or the PACKAGES below. + +

READLINE CAPABILITIES (optional): For nice readline +cpabilities get Term::ReadLine::Gnu +or alternatively Term::ReadLine::Perl which depends on Term::ReadKey +. Term::ReadLine::Gnu may be tricky to set-up on non Debian +systems because it depends on ncurses3.4 and the GNU Readline +Library version 2.1 or later, but Term::ReadLine::Perl 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 CPAN mirrors or the PACKAGES below.

+ +DATABASE CAPABILITIES: 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 +bugs which effect SWIM. SWIM can work with +1.85, but --rebuildflatdb and --rebuildflatndb 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: + +

+perl -e 'use DB_File; tie %testdb,'DB_File',"testdb";';
+db_dump testdb + +

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 Berkeley DB if you don't already +have it installed. If you get + + DB_File +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: + +

INCLUDE = /usr/include/db2
+LIB = /usr/lib
+DBNAME = -ldb2 + +

PACKAGES: You can get the CPAN modules in some package formats. +Debian 2.1 and Red Hat 5.0 have been tested with these packages: + +

+Debian
+libnet-perl +and
+data-dumper +and
+libterm-readline-gnu-perl + (plus a lot more) or
+libterm-readline-perl-perl +and
+libterm-readkey-perl
+libdb2 + (dump_db utility is now part of libc6 2.1)
+ +

+Red Hat
+perl-libnet +and
+perl-Data-Dumper
+db-? + +

+USER: root. Some of swim's most important functions will not work +properly unless you are running the program as root. + +

HARD DRIVE SPACE: 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. + +

+ +MEMORY: Databases made for an installed Debian system require +memory in proportion to the amount of packages actually installed; the +--lowmem 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 --Contents option or using the FDB argument for +that option. Updating the databases uses very little memory. + +

OTHER SWIM FUNCTIONS: Most free operating systems have these +packages installed: On a non Debian system, ar from +binutils is used to query Debian binary packages. These next +packages are essential in a free operating system (Linux) - +textutils, fileutils, grep, tar, +gzip, and mount. + +

+ + +