File: help.c

package info (click to toggle)
xisp 2.5p4-1
  • links: PTS
  • area: contrib
  • in suites: slink
  • size: 1,328 kB
  • ctags: 1,908
  • sloc: ansic: 16,648; asm: 214; sh: 210; makefile: 202; perl: 55
file content (324 lines) | stat: -rw-r--r-- 20,325 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324

#define MAXNUM_HELPLINES 318

static char *helpText[MAXNUM_HELPLINES] = {
" ",
"@t@b@l  User Interface General Information.",
" ",
"  When started, xisp displays a form with four buttons, three menus and",
"  a drop-choice list. Normally, in order to commence dialing, an ISP must",
"  be selected. The one selected by default right after startup is the",
"  first entry in the list of ISP's, or the one set as \"Default ISP\" from",
"  within the \"Account Information\" form. All defined ISP's appear in the",
"  drop list, for quick selection. The \"Quit\" button is always activated.",
"  The other button activated at this time is the \"Connect\" button. After",
"  a connection is initiated, and up until a PPP link is established,",
"  \"Connect\" is deactivated while \"Interrupt\" is activated. After a link",
"  is established, \"Interrupt\" is deactivated and \"Disconnect\" is",
"  activated. The \"Help\" menu selection is self explanatory, I guess :).",
"  The \"Options\" menu contains five items, \"Account Information\", \"Dialing",
"  and Login\", \"Communication Options\", \"TCP/IP Options\" and \"Paths Setup\".",
" ",
"@b  \"Account Information\"",
"     Brings up a list of ISP accounts to choose from, allowing editing",
"     of their properties. It also contains five input fields, one set",
"     of check buttons, one set of radio buttons, and four push buttons.",
"     The first time xisp is executed all ISP names will be blank. One can",
"     add an ISP entry by pressing the \"Add\" button. You can also create",
"     new entries by selecting existing entries, copying them by pressing",
"     the \"Copy\" button, and pasting them by pressing the \"Paste\" button.",
"     When adding or pasting entries, the new entry is always appended to",
"     the existing list of ISPs. Edit the ISP name by double-clicking on",
"     an entry in the list. The selected ISP can be set as the default",
"     selection upon xisp startup, by enabling the \"Default ISP\" check-",
"     button. If you want xisp to dial this ISP entry automatically after",
"     it starts up, enable the \"Auto-dial upon startup\" check-button. If",
"     you desire automatic re-dialing of dropped PPP connections to the",
"     selected ISP, enable the \"Re-dial dropped links\" check-button. Note",
"     that, contrary to the default ISP selection, auto-dialing and re-",
"     dialing of dropped links are per-ISP attributes. The first of five",
"     input fields contains the list of phone numbers to dial for the",
"     selected ISP, the second is the user account name to use, and the",
"     third is the password. The radio buttons enable use of password",
"     authentication via PAP, PAP using pap-secrets (PAP-Secrets) and CHAP",
"     using chap-secrets (CHAP-Secrets). Note that simple PAP (without",
"     using the pap-secrets file) is supported via the +ua pppd version",
"     2.2 option. Since this option has been removed from pppd in version",
"     2.3, this selection will be marked as unavailable when using xisp",
"     with pppd version 2.3 or later. The fourth input field contains the",
"     argument to the 'user' or 'name' argument to pppd, and the fifth",
"     contains the argument to the 'remotename' pppd argument. Note here",
"     that when any one of three available authentication methods is",
"     selected, any user script lines entered via the \"Dialing and Login\"",
"     menu, are ignored. In the phone number input field, more than one",
"     telephone numbers, and up to a total of 8 can be entered by",
"     separating them with the semicolon (';') character. The total length",
"     of each phone number is currently limited to 32 characters. A brief",
"     note on password security is in order here. The plaintext password",
"     entered in the \"Password\" input field is encoded using encrypt(3)",
"     with a key saved in the xisp executable. This key is itself",
"     scrambled so that it is not visible in the xisp binary. Since any",
"     one having access to the source can eventually come up with the key",
"     used, and potentially decode users' .xisprc entries yielding the",
"     plaintext ISP passwords, system administrators installing xisp are",
"     urged to change the key employed. For more details, read the",
"     SECURITY file included with the xisp distribution.",
" ",
"@b  \"Dialing and Login\"",
"     Brings up a window with fields for entering the three dialing",
"     parameters, namely the number of dialing tries, the inter-dialing",
"     delay and the maximum time to wait for modem connection, as well",
"     as up to eight user customizable script lines. It also enables the",
"     launching of a manual login window after a connection is established,",
"     the size of which can be specified via the \"Terminal columns:\" and",
"     \"rows:\" input fields, or enables ISP server call-back and editing of",
"     up to eight user customizable call-back script lines. All numeric",
"     input fields are pretty straight forward; the default values should",
"     be adequate for most cases. The sub-form for editing the call-back",
"     script is activated by pressing the \"Options\" button. This form also",
"     includes a field for entering the time to wait for the call-back",
"     connection.  The script section, both for dial-in and call-back, is",
"     divided into \"Expect:\" and \"Send:\" sections, as used by the call to",
"     the chat(8) command. Here the user must enter the script lines used",
"     by chat to successfully negotiate a login for the particular ISP.",
"     Dial-in and call-back lines are not used when manual login or",
"     authenticated (PAP/PAP-Secrets/CHAP-Secrets) login is selected.",
"     However, it is possible to use call-back with authenticated login.",
"     For detailed script-line syntax and various examples please read the",
"     chat(8) manual page. The following simple example should give you an",
"     idea. Let us assume that the ISP of interest employs a terminal server",
"     which prompts the user with 'Username:', then with 'password:' and",
"     then gives the server prompt, a single '>', at which point the user",
"     must type 'ppp' and press enter. The user customizable expect-send",
"     pairs for the above procedure would be:",
" ",
"         Expect:		Send:",
" ",
"         ername:--ername:	%U",
"         ssword:		%P",
"         >-->		ppp",
" ",
"     Note the special \"%U\" and \"%P\" variables in the script lines. \"%U\"",
"     is (quite obviously) replaced by your user account name (by the",
"     xisp program when it creates the dialing environment file), and \"%P\"",
"     by your password. A maximum of one \"%U\" and one \"%P\" can exist in",
"     either section (expect or send) of each script line. Entering more",
"     will make xisp print a message and abort the dial. The script employed",
"     by xispdial for the connection is the concatenation of its internal",
"     script, and the user customizable script lines entered via",
"     \"Dialing Data\". The internal script used is the following:",
" ",
"         TIMEOUT		3",
"         ABORT		BUSY",
"         ABORT		'NO CARRIER'",
"         ABORT		'NO DIALTONE'",
"         ABORT		enied",
"         ABORT		imeout",
"         ''			'AT <dial extras>D<dial method> <phone number>'",
"         TIMEOUT		<maximum wait for connection>",
"         <connect str>	\\c ",
"         TIMEOUT		5",
"         \\r			\\c",
" ",
"     The \"connect str\" is the string returned by your modem ypon connection",
"     (it's \"CONNECT\" for a US Robotics Sportster, but it might be the word",
"     \"CARRIER\" for your modem; please consult with your modem's user manual).",
"     As seen above, the timeout value after connection is set to 5 seconds.",
"     If for some reason it takes more than that to log into a system, one",
"     could specify a new timeout value in the user script lines. For",
"     instance, in the example given above , if it takes 6 seconds for a",
"     prompt from the terminal server in question, the user customizable",
"     expect-send pairs could be:",
" ",
"         Expect:		Send:",
" ",
"         ername:--ername:	%U",
"         ssword:		%P",
"         TIMEOUT		10",
"         >-->		ppp",
" ",
"     allowing 10 (6 + an extra 4) seconds for receiving the '>' character.",
"     All special escape characters supported by chat(8) (e.g. \\n, \\r etc.)",
"     can be entered in either the the \"expect\" or the \"send\" portion of a",
"     script line. In xisp versions prior to 2.5p3, any such special characters",
"     would have to be escaped by preceding them with an extra '\\'. This",
"     is no longer needed as all characters beginning with '\\' are now",
"     automatically escaped by xispdial. Note that since version 1.9 of",
"     xisp, when the script lines were divided into \"Expect:\" and \"Send:\"",
"     sections, you no longer need to enclose commands including spaces",
"     with single quotes. As an example, if at the end of the login session",
"     you start PPP using the command \"ppp /compress\", in versions prior",
"     to 1.9 you would need to enclose the command in single quotes and",
"     enter your script line as \">--> 'ppp /compress'\" in the above",
"     example. For versions 1.9 and later this is not necessary, as",
"     expect-send pairs are automatically quoted before being passed on",
"     to chat.  If call-back is selected, the following script is appended",
"     to the concatenation of user customizable script lines and modified",
"     internal script:",
" ",
"         TIMEOUT		<delay for call-back connection>",
"         <connect str>	\\c",
"         TIMEOUT		5",
"         \\r			\\c",
" ",
"     And following that, the user call-back script lines are appended to it.",
"     This instructs chat to wait the user-specified delay time for a second",
"     connect from the server as it dials back, and then to use the login",
"     procedure described in the call-back script. The dial-in internal",
"     script is modified by deleting the",
" ",
"         ABORT		'NO CARRIER'",
" ",
"     expect-send pair, since the carrier drops when the remote side hangs-up",
"     prior to calling back.",
" ",
"@b  \"Communication Options\"",
"     Brings up a window with eight input fields and five sets of radio",
"     buttons. The \"Device\" input field is for selecting the special",
"     device file referring to the modem port, /dev/modem being the",
"     default. The input field named \"Reset\" contains the modem reset",
"     string, the field named \"Init\" enables customization of the modem",
"     initialization string (before dialing), and the \"Connect String\"",
"     field allows modification of the string by which the modem employed",
"     reports the connection speed. The default reset string is \"ATZ\"",
"     which should work with most modems. The default initialization",
"     string is a simple \"AT\" command, to which you could add, e.g. when",
"     using a USR modem, an \"M0\" to disable the speaker during modem",
"     operation. Note that xispdial appends an \"H0\" to the user defined",
"     initialization string. The string used for modem connection speed",
"     reporting is by default assumed to be \"CONNECT\". The sets of radio",
"     buttons enable selection of modem port (i.e. DCE<->DTE interface)",
"     speed, port flow control used (hardware or software), dialing mode",
"     (tone or pulse) and BSD software compression. The \"Dialing extras\"",
"     input field allows defining extra command characters (up to 8 in",
"     total) to be inserted between \"AT\" and \"D\" when dialing. The \"Level\"",
"     input field is the transmit and receive compression level as",
"     explained in the pppd(8) manual page, having a default value of 12.",
"     Note, however, that the PPP employed has to have BSD compression",
"     support for this option to have any effect; for Linux this happens",
"     only if you build PPP support as a kernel module. The last two input",
"     fields enable selection of the asyncmap and escape options provided",
"     by pppd; see the pppd(8) manual page for details on their function.",
"     The vast majority of dialup setups won't need the escape parameter,",
"     and that is the reason why it is off by default. The value of",
"     asyncmap, on the other hand, is automatically adjusted by your",
"     selection of flow control, i.e. whenever you change flow control",
"     type, the default value for asyncmap is inserted in the input field.",
"     Although the two default values should be adequate for general use,",
"     you can modify them further, to suit your needs.",
" ",
"@b  \"TCP/IP Options\"",
"     Brings up a window with seven input fields and four sets of radio",
"     buttons. With the exception of the primary and secondary DNS server",
"     entries, all remaining fields in this form are options which should",
"     only be changed if you understand their function; the default values",
"     are what you would need for your typical ISP connection. Please",
"     refer to the pppd(8) manual page for reading details on the function",
"     of these parameters, when you need to change their values. The last",
"     set of radio buttons enables DNS support via the ip-up and ip-down",
"     scripts, allowing  the user to enter IP addresses for a primary and",
"     (possibly) a secondary DNS server. The ip-up and ip-down scripts",
"     normally reside in /etc/ppp, and are automatically invoked by pppd",
"     when the link is set-up and torn-down respectively. Enabling this",
"     option will instruct xisp to do two things. Firstly, to call pppd",
"     with the extra option 'ipparam', passing a string as a sixth",
"     argument to ip-up and ip-down; this string contains the name of the",
"     pipe node from which xisp reads xispdial output, the description",
"     string entered via the \"Account Information\" form, and the primary",
"     (and possibly secondary) DNS server IP addresses entered via the",
"     corresponding input fields. Secondly, to read extra input from the",
"     named pipe node, after xispdial terminates, effectively writing any",
"     output from ip-up and ip-down to the xisp browser. The ip-up and",
"     ip-down scripts provided with xisp, must be installed in /etc/ppp",
"     for the xisp DNS settings to have any effect. Both ip-up and",
"     ip-down include user customizable sections for performing tasks",
"     like, for example, downloading mail or news, on a per ISP basis.",
" ",
"@b  \"Paths Setup\"",
"     Enables editing the paths to a) the pppd daemon, b) the location",
"     where pppd saves its process ID files, c) the chat utility, d) the",
"     xispdial and xispterm utilities and e) the location where xisp shall",
"     keep the named pipe node used for communicating with its components.",
"     All five paths are entered in corresponding input fields. For the",
"     first four, the \"Default\" button restores the path to its built-in",
"     default value specified during compilation. The \"Status:\" field",
"     beside each one of the first four entries will contain \"OK\" if the",
"     program binaries are indeed found in the specified path, or \"Error\"",
"     otherwise. IMPORTANT NOTE: the last path, i.e. the path to the",
"     named-pipe node, should NOT be on an NFS mounted filesystem.",
" ",
"  The \"Logging\" menu contains two items, \"Logging Options\" and",
"  \"Statistics\".",
" ",
"@b  \"Logging Options\"",
"     Brings up a window with  two sets of radio buttons, two drop",
"     choice lists, three buttons for phone company (PTT) manipulation,",
"     and an information display browser. The radio button set for the",
"     \"OnLine Counter\", enables selection of either \"time in seconds\"",
"     or \"call charge\" in local currency, as display option on the main",
"     program window. The other set of radio buttons enables selection of",
"     the logging period, affecting the file names of log files in the",
"     xisp logging directory $HOME/.xisplogs. Unless \"None\" is selected,",
"     two logging files are kept. One keeps track of the total time (in",
"     seconds) spent online as well as the total number of units charged",
"     (in the case when the chosen phone company charging method is \"per",
"     minute\" rather than \"in units\", this number is the total cost",
"     instead). The other log file keeps ISP connection logs for the",
"     desired logging period. The first file has the base name \"xispcost\"",
"     and suffixes of \".W<week number>\", \".<abbr. month>\" or",
"     \".B<month-pair number>\", depending on whether \"Weekly\", \"Monthly\"",
"     or \"Bimonthly\" logging is selected. The second log file has base",
"     name \"xisplog\" and the same suffix as the first one. As an",
"     example, for date \"Fri Sep 26 17:08:39 EET DST 1997\", the suffixes",
"     would be \".W39\", \".Sep\" or \".B5\" corresponding to \"Weekly\",",
"     \"Monthly\" or \"Bimonthly\" logging periods. Whenever the phone",
"     company and/or the logging period is changed, the old log file",
"     is renamed to <the old name>.bak, and a new one is created.",
"     The two drop choice lists are for selecting one of the supported",
"     phone companies and the charging zone from the zones defined for",
"     that company. The \"Edit PTT\" button brings up the PTT editor form",
"     for the selected PTT. This editor has its own help text, describing",
"     the usage of all supported PTT information fields, and explaining",
"     how user information is employed by the PTT tarrif calculations.",
"     The \"Add PTT\" button creates a new phone company entry in file",
"     $HOME/.xisplogs/xispPTTs, prompting the user for the new PTT name,",
"     and then starting the PTT editor. The \"Remove PTT\" button removes",
"     the PTT entry currently selected. The information browser displays",
"     charging method and costs for all zones and time-of-day categories",
"     defined for the currently selected PTT. These categories are simply",
"     different charging tariffs used by the phone company for different",
"     times of day and night.",
" ",
"@b  \"Statistics\"",
"     Displays time/cost information collected in the xispcost.* files,",
"     according to the logging period selected. It displays the number of",
"     online seconds and total cost for each period on a text browser,",
"     and also makes a bar chart of costs for each corresponding period.",
"     The chart uses yellow color for the periods prior to the current",
"     one, white for the current period and dark cyan for the remaining",
"     periods up to the end of the current year. These remaining periods",
"     are assumed to belong to cost information collected during the",
"     previous year. For this reason, two different total time and cost",
"     values are calculated and displayed on the text browser, one for",
"     the periods up to and including the current one, and one for the",
"     remaining periods to the end of the year. Note that this menu",
"     option is active only if connection logs have been enabled from",
"     \"Logging Options\".",
" ",
"  The main window includes one status and three connection indicators.",
"  The status indicator appears below the program icon, indicating the",
"  current interface state. There are three distinct states: \"OFF-LINE\"",
"  for \"disconnected\", \"XISPDIAL\" indicating that dialing is in progress",
"  and \"ON-LINE\". The \"Assigned IP Address:\" indicator prints the IP",
"  address assigned to your PPP interface after successfully establishing",
"  a link. The \"Modem Speed:\" indicator prints the speed as returned by the",
"  modem connection-speed string, and the \"Time On-Line\"/\"Call Charges\"",
"  indicator measures your connection time or charges with a resolution",
"  of five seconds. The measured time (or sum of charges) will remain",
"  there after disconnection, until a new dialing sequence is initiated.",
"  The IP address can be selected for later pasting in some other window",
"  by clicking the left mouse button on the IP readout. Clicking again",
"  deselects it.",
" "
};