/[pengfork]/pengfork/INSTALL
ViewVC logotype

Diff of /pengfork/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26