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 are. If you don't need to change a |
## various options are. If you don't need to change a |
11 |
# default option, you needn't uncomment the line. |
## default option, you needn't uncomment the line. |
12 |
# |
## |
13 |
# Most of these paramaters can be overidden from 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 |
17 |
#--------------------------------------------------------------------- |
## -------------------------------------------------------------------- |
18 |
|
|
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: sets the type of device used for connecting |
## Description: sets the type of device used for connecting |
23 |
# Default: modem |
## Default: modem |
24 |
# |
## |
25 |
# Cable and DSL are not really implemented yet. |
## Cable and DSL are not really implemented yet. |
26 |
# If you have that kind of connection device, you should use tcpip instead. |
## If you have that kind of connection device, you should use tcpip instead. |
27 |
# |
## |
28 |
# access_method = modem |
# access_method = tcpip |
29 |
|
|
30 |
# Parameter: protocol |
## Parameter: protocol |
31 |
# Type: string |
## Type: string |
32 |
# Possible values: p3, l2tp |
## Possible values: p3, l2tp |
33 |
# Description: Sets the protocol used for communicating |
## 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 |
# its support isn't implemented yet. Don't change it. |
## 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: sets the interface type. |
## Description: sets the interface type. |
45 |
# Default: tun |
## Default: tun |
46 |
# |
## |
47 |
# Only tun is currently 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: sets the created interface's name. |
## 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 |
57 |
# choice. |
## choice. |
58 |
# |
## |
59 |
# interface_name = tun0 |
# interface_name = tun0 |
60 |
|
|
61 |
# Parameter: secret_file |
## Parameter: secret_file |
62 |
# Type: path |
## Type: path |
63 |
# Description: sets the file where your passwords 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. |
67 |
# |
## |
68 |
# secret_file = /etc/penggy/aol-secrets |
# secret_file = /etc/penggy/aol-secrets |
69 |
|
|
70 |
# Parameter: screen_name |
## Parameter: screen_name |
71 |
# Type: string |
## Type: string |
72 |
# Description: sets the screen-name to be used 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 |
# You really need to change this parameter or pass it at the command line |
## You really need to change this parameter or pass it at the command line |
77 |
# prompt, or penggy will complain about not having any screen name to |
## prompt, or penggy will complain about not having any screen name to |
78 |
# connect as. |
## connect as. |
79 |
# |
## |
80 |
# screen_name = frankeinstein |
# screen_name = frankeinstein |
81 |
|
|
82 |
# Parameter: auto_reconnect |
## Parameter: auto_reconnect |
83 |
# Type: boolean |
## Type: boolean |
84 |
# Description: enable autoreconnection. |
## Description: enable autoreconnection. |
85 |
# Default: false |
## Default: false |
86 |
# |
## |
87 |
# If you set this option to true, penggy will automatically reconnect |
## If you set this option to true, penggy will automatically reconnect |
88 |
# when it detects you were cut off. |
## when it detects you were cut off. |
89 |
# |
## |
90 |
# auto_reconnect = false |
# auto_reconnect = true |
91 |
|
|
92 |
# Parameter: reconnect_delay |
## Parameter: reconnect_delay |
93 |
# Type: integer |
## Type: integer |
94 |
# Description: sets the delay between reconnections. |
## Description: sets the delay between reconnections. |
95 |
# Default: 0 |
## Default: 5 |
96 |
# |
## |
97 |
# This option will have no effect if autoreconnection is disabled. |
## This option will have no effect if autoreconnection is disabled. |
98 |
# If set it 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 = 30 |
102 |
|
|
103 |
# Parameter: daemon |
## Parameter: daemon |
104 |
# Type: boolean |
## Type: boolean |
105 |
# Description: enables daemon mode, runs penggy in the 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 work 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 it with 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 = true |
114 |
|
|
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: sets 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 to developers. |
## This option is probably only useful to developers. |
122 |
# |
## |
123 |
# debug_level = 0 |
# debug_level = 5 |
124 |
|
|
125 |
# Parameter: set_dns |
## Parameter: set_dns |
126 |
# Type: boolean |
## Type: boolean |
127 |
# Description: set the 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 gives. |
## information) according to what the server gives. |
132 |
# If you don't want this behavior (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 = false |
136 |
|
|
137 |
# Parameter: pid_file |
## Parameter: pid_file |
138 |
# Type: path |
## Type: path |
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 stores its current PID. |
## This is the file where penggy stores its current PID. |
143 |
# Keeping the default is 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 automatically 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 tunneling is started. |
## 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 |
# 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 very 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 |
|
|
159 |
# Parameter: ip_down_script |
## Parameter: ip_down_script |
160 |
# Type: path |
## Type: path |
161 |
# Description: set the script automaticly called when IP is down. |
## Description: set the script automaticly called when IP is down. |
162 |
# Default: /etc/penggy/ip-down |
## Default: /etc/penggy/ip-down |
163 |
# |
## |
164 |
# As ip-up but when the connection ends. |
## As ip-up but when the connection ends. |
165 |
# |
## |
166 |
# ip_down_script = /etc/penggy/ip-down |
# ip_down_script = /etc/penggy/ip-down |
167 |
|
|
168 |
|
|
169 |
|
|
170 |
# MODEM OPTIONS, only useful if you are using a modem to connect |
## 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: sets 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 your modem is attached to. Otherwise change this parameter. |
## device your modem is attached to. Otherwise change this parameter. |
180 |
# |
## |
181 |
# modem_device = /dev/modem |
# modem_device = /dev/ttyS0 |
182 |
|
|
183 |
# Parameter: rtscts |
## Parameter: rtscts |
184 |
# Type: boolean |
## Type: boolean |
185 |
# Description: enable hardware flow control. |
## Description: enable hardware flow control. |
186 |
# Default: true |
## Default: true |
187 |
# |
## |
188 |
# Nearly all modems support hardware flow control, so you don't want to change |
## Nearly all modems support hardware flow control, so you don't want to change |
189 |
# this parameter, unless you really have a good reason. |
## this parameter, unless you really have a good reason. |
190 |
# |
## |
191 |
# rtscts = true |
# rtscts = false |
192 |
|
|
193 |
# Parameter: initstr1 |
## Parameter: initstr1 |
194 |
# Type: string |
## Type: string |
195 |
# Description: sets 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 |
199 |
# is probably a good idea, you can complete with other string if you need. |
## is probably a good idea, you can complete with other string if you need. |
200 |
# |
## This command mustn't be longer than 58 bytes. |
201 |
|
## |
202 |
# initstr1 = ATZ |
# initstr1 = ATZ |
203 |
|
|
204 |
# Parameter: initstr[2-9] |
## Parameter: initstr[2-9] |
205 |
# Type: string |
## Type: string |
206 |
# Description: sets other initialization strings. |
## Description: sets other initialization strings. |
207 |
# No default |
## No default |
208 |
# |
## |
209 |
# Other Hayes commands to init the modem. |
## Other Hayes commands to init the modem. |
210 |
# |
## |
211 |
# initstr2 = |
# initstr2 = AT&F3 |
212 |
# initstr3 = |
# initstr3 = AT&E1234 |
213 |
# initstr4 = |
# initstr4 = |
214 |
# initstr5 = |
# initstr5 = |
215 |
# initstr6 = |
# initstr6 = |
217 |
# initstr8 = |
# initstr8 = |
218 |
# initstr9 = |
# initstr9 = |
219 |
|
|
220 |
# Parameter: dialstr |
## Parameter: dialstr |
221 |
# Type: string |
## Type: string |
222 |
# Description: sets the string used to dial. |
## Description: sets the string used to dial. |
223 |
# Default: ATDT |
## Default: ATDT |
224 |
# |
## |
225 |
# 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. |
226 |
# |
## |
227 |
# dialstr = ATDT |
# dialstr = ATDT |
228 |
|
|
229 |
# Parameter: dial_prefix |
## Parameter: dial_prefix |
230 |
# Type: string |
## Type: string |
231 |
# Description: sets a prefix to dial before the number to get a dial tone. |
## Description: sets a prefix to dial before the number to get a dial tone. |
232 |
# No default |
## No default |
233 |
# |
## |
234 |
# You may need a prefix to get an external line. This parameter |
## You may need a prefix to get an external line. This parameter |
235 |
# will be used for this. |
## will be used for this. |
236 |
# Do not forget to add a colon if you need a pause (which is likely) |
## Do not forget to add a colon if you need a pause (which is likely) |
237 |
# |
## |
238 |
# dial_prefix = 0, |
# dial_prefix = 0, |
239 |
|
|
240 |
# Parameter: phone |
## Parameter: phone |
241 |
# Type: string |
## Type: string |
242 |
# Description: sets the primary phone number to use. |
## Description: sets the primary phone number to use. |
243 |
# No default |
## No default |
244 |
# |
## |
245 |
# This is the first phone number penggy will try to connect to. |
## This is the first phone number penggy will try to connect to. |
246 |
# You can complete with more, in case this one fails, with parameters |
## You can complete with more, in case this one fails, with parameters |
247 |
# phone[1-5]. |
## phone[1-5]. |
248 |
# |
## |
249 |
# phone = |
# phone = |
250 |
|
|
251 |
# Parameter: phone[1-5] |
## Parameter: phone[1-5] |
252 |
# Type: string |
## Type: string |
253 |
# Description: sets the alternative phone numbers to use. |
## Description: sets the alternative phone numbers to use. |
254 |
# No default |
## No default |
255 |
# |
## |
256 |
# phone1 = |
# phone1 = |
257 |
# phone2 = |
# phone2 = |
258 |
# phone3 = |
# phone3 = |
259 |
# phone4 = |
# phone4 = |
260 |
# phone5 = |
# phone5 = |
261 |
|
|
262 |
# Parameter: line_speed |
## Parameter: line_speed |
263 |
# Type: integer |
## Type: integer |
264 |
# Description: Sets the speed of your serial port. |
## Description: Sets the speed of your serial port. |
265 |
# Default: 115200 |
## Default: 115200 |
266 |
# |
## |
267 |
# This is the speed of your serial device (do not confuse it with the |
## This is the speed of your serial device (do not confuse it with the |
268 |
# speed of the connection). The default is probably good if you have |
## speed of the connection). The default is probably good if you have |
269 |
# a recent computer. |
## a recent computer. |
270 |
# |
## |
271 |
# line_speed = 115200 |
# line_speed = 57600 |
272 |
|
|
273 |
# Parameter: chat_script |
## Parameter: chat_script |
274 |
# Type: path |
## Type: path |
275 |
# Description: Sets the script to use to reach AOL's network. |
## Description: Sets the script to use to reach AOL's network. |
276 |
# Default: /etc/penggy/chat/aolnet.scm |
## Default: /etc/penggy/chat/aolnet.scm |
277 |
# |
## |
278 |
# This scheme script will be executed to reach the AOL network. |
## This scheme script will be executed to reach the AOL network. |
279 |
# AOL has different networks, so there are several scripts, but most |
## AOL has different networks, so there are several scripts, but most |
280 |
# of them are AOLNet network, so default is probably good. |
## of them are AOLNet network, so default is probably good. |
281 |
# NB : besides, the other scripts haven't been tested yet. |
## NB : besides, the other scripts haven't been tested yet. |
282 |
# |
## |
283 |
# chat_script = /etc/penggy/chat/aolnet.scm |
# chat_script = /etc/penggy/chat/csnet.scm |
284 |
|
|
285 |
|
|
286 |
# Parameter: dial_retry |
## Parameter: dial_retry |
287 |
# Type: integer |
## Type: integer |
288 |
# Description: The number of times to dial the same number before considering |
## Description: The number of times to dial the same number before considering |
289 |
# it as dead. |
## it as dead. |
290 |
# Default: 3 |
## Default: 3 |
291 |
# |
## |
292 |
# This parameter describes how many times penggy will dial the same phone number |
## This parameter describes how many times penggy will dial the same phone number |
293 |
# before considering it as dead. |
## before considering it as dead. |
294 |
# NB : if autoreconnection is enabled, penggy will try again, after having |
## NB : if autoreconnection is enabled, penggy will try again, after having |
295 |
# waited for the reconnect_delay. |
## waited for the reconnect_delay. |
296 |
# |
## |
297 |
# dial_retry = 3 |
# dial_retry = 1 |
298 |
|
|
299 |
# Parameter: retry_delay |
## Parameter: retry_delay |
300 |
# Type: integer |
## Type: integer |
301 |
# Description: The number of seconds to wait after an unsuccessful dialing. |
## Description: The number of seconds to wait after an unsuccessful dialing. |
302 |
# Default: 0 |
## Default: 0 |
303 |
# |
## |
304 |
# In case of a failed dialing, penggy will wait this amount of times (in seconds) |
## In case of a failed dialing, penggy will wait this amount of times (in seconds) |
305 |
# before retrying the phone number. |
## before retrying the phone number. |
306 |
# |
## |
307 |
# retry_delay = 3 |
# retry_delay = 3 |
308 |
|
|
309 |
|
|
310 |
|
|
311 |
# TCP/IP OPTIONS, useful if you use tcpip, dsl or cable |
## TCP/IP OPTIONS, useful if you use tcpip, dsl or cable |
312 |
#--------------------------------------------------------------------- |
## ------------------------------------------------------------------- |
313 |
|
|
314 |
# Parameter: aol_host |
## Parameter: aol_host |
315 |
# Type: string |
## Type: string |
316 |
# Description: Sets the host to contact for a TCP/IP connection. |
## Description: Sets the host to contact for a TCP/IP connection. |
317 |
# Default: AmericaOnline.aol.com |
## Default: AmericaOnline.aol.com |
318 |
# |
## |
319 |
# Since I don't know any other AOL TCP/IP door, the default is probably |
## Use cs.access.compuserve.com if your provider CompuServe |
320 |
# good. |
## |
321 |
# |
# aol_host = cs.access.compuserve.com |
322 |
# aol_host = AmericaOnline.aol.com |
|
323 |
|
## Parameter: aol_port |
324 |
# Parameter: aol_port |
## Type: integer |
325 |
# Type: integer |
## Description: Sets the port used to contact host for a TCP/IP connection. |
326 |
# Description: Sets the port used to contact host for a TCP/IP connection. |
## Default: 5190 |
327 |
# Default: 5190 |
## |
328 |
# |
## Default is for AOL, use 5191 for CompuServe. Nevetheless port from 5190 to |
329 |
# Again, you should not change this parameter... |
## 5192 should work |
330 |
# |
## |
331 |
# aol_port = 5190 |
# aol_port = 5191 |