source: apps/i2psnark/readme-snark.txt @ 02c1417

Last change on this file since 02c1417 was 02c1417, checked in by zzz <zzz@…>, 5 years ago

update ancient snark docs

  • Property mode set to 100644
File size: 5.5 KB
Line 
1The Hunting of the Snark Project - BitTorrent Application Suite
20.5 - The Beaver's Lesson (27 June 2003)
3
4  "It's a Snark!" was the sound that first came to their ears,
5     And seemed almost too good to be true.
6  Then followed a torrent of laughter and cheers:
7     Then the ominous words "It's a Boo-"
8
9  -- from The Hunting Of The Snark by Lewis Carroll
10
11Snark is a client for downloading and sharing files distributed with
12the BitTorrent protocol. It is mainly used for exploring the BitTorrent
13protocol and experimenting with the the GNU Compiler for Java (gcj).
14But it can also be used as a regular BitTorrent Client.
15
16Snark can also act as a torrent creator, micro http server for delivering
17metainfo.torrent files and has an integrated Tracker for making sharing of
18files as easy as possible.
19
20When you give the option --share Snark will automatically
21create a .torrent file, start a very simple webserver to distribute
22the metainfo.torrent file and a local tracker that other BitTorrent
23clients can connect to.
24
25Distribution
26------------
27
28  Copyright (C) 2003 Mark J. Wielaard
29
30  Snark is free software; you can redistribute it and/or modify
31  it under the terms of the GNU General Public License as published by
32  the Free Software Foundation; either version 2 of the License, or
33  (at your option) any later version.
34
35  This program is distributed in the hope that it will be useful,
36  but WITHOUT ANY WARRANTY; without even the implied warranty of
37  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
38  GNU General Public License for more details.
39
40  You should have received a copy of the GNU General Public License
41  along with this program; if not, write to the Free Software
42  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
43
44Requirements/Installation
45-------------------------
46
47The GNU Compiler for java (gcj) version 3.3 or later.
48(Earlier versions have a faulty SHA message digest implementation.)
49On Debian GNU/Linux based distributions just install the gcj-3.3 package.
50Edit the GCJ variable in the Makefile if your gcj binary is not gcj-3.3.
51
52Typing 'make' will create the native snark binary and a snark.jar file
53for use with traditional java byte code interpreters.
54
55It is possible to compile the sources with other java compilers
56like jikes or kjc to produce the snark.jar file.  Edit the JAVAC and
57JAVAC_FLAGS variables on top of the Makefile for this.  And type
58'make snark.jar' to create a jar file that can be used by traditional
59java bytecode interpreters like kaffe: 'kaffe -jar snark.jar'.
60You will need at least version 1.1 of kaffe for all functionality to work
61correctly ('--share' does not work with older versions).
62
63When trying out the experimental Gnome frontend you also need the java-gnome
64bindings. On Debian GNU/Linux systems install the package libgnome0-java.
65You can try it out by typing 'make snark-gnome' and then run 'snark-gnome.sh'
66like you would with the normal command line client.
67
68Running
69-------
70
71To use the program start it with:
72
73snark [--debug [level]] [--no-commands] [--port <port>]
74      [--share (<ip>|<host>)] (<url>|<file>|<dir>)
75  --debug       Shows some extra info and stacktraces.
76    level       How much debug details to show
77                (defaults to 3, with --debug to 4, highest level is 6).
78  --no-commands Don't read interactive commands or show usage info.
79  --port        The port to listen on for incomming connections
80                (if not given defaults to first free port between 6881-6889).
81  --share       Start torrent tracker on <ip> address or <host> name.
82  <url>         URL pointing to .torrent metainfo file to download/share.
83  <file>        Either a local .torrent metainfo file to download
84                or (with --share) a file to share.
85  <dir>         A directory with files to share (needs --share).
86
87Since this is an early beta release there are probably still some bugs
88in the program. To help find them run the program with the --debug
89option which shows more information on what it going on. You can also give
90the level of debug output you want. Zero will give (almost) no output at all.
91Everything above debug level 4 is probably to much (only really useful to
92see what goes on on the protocol/network level).
93
94Examples
95
96- To simple start downloading/sharing a file.
97  Either download the .torrent file to disk and start snark with:
98  ./snark somefile.torrent
99
100  Or give it the complete URL:
101  ./snark http://somehost.example.com/cd-images/bbc-lnx.iso.torrent
102
103- To start seeding/sharing a local file:
104  ./snark --share my-host.example.com some-file
105
106  Snark will respond with:
107  Listening on port: 6881
108  Trying to create metainfo torrent for 'some-file'
109  Creating torrent piece hashes: ++++++++++
110  Torrent available on http://my-host.example.com:6881/metainfo.torrent
111
112  You can now point other people to the above URL so they can share
113  the file with their own BitTorrent client.
114
115Commands
116
117While the program is running in text mode you can currently give the
118following commands: 'info', 'list' and 'quit'.
119
120Interactive commands are disabled when the '--no-commands' flag is given.
121This is sometimes desireable for running snark in the background.
122
123More information
124----------------
125
126- The Evolution of Cooperation - Robert Axelrod
127  ISBN 0-465-02121-2
128
129- The BitTorrent protocol description:
130  <http://bitconjurer.org/BitTorrent/protocol.html>
131
132- The GNU Compiler for Java (gcj):
133  <http://gcc.gnu.org/java/>
134
135- java-gnome bindings : <http://java-gnome.sourceforge.net/>
136
137- The Hunting of the Snark - Lewis Carroll
138
139Comments welcome
140
141        - Mark Wielaard <mark@klomp.org>
Note: See TracBrowser for help on using the repository browser.