HEAD: remove ridiculous dependency of wvmapi (actually wvtnef) on evolution
[wvapps.git] / wvdial / wvdial.1
blobddb0ac8363a11a2eb6d58705b13317a3887e9e39
1 .TH WVDIAL 1 "May 2001" "Worldvisions WvDial"
3 .SH NAME
4 wvdial \- PPP dialer with built-in intelligence.
6 .SH SYNOPSIS
7 .B wvdial
8 .I "--help | --version | --chat | --config | option=value | --no-syslog | section..."
10 .SH DESCRIPTION
11 .B wvdial
12 is an intelligent PPP dialer, which means that it dials a modem and
13 starts PPP in order to connect to the Internet.  It is something like the
14 .BR chat (8)
15 program, except that it uses heuristics to guess how to dial and log
16 into your server rather than forcing you to write a login script.
17 .PP
18 When
19 .B wvdial
20 starts, it first loads its configuration from
21 .IR /etc/wvdial.conf
22 and
23 .IR ~/.wvdialrc
24 which contains basic information about the modem port, speed, and init
25 string, along with information about your Internet Service Provider (ISP),
26 such as the phone number, your username, and your password.
27 .PP
28 Then it initializes your modem and dials the server and waits for a 
29 connection (a CONNECT string from the modem).  It understands and responds 
30 to typical connection problems (like BUSY and NO DIALTONE).
31 .PP
32 Any time after connecting, 
33 .B wvdial
34 will start PPP if it sees a PPP sequence from the server.  Otherwise,
35 it tries to convince the server to start PPP by doing the following:
36 .PP
37 .HP
38 \ - responding to any login/password prompts it sees;
39 .br
40 .HP
41 \ - interpreting "choose one of the following"-style menus;
42 .br
43 .HP
44 \ - eventually, sending the word "ppp" (a common terminal server command).
45 .PP
46 If all of this fails,
47 .B wvdial
48 just runs
49 .BR pppd (8)
50 and hopes for the best. It will bring up the connection, and then wait
51 patiently for you to drop the link by pressin CTRL-C.
53 .SH OPTIONS
54 Several options are recognized by
55 .BR wvdial .
56 .TP
57 .I "\-\-chat"
58 Run wvdial as a chat replacement from within pppd, instead of the more
59 normal method of having wvdial negotiate the connection and then call
60 pppd.
61 .TP
62 .I "\-\-config \fR[\|\fIconfigfile\fR\|]
63 Run wvdial with configfile as the configuration file (instead of
64 /etc/wvdial.conf). This is mainly usefull only if you want to have per-user
65 configurations, or you want to avoid having dial-up information (usernames,
66 passwords, calling card numbers, etc.) in a system wide configuration file.
67 .TP
68 .I "\-\-no-syslog"
69 Don't output debug information to the syslog daemon (only useful together
70 with --chat).
71 .TP
72 .I "\-\-help"
73 Prints a short message describing how to use
74 .B wvdial
75 and exits.
76 .TP
77 .I "\-\-version"
78 Displays
79 .BR wvdial 's
80 version number and exits.
81 .PP
82 .B wvdial
83 is normally run without command line options, in which case it reads
84 its configuration from the
85 .I "[Dialer Defaults]"
86 section of
87 .IR /etc/wvdial.conf .
88 (The configuration file is described in more detail in wvdial.conf(5)
89 manual page.)
90 .PP
91 One or more sections of
93 /etc/wvdial.conf
94 may be specified on the command line.  Settings in these sections will
95 override settings in
96 .IR "[Dialer Defaults]" .
97 .TP
98 For example, the command:
99 .B wvdial phone2
101 will read default options from the
102 .I "[Dialer Defaults]"
103 section, then override any or all of the options with those found in the
104 .I "[Dialer phone2]"
105 section.
107 If more than one section is specified, they are processed in the order they
108 are given.  Each section will override all the sections that came before it.
110 For example, the command:
111 .B wvdial phone2 pulse shh
113 will read default options from the
114 .I "[Dialer Defaults]"
115 section, then override any or all of the options with those found in the
116 .I "[Dialer phone2]"
117 section, followed by the
118 .I "[Dialer pulse]"
119 section, and lastly the
120 .I "[Dialer shh]"
121 section.
123 Using this method, it is possible to easily configure
124 .B wvdial
125 to switch between different internet providers, modem init strings,
126 account names, and so on without specifying the same configuration
127 information over and over.
129 .SH BUGS
130 "Intelligent" programs are frustrating when they don't work right.
131 This version of
132 .B wvdial
133 has only minimal support for disabling or overriding its "intelligence",
134 with the "Stupid Mode", "Login Prompt", and "Password Prompt" options.
135 So, in general if you have a nice ISP, it will probably work,
136 and if you have a weird ISP, it might not.
138 Still, it's not much good if it doesn't work for you, right?  Don't be fooled
139 by the fact that
140 .B wvdial
141 finally made it to version 1.00; it could well contain many bugs and 
142 misfeatures.  Let us know if you have problems by sending e-mail to
143 .BR <wvdial@nit.ca> .
145 Also, there is now a mailing list for discussion about
146 .BR wvdial .
147 If you are having problems, or have anything else to say, send e-mail to
148 .BR <wvdial-list@lists.nit.ca> .
150 You may encounter some error messages if you don't have write access to
151 .B /etc/ppp/pap-secrets
153 .BR /etc/ppp/chap-secrets .
154 Unfortunately, there's really no nice way around this yet.
155 .SH FILES
157 /etc/wvdial.conf
158 Configuration file which contains modem, dialing, and login
159 information. See 
160 .Bwvdial.conf(5).
162 /dev/ttyS*
163 Serial port devices.
165 /etc/ppp/peers/wvdial
166 Required for correct authentication in pppd version 2.3.0 or newer.
168 /etc/ppp/{pap,chap}-secrets
169 Contains a list of usernames and passwords used by pppd for authentication.
170 .B wvdial
171 maintains this list automatically.
173 .SH AUTHORS
174 Dave Coombs and Avery Pennarun for Net Integration Technologies, as
175 part of the Worldvisions Weaver project. We would like to thank SuSE and
176 RedHat for adding a number of various cool features to
177 .Bwvdial.
178 Thanks guys!
180 .SH SEE ALSO
181 .BR wvdial.conf (5),
182 .BR wvdialconf (1),
183 .BR pppd (8),
184 .BR chat (8).
186 .B FAQ: 
187 .BR http://www.dsb3.com/wvdial/