1 |
penggy 0.2.1 INSTALL instructions |
2 |
================================= |
3 |
|
4 |
1. Introduction |
5 |
=============== |
6 |
|
7 |
DISCLAIMER: |
8 |
AOL is a registered trademark of America Online, Inc. |
9 |
Penggy is not endorsed by or affiliated with the AOL trademark. |
10 |
|
11 |
Penggy is a free UNIX client for AOL. It allows UNIX users to connect |
12 |
to the Internet using AOL, through an IP tunneling system. |
13 |
|
14 |
Right now, dialup and TCP/IP connections are supported. It should work |
15 |
on Linux and BSD platforms. |
16 |
It is based on a reverse-engineering of the P3 protocol, therefore |
17 |
nothing was disassembled. It is a continuation of the Peng project, |
18 |
which was abandonned. Everything was totally rewritten from scratch, and |
19 |
the P3 implementation is more rigorous than before. The authors do not |
20 |
take responsibilty for any damage this program could cause to your |
21 |
computer. In other words, if you computer suddenly blows up, starts |
22 |
dancing to the song that's on the radio, or calls you names, you are |
23 |
responsible. |
24 |
|
25 |
It is provided as a command-line tool. No GUI is currently available. |
26 |
|
27 |
2. Requirements |
28 |
=============== |
29 |
|
30 |
2.1. Universal TUN/TAP device driver¹ (Linux) |
31 |
============================================ |
32 |
|
33 |
Penggy uses the Universal TUN/TAP device driver, written by |
34 |
Maxim Krasnyansky. |
35 |
|
36 |
Make sure that "Universal TUN/TAP device driver support" is enabled in |
37 |
your kernel. |
38 |
|
39 |
If TUN/TAP support is already present and penggy still has trouble with |
40 |
it, follow these instructions: |
41 |
|
42 |
Create device node: |
43 |
# mknod /dev/net/tun c 10 200 |
44 |
|
45 |
Driver module autoloading : |
46 |
Make sure that "Kernel module loader" - module auto-loading support is |
47 |
enabled in your kernel. |
48 |
|
49 |
Add the following line to the /etc/modules.conf: |
50 |
alias char-major-10-200 tun |
51 |
|
52 |
Run: |
53 |
# depmod -a |
54 |
|
55 |
The driver will be automatically loaded whenever the application |
56 |
tries to access /dev/net/tun. |
57 |
|
58 |
¹: on BSD platform you have nothing to do, except if you installed a tuned |
59 |
kernel without TUN/TAP support. Otherwise the GENERIC kernel have support |
60 |
for TUN/TAP. |
61 |
|
62 |
2.2. Guile, Project GNU's extension language library |
63 |
==================================================== |
64 |
|
65 |
You must install libguile and libguile-dev packages on your system in |
66 |
order to be able to run and compile penggy. |
67 |
|
68 |
The Guile WWW page is at |
69 |
http://www.gnu.org/software/guile/guile.html |
70 |
|
71 |
If you don't have a packaging system on your distribution or you |
72 |
can't find them, the latest official Guile release should be available |
73 |
via anonymous FTP from |
74 |
ftp://ftp.gnu.org/pub/gnu/guile/ |
75 |
|
76 |
|
77 |
3. Installation |
78 |
=============== |
79 |
|
80 |
Penggy can be obtained at https://savannah.nongnu.org/projects/pengfork/ |
81 |
|
82 |
Make sure to download the last stable version. If you feel more |
83 |
adventurous, you can try the CVS version, but this is not guaranteed |
84 |
to work. |
85 |
|
86 |
Installation is quite simple. Get the package, which is provided as |
87 |
a .tar.gz archive, and put it somewhere on your system. Now you need to |
88 |
uncompress and untar the files contained within the archive. That can be |
89 |
done very simply (we'll assume your archive is version 0.2.1) |
90 |
|
91 |
$ tar xvzf penggy-0.2.1.tar.gz |
92 |
|
93 |
The files should have been decompressed to a directory called penggy-0.2.1 |
94 |
You now need to go to that directory and compile the program : |
95 |
|
96 |
$ cd penggy-0.2.1 |
97 |
$ ./configure |
98 |
$ make |
99 |
$ make install |
100 |
|
101 |
NOTE REGARDING DEFAULT DIRECTORIES: |
102 |
Now everything is installed under $prefix (which default is /usr/local), |
103 |
so configuration is under $prefix/etc/penggy ! |
104 |
This is the normal configure behaviour. I realize it may be annoying for |
105 |
some users but this may be changed with configure parameters. |
106 |
Example: |
107 |
$ ./configure --sysconfdir=/etc |
108 |
(this is the parameters to give to have the previous default behaviour) |
109 |
|
110 |
If you need any particular option, such as cross-compiling, you can get |
111 |
some help by typing : |
112 |
|
113 |
$ ./configure --help |
114 |
|
115 |
Now penggy should be compiled and installed. But we're not all set yet. |
116 |
We still need to configure it. |
117 |
|
118 |
4. Configuration |
119 |
================ |
120 |
|
121 |
In this section we assume your configuration directory is /etc. |
122 |
During the install process, the /etc/penggy directory was created, and it |
123 |
has withing it several files we need to look at. |
124 |
|
125 |
If these files were previously installed on your system, the install process |
126 |
will not overwrite them but will create files with .new suffixes instead. |
127 |
|
128 |
Last step is configuration. Quite many options are available here. |
129 |
|
130 |
You need to modify your configuration files and make them look like as |
131 |
follows : |
132 |
|
133 |
In /etc/penggy/aol-secrets put your AOL account(s) information : |
134 |
[YourScreenName] [YourPassword] |
135 |
[AnotherScreenName] [AnotherPassword] |
136 |
.... |
137 |
|
138 |
In /etc/penggy/phonetab put your AOL dialup number(s) : |
139 |
[YourAOLDialupNumber] |
140 |
[AnAlternativeOne] |
141 |
.... |
142 |
|
143 |
The file /etc/penggy/penggy.cfg is self-documented but the most commonly |
144 |
used options are: |
145 |
|
146 |
screen_name = [YourScreenName] |
147 |
# auto_reconnect = yes |
148 |
# daemon = yes |
149 |
modem_device = /dev/modem (Note : If this doesn't work, you might want |
150 |
to try /dev/ttyS0) |
151 |
|
152 |
Depending on your modem, you might need to change the initialization |
153 |
strings using initstr1 to initstr9 parameters. |
154 |
You can configure penggy to automatically redial (or reconnect) if you |
155 |
get disconnected, by activating the corresponding option. You can also |
156 |
set it to run as a daemon. |
157 |
|
158 |
|
159 |
5. Usage |
160 |
======== |
161 |
|
162 |
Most of the options available in the congiguration file can be overidden |
163 |
from the command line. For more information type : |
164 |
$ penggy --help |
165 |
|
166 |
The last step after compiling, installing and configuring is running the |
167 |
software, and praying for it to work : |
168 |
$ penggy |
169 |
|
170 |
PENGGY MUST BE RUN AS ROOT. If you're looking for a way to run it as a user |
171 |
the use of sudo is greatly recommended (see sudo(8) and sudoers(5)) |
172 |
|
173 |
Have fun! |
174 |
|
175 |
* If you encounter any problems, or need additional help, you can go to |
176 |
http://www.peng.apinc.org/forum |
177 |
|
178 |
6. About |
179 |
======== |
180 |
|
181 |
This little install guide was written by Pascal Roget <pascal@epascal.net>. |
182 |
If you have any suggestion or want to report a typo or just chat, feel |
183 |
free to send me an email. I am very likely to respond, and I like getting |
184 |
mail :) |
185 |
|
186 |
The program itself was coded by Jean-Charles Salzeber <chupa@penggy.org>. |
187 |
Greetings to him and to his genius :) |
188 |
|
189 |
Last update : Feb 08th, 2003. |
190 |
Reviewed by Jean-Charles |