Hotlist
=-=-=-=

(http://www.stelo.uklinux.net/hotlist)

This is a hotlist manager. The basic idea is that you use the
executable `hotlist' to perform various functions on a bookmark file,
which is stored in HTML. The name of this file is set in the source or
taken from an environment variable defined in the source if it exists
(look in `filenames.h').

Hint: Set that bookmark file as your homepage on Netscape or whatever
browser you use, and you'll see it every time you load the thing.

The reason that this program exists is because I wanted somewhere
to jot down URLs that I want to visit, and then be able to remove them
easily later, once I have visited them. Its a very simple task, and
would undoubtedly have been better done with a script, but I used it
as a learning exercise.

INSTALLATION:

Easy, just untar the sources, change the definitions in `filenames.h'
if you want, then type make and copy the `hotlist' executable to
wherever you want it. Easy.

USAGE:

Once installed, you should probably set the environment variable
$HOTLISTFILE to the path of the file you want to use, if you haven't
hard-coded the name of the file into the source.

Once this is done, you must initiate this file, which involves putting
in the required HTML headers etc:

	hotlist i

This will create the file. To add a URL, type:

	hotlist a <url>

and it will be added. Also, an optional description can be added with
the URL, which will be seen in the bookmark file as a link instead of
the raw address:

	hotlist a <url> <desc>

You can then use the 'l' command to list the URLs that you have added
along with its associated number.

Finally, to delete it:

	hotlist d <number to delete>

Well, really, thats all there is to it!

NOTES:

At the moment, although this software does work, it is still under
development, so its functionality is somewhat limited, and little
error checking is done. It will not check to see if you try to delete
an non existing URL, and most I/O errors cause core dumps. Still, if
you really can't handle it, the source is there! I will try fix these
things as I go along, so check the website
(http://www.stelo.uklinux.net/hotlist/) or email me to see what is going
on.

And finally, NO WARRANTY is given with this software, implied or
otherwise. You are free to use it and the source as you wish, but
whatever happens, IT'S NOT MY FAULT! Nobody forced you to use it...

HISTORY:

0.0.1 Basic functionality: add and delete of bookmarks made as
separate functions, no user interface as of yet.

0.0.2 Hotlist filename now taken from environment variable

0.0.9 Add user interface, version command, first usable version!

0.1.0 It now complains if you try to delete a URL that doesn't exist.

0.2.0 Alan Cameron added 'list URLs' functionality, so the URLs can be
easily viewed from the command line. In addition, it now uses OL/LI
tags within the HTML file so that the bookmarks are numbered there
too.

0.2.5 Checks that bookmark start and end tags are correct before
accessing the bookmark file [pr].

0.2.6 Now supports a description associated with a URL [ac].

TODO:

Trap more errors. At the moment you can do pretty much anything you
want, and the program won't complain, just not work!

CREDITS:

The following people have worked on Hotlist (thanks to everyone):

Paul Roberts <sakar@stelo.uklinux.net>
Alan Cameron