1 |
# WELCOME TO PENGGY |
# WELCOME TO PENGGY |
2 |
# ----------------- |
# ----------------- |
3 |
# |
# |
4 |
# This is a sample configuration file for penggy |
# This is a sample configuration file for Penggy. |
5 |
# |
# |
6 |
# The general format is lines with parameter = value pairs. |
# The general format is lines with parameter = value pairs. |
7 |
# Lines starting with a hash mark (``#'') and empty lines are ignored. |
# Lines starting with a hash mark (``#'') and empty lines are ignored. |
8 |
# |
# |
9 |
# This default Penggy config file shows what the defaults for |
# This default Penggy config file shows what the defaults for |
10 |
# various options happen to be. If you don't need to change the |
# various options are. If you don't need to change a |
11 |
# default, you shouldn't uncomment the line. |
# default option, you needn't uncomment the line. |
12 |
# |
# |
13 |
# Most of this paramaters can be overriden on the command line, |
# Most of these paramaters can be overidden from the command line. |
14 |
# Try penggy --help for more information |
# Try penggy --help for more information |
15 |
|
|
16 |
# GENERAL OPTIONS, useful for everybody |
# GENERAL OPTIONS, useful for everybody |
19 |
# Parameter: access_method |
# Parameter: access_method |
20 |
# Type: string |
# Type: string |
21 |
# Possible values: modem, tcpip, cable, dsl |
# Possible values: modem, tcpip, cable, dsl |
22 |
# Description: set the media used to access AOL. |
# Description: sets the type of device used for connecting |
23 |
# Default: modem |
# Default: modem |
24 |
# |
# |
25 |
# Cable and DSL media are not really implemented yet. |
# Cable and DSL are not really implemented yet. |
26 |
# If you have such media, use tcpip instead. |
# If you have that kind of connection device, you should use tcpip instead. |
27 |
# |
# |
28 |
# access_method = modem |
# access_method = modem |
29 |
|
|
30 |
# Parameter: protocol |
# Parameter: protocol |
31 |
# Type: string |
# Type: string |
32 |
# Possible values: p3, l2tp |
# Possible values: p3, l2tp |
33 |
# Description: set the protocol used for communication with AOL. |
# Description: Sets the protocol used for communicating |
34 |
# Default: p3 |
# Default: p3 |
35 |
# |
# |
36 |
# L2TP (also known as FLAP on AOL) is the new protocol used by AOL software |
# L2TP (also known as FLAP on AOL) is the new protocol used by AOL software |
37 |
# this support is not yet implemented, so do not change this option at all. |
# its support isn't implemented yet. Don't change it. |
38 |
# |
# |
39 |
# protocol = p3 |
# protocol = p3 |
40 |
|
|
41 |
# Parameter: interface_type |
# Parameter: interface_type |
42 |
# Type: string |
# Type: string |
43 |
# Possible values: tun |
# Possible values: tun |
44 |
# Description: set the interface type. |
# Description: sets the interface type. |
45 |
# Default: tun |
# Default: tun |
46 |
# |
# |
47 |
# Actually, only tun is supported, this option is only here for the future. |
# Only tun is currently supported. This option is only here for the future. |
48 |
# |
# |
49 |
# interface-type = tun |
# interface-type = tun |
50 |
|
|
51 |
# Parameter: interface_name |
# Parameter: interface_name |
52 |
# Type: string |
# Type: string |
53 |
# Description: set the interface name created. |
# Description: sets the created interface's name. |
54 |
# No default |
# No default |
55 |
# |
# |
56 |
# Default is to reserve the first tun interface available and it's a good |
# Default is to reserve the first tun interface available and it's a good |
60 |
|
|
61 |
# Parameter: secret_file |
# Parameter: secret_file |
62 |
# Type: path |
# Type: path |
63 |
# Description: set the file where password are stored |
# Description: sets the file where your passwords are stored |
64 |
# Default: /etc/penggy/aol-secrets |
# Default: /etc/penggy/aol-secrets |
65 |
# |
# |
66 |
# Change this only if you really want to store your passwords elsewhere. |
# Change this only if you really want to store your passwords elsewhere. |
69 |
|
|
70 |
# Parameter: screen_name |
# Parameter: screen_name |
71 |
# Type: string |
# Type: string |
72 |
# Description: set the screen-name to use for connection |
# Description: sets the screen-name to be used for connection |
73 |
# No default |
# No default |
74 |
# |
# |
75 |
# This option is used to tell penggy to connect on this screen name. |
# This option is used to tell penggy to connect on this screen name. |
76 |
# Really edit this parameter or pass it at the command line prompt or |
# You really need to change this parameter or pass it at the command line |
77 |
# penggy will complain of no screen name to connect as. |
# prompt, or penggy will complain about not having any screen name to |
78 |
|
# connect as. |
79 |
# |
# |
80 |
# screen_name = frankeinstein |
# screen_name = frankeinstein |
81 |
|
|
84 |
# Description: enable autoreconnection. |
# Description: enable autoreconnection. |
85 |
# Default: false |
# Default: false |
86 |
# |
# |
87 |
# If you set this option to true, penggy will automaticly reconnect |
# If you set this option to true, penggy will automatically reconnect |
88 |
# when it detect the connection is down. |
# when it detects you were cut off. |
89 |
# |
# |
90 |
# auto_reconnect = false |
# auto_reconnect = false |
91 |
|
|
92 |
# Parameter: reconnect_delay |
# Parameter: reconnect_delay |
93 |
# Type: integer |
# Type: integer |
94 |
# Description: set the delay between reconnections. |
# Description: sets the delay between reconnections. |
95 |
# Default: 0 |
# Default: 0 |
96 |
# |
# |
97 |
# This option have no effect if autoreconnection is disabled. |
# This option will have no effect if autoreconnection is disabled. |
98 |
# If set to >0, penggy will wait this amount of time (in seconds) |
# If set it to >0, penggy will wait this amount of time (in seconds) |
99 |
# before attempting a new connection. |
# before attempting a new connection. |
100 |
# |
# |
101 |
# reconnect_delay = 0 |
# reconnect_delay = 0 |
102 |
|
|
103 |
# Parameter: daemon |
# Parameter: daemon |
104 |
# Type: boolean |
# Type: boolean |
105 |
# Description: enable daemon mode, run in background. |
# Description: enables daemon mode, runs penggy in the background. |
106 |
# Default: false |
# Default: false |
107 |
# |
# |
108 |
# If this option is set to true, penggy will fork in the background |
# If this option is set to true, penggy will work in the background |
109 |
# and output will be done in (see syslogd(8) for more information). |
# and output will be done in (see syslogd(8) for more information). |
110 |
# To end penggy you need to kill him doing a : |
# To end penggy you need to kill it with a : |
111 |
# kill `cat /var/run/penggy.pid` |
# kill `cat /var/run/penggy.pid` |
112 |
# |
# |
113 |
# daemon = false |
# daemon = false |
115 |
# Parameter: debug_level |
# Parameter: debug_level |
116 |
# Type: integer |
# Type: integer |
117 |
# Possible values: 0 to 10 |
# Possible values: 0 to 10 |
118 |
# Description: set the verbosity level of the debug. |
# Description: sets the verbosity level of the debug. |
119 |
# Default: 0 |
# Default: 0 |
120 |
# |
# |
121 |
# This option is probably only useful for developers. |
# This option is probably only useful to developers. |
122 |
# |
# |
123 |
# debug_level = 0 |
# debug_level = 0 |
124 |
|
|
125 |
# Parameter: set_dns |
# Parameter: set_dns |
126 |
# Type: boolean |
# Type: boolean |
127 |
# Description: set the dns when connected. |
# Description: set the when connected. |
128 |
# Default: true |
# Default: true |
129 |
# |
# |
130 |
# The default(true) is to write the dns file (see resolv.conf(5) for more |
# The default(true) is to write the dns file (see resolv.conf(5) for more |
131 |
# information) according to what the server give. |
# information) according to what the server gives. |
132 |
# If you don't want this behaviour (ex: you have your own DNS server), set |
# If you don't want this behavior (ex: you have your own DNS server), set |
133 |
# this option to false. |
# this option to false. |
134 |
# |
# |
135 |
# set_dns = true |
# set_dns = true |
139 |
# Description: set the PID file to create. |
# Description: set the PID file to create. |
140 |
# Default: /var/run/penggy.pid |
# Default: /var/run/penggy.pid |
141 |
# |
# |
142 |
# This is the file where penggy store his current PID. |
# This is the file where penggy stores its current PID. |
143 |
# Keeping the default if probably a good idea. |
# Keeping the default is a good idea. |
144 |
# |
# |
145 |
# pid_file = /var/run/penggy.pid |
# pid_file = /var/run/penggy.pid |
146 |
|
|
147 |
# Parameter: ip_up_script |
# Parameter: ip_up_script |
148 |
# Type: path |
# Type: path |
149 |
# Description: set the script automaticly called when IP is up. |
# Description: set the script automatically called when IP is up. |
150 |
# Default: /etc/penggy/ip-up |
# Default: /etc/penggy/ip-up |
151 |
# |
# |
152 |
# This shell script is executed when IP tunnel start. |
# This shell script is executed when IP tunneling is started. |
153 |
# It may be useful to edit this script to change firewall rules or whatever. |
# It may be useful to edit this script to change firewall rules or whatever. |
154 |
# Actually this script is also reponsible for making the connection up |
# This script is also reponsible for making the connection up |
155 |
# and setting the routing table so be careful when editing it. |
# and setting the routing table, so very be careful when editing it. |
156 |
# |
# |
157 |
# ip_up_script = /etc/penggy/ip-up |
# ip_up_script = /etc/penggy/ip-up |
158 |
|
|
167 |
|
|
168 |
|
|
169 |
|
|
170 |
# MODEM OPTIONS, useful only if you use the modem media |
# MODEM OPTIONS, only useful if you are using a modem to connect |
171 |
# -------------------------------------------------------------------- |
# -------------------------------------------------------------------- |
172 |
|
|
173 |
# Parameter: modem_device |
# Parameter: modem_device |
174 |
# Type: path |
# Type: path |
175 |
# Description: set the serial device to use for the modem. |
# Description: sets the serial device to use for the modem. |
176 |
# Default: /dev/modem |
# Default: /dev/modem |
177 |
# |
# |
178 |
# The default is probably good if /dev/modem is a link to your real serial |
# The default is probably good if /dev/modem is a link to your real serial |
179 |
# device where your modem is attached. Otherwise change this parameter. |
# device your modem is attached to. Otherwise change this parameter. |
180 |
# |
# |
181 |
# modem_device = /dev/modem |
# modem_device = /dev/modem |
182 |
|
|
185 |
# Description: enable hardware flow control. |
# Description: enable hardware flow control. |
186 |
# Default: true |
# Default: true |
187 |
# |
# |
188 |
# Near all modem support hardware flow control, so you probably don't take |
# Nearly all modems support hardware flow control, so you don't want to change |
189 |
# care of this parameter if you don't know what it is. |
# this parameter, unless you really have a good reason. |
190 |
# |
# |
191 |
# rtscts = true |
# rtscts = true |
192 |
|
|
193 |
# Parameter: initstr1 |
# Parameter: initstr1 |
194 |
# Type: string |
# Type: string |
195 |
# Description: set the primary initialization string sent to the modem. |
# Description: sets the primary initialization string sent to the modem. |
196 |
# Default: ATZ |
# Default: ATZ |
197 |
# |
# |
198 |
# Hayes command to initialize the modem, keeping ATZ as primary init string |
# Hayes command to initialize the modem, keeping ATZ as primary init string |
202 |
|
|
203 |
# Parameter: initstr[2-9] |
# Parameter: initstr[2-9] |
204 |
# Type: string |
# Type: string |
205 |
# Description: set other initialization string. |
# Description: sets other initialization strings. |
206 |
# No default |
# No default |
207 |
# |
# |
208 |
# Other Hayes command to init the modem. |
# Other Hayes commands to init the modem. |
209 |
# |
# |
210 |
# initstr2 = |
# initstr2 = |
211 |
# initstr3 = |
# initstr3 = |
218 |
|
|
219 |
# Parameter: dialstr |
# Parameter: dialstr |
220 |
# Type: string |
# Type: string |
221 |
# Description: set the string used to dial. |
# Description: sets the string used to dial. |
222 |
# Default: ATDT |
# Default: ATDT |
223 |
# |
# |
224 |
# Do not change this parameter if you don't know what it is. |
# Do not change this parameter if you don't know what it is. |
227 |
|
|
228 |
# Parameter: dial_prefix |
# Parameter: dial_prefix |
229 |
# Type: string |
# Type: string |
230 |
# Description: set prefix to compose to obtain the tonality. |
# Description: sets a prefix to dial before the number to get a dial tone. |
231 |
# No default |
# No default |
232 |
# |
# |
233 |
# You may need a prefix to obtain an external line. This parameter |
# You may need a prefix to get an external line. This parameter |
234 |
# will be used for this. |
# will be used for this. |
235 |
# Do not forget to add a colon if you need a pause (likely) |
# Do not forget to add a colon if you need a pause (which is likely) |
236 |
# |
# |
237 |
# dial_prefix = 0, |
# dial_prefix = 0, |
238 |
|
|
239 |
# Parameter: phone |
# Parameter: phone |
240 |
# Type: string |
# Type: string |
241 |
# Description: set the primary phone number to use. |
# Description: sets the primary phone number to use. |
242 |
# No default |
# No default |
243 |
# |
# |
244 |
# This is the first phone number penggy will try to connect to. |
# This is the first phone number penggy will try to connect to. |
249 |
|
|
250 |
# Parameter: phone[1-5] |
# Parameter: phone[1-5] |
251 |
# Type: string |
# Type: string |
252 |
# Description: set the alternatives phone numbers to use. |
# Description: sets the alternative phone numbers to use. |
253 |
# No default |
# No default |
254 |
# |
# |
255 |
# phone1 = |
# phone1 = |
260 |
|
|
261 |
# Parameter: line_speed |
# Parameter: line_speed |
262 |
# Type: integer |
# Type: integer |
263 |
# Description: set the alternatives phone numbers to use. |
# Description: Sets the speed of your serial port. |
264 |
# Default: 115200 |
# Default: 115200 |
265 |
# |
# |
266 |
# This is the speed of your serial device (do not confuse with the |
# This is the speed of your serial device (do not confuse it with the |
267 |
# speed of the connection). The default is probably good if you have |
# speed of the connection). The default is probably good if you have |
268 |
# a recent computer. |
# a recent computer. |
269 |
# |
# |
271 |
|
|
272 |
# Parameter: chat_script |
# Parameter: chat_script |
273 |
# Type: path |
# Type: path |
274 |
# Description: set the alternatives phone numbers to use. |
# Description: Sets the script to use to reach AOL's network. |
275 |
# Default: /etc/penggy/chat/aolnet.scm |
# Default: /etc/penggy/chat/aolnet.scm |
276 |
# |
# |
277 |
# This scheme script will be executed to reach AOL network. |
# This scheme script will be executed to reach the AOL network. |
278 |
# AOL have different network, so there is different script, but most |
# AOL has different networks, so there are several scripts, but most |
279 |
# of them are AOLNet network, so default is probably good. |
# of them are AOLNet network, so default is probably good. |
280 |
# Note also others script haven't been tested yet. |
# NB : besides, the other scripts haven't been tested yet. |
281 |
# |
# |
282 |
# chat_script = /etc/penggy/chat/aolnet.scm |
# chat_script = /etc/penggy/chat/aolnet.scm |
283 |
|
|
288 |
# it as dead. |
# it as dead. |
289 |
# Default: 3 |
# Default: 3 |
290 |
# |
# |
291 |
# This parameter describe how much times, will penggy dial the same phone number |
# This parameter describes how many times penggy will dial the same phone number |
292 |
# without considering this phone number as dead. |
# before considering it as dead. |
293 |
# Note if autoreconnection is enabled, penggy will retry again but after the |
# NB : if autoreconnection is enabled, penggy will try again, after having |
294 |
# reconnect_delay parameter. |
# waited for the reconnect_delay. |
295 |
# |
# |
296 |
# dial_retry = 3 |
# dial_retry = 3 |
297 |
|
|
298 |
# Parameter: retry_delay |
# Parameter: retry_delay |
299 |
# Type: integer |
# Type: integer |
300 |
# Description: The number of seconds to wait after an unsuccessful dialin. |
# Description: The number of seconds to wait after an unsuccessful dialing. |
301 |
# Default: 0 |
# Default: 0 |
302 |
# |
# |
303 |
# In case of a failed dialin, penggy will wait this amount of times (in seconds) |
# In case of a failed dialing, penggy will wait this amount of times (in seconds) |
304 |
# before retrying the phone number. |
# before retrying the phone number. |
305 |
# |
# |
306 |
# retry_delay = 3 |
# retry_delay = 3 |
307 |
|
|
308 |
|
|
309 |
|
|
310 |
# TCP/IP OPTIONS, useful if you use the tcpip, dsl or cable media |
# TCP/IP OPTIONS, useful if you use tcpip, dsl or cable |
311 |
#--------------------------------------------------------------------- |
#--------------------------------------------------------------------- |
312 |
|
|
313 |
# Parameter: aol_host |
# Parameter: aol_host |
314 |
# Type: string |
# Type: string |
315 |
# Description: Set the host to contact for a TCP/IP connection. |
# Description: Sets the host to contact for a TCP/IP connection. |
316 |
# Default: AmericaOnline.aol.com |
# Default: AmericaOnline.aol.com |
317 |
# |
# |
318 |
# Since I don't know any other AOL TCP/IP door, the default is probably |
# Since I don't know any other AOL TCP/IP door, the default is probably |
322 |
|
|
323 |
# Parameter: aol_port |
# Parameter: aol_port |
324 |
# Type: integer |
# Type: integer |
325 |
# Description: Set the port used to contact host for a TCP/IP connection. |
# Description: Sets the port used to contact host for a TCP/IP connection. |
326 |
# Default: 5190 |
# Default: 5190 |
327 |
# |
# |
328 |
# Port from 5190 to 5193 should work, but I don't see a reason for changing the default. |
# Again, you should not change this parameter... |
329 |
# |
# |
330 |
# aol_port = 5190 |
# aol_port = 5190 |