vars.el.in 99.8 KB
Newer Older
David Byers's avatar
David Byers committed
1
;;;;; -*-coding: raw-text;mode: emacs-lisp;-*-
Linus Tolke's avatar
Linus Tolke committed
2
;;;;; $Id$
3
;;;;; Copyright (C) 1991-2002  Lysator Academic Computer Association.
Linus Tolke's avatar
Linus Tolke committed
4
;;;;;
5
;;;;; This file is part of the LysKOM Emacs LISP client.
Linus Tolke's avatar
Linus Tolke committed
6
7
8
;;;;; 
;;;;; LysKOM is free software; you can redistribute it and/or modify it
;;;;; under the terms of the GNU General Public License as published by 
9
;;;;; the Free Software Foundation; either version 2, or (at your option) 
Linus Tolke's avatar
Linus Tolke committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
;;;;; any later version.
;;;;; 
;;;;; LysKOM is distributed in the hope that it will be useful, but WITHOUT
;;;;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
;;;;; FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
;;;;; for more details.
;;;;; 
;;;;; You should have received a copy of the GNU General Public License
;;;;; along with LysKOM; see the file COPYING.  If not, write to
;;;;; Lysator, c/o ISY, Linkoping University, S-581 83 Linkoping, SWEDEN,
;;;;; or the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, 
;;;;; MA 02139, USA.
;;;;;
;;;;; Please mail bug reports to bug-lyskom@lysator.liu.se. 
;;;;;
Per Cederqvist's avatar
.  
Per Cederqvist committed
25
26
27
28
29
30
31
32
33
;;;; ================================================================
;;;; ================================================================
;;;;
;;;; File: vars.el
;;;;
;;;; This file contains almost all the variables used in lyskom.
;;;;


David Byers's avatar
X    
David Byers committed
34
35
36
(setq lyskom-clientversion-long 
      (concat lyskom-clientversion-long
	      "$Id$\n"))
37

David Byers's avatar
David Byers committed
38
(defvar lyskom-mule-compiled
39
40
  (eval-when-compile (and (fboundp 'multibyte-string-p)
                          (multibyte-string-p "ÅÄÖ")))
David Byers's avatar
David Byers committed
41
42
  "Non-nil if the client was compiled with multibyte characters enabled")

David Byers's avatar
X    
David Byers committed
43
(provide 'lyskom)
44

David Byers's avatar
X    
David Byers committed
45
(require 'lyskom-defvar "defvar")
Per Cederqvist's avatar
.  
Per Cederqvist committed
46

David Byers's avatar
David Byers committed
47
48
49
50
51
52
53
54
55
56
57
(defconst lyskom-global-boolean-variables '(
  kom-created-texts-are-read
  kom-dashed-lines
  kom-presence-messages
  kom-print-number-of-unread-on-entrance
  kom-read-depth-first
  kom-reading-puts-comments-in-pointers-last
  kom-confirm-multiple-recipients
)
  "List of flags that are to be saved as booleans in the common block.

58
Don't change these. They are defined by the protocol.")
59

David Byers's avatar
David Byers committed
60
61
62
63
64
65
(defconst lyskom-global-non-boolean-variables '(
  kom-default-mark
)
  "List of flags that are to be saved in the common block.
These are the non-boolean ones. See: lyskom-global-boolean-variables.

66
Don't change these. They are defined by the protocol.")
David Byers's avatar
David Byers committed
67
68


David Byers's avatar
X    
David Byers committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

(defun lyskom-protect-variable (sym) 
  (put sym 'permanent-local t)
  (lyskom-local-variable sym)
  (add-to-list 'lyskom-protected-variables sym))

(defun lyskom-local-variable (sym)
  (add-to-list 'lyskom-local-variables sym))

(defun lyskom-inherited-variable (sym)
  (add-to-list 'lyskom-inherited-variable sym)
  (lyskom-protect-variable sym))

(defun lyskom-setup-local-variables ()
  (mapcar 'make-local-variable lyskom-local-variables)
  (mapcar 'make-local-hook lyskom-local-hooks))
Per Cederqvist's avatar
.  
Per Cederqvist committed
85

David Byers's avatar
David Byers committed
86
87
88
(defvar lyskom-is-loaded nil
  "Non-nil when lyskom has been loaded.")

89
90
91
(defvar lyskom-have-one-login nil
  "Non-nil after the first login")

David Byers's avatar
David Byers committed
92

David Byers's avatar
David Byers committed
93
94
(def-kom-var kom-dont-read-saved-variables '(kom-dont-read-saved-variables
                                             lyskom-login-hook)
95
  "*Non-nil means don't read some variables from the server.
David Byers's avatar
David Byers committed
96
97
98
t means don't read any variables. A list means don't read variables that
are in the list.")

Per Cederqvist's avatar
.  
Per Cederqvist committed
99
100
101
102
103
104
105
106


;;;; ================================================================
;;;;                     Variables and constants.


;;; User flags

107
108
109
110
111
112
(def-kom-var kom-edit-hide-add-button nil
  "*If non-nil, hide the add button shown after the headers when editing
a text."
  server
)

113
(def-kom-var kom-highlight-text-body t
114
115
116
117
118
119
  "*If t, use an alternate background color for texts in LysKOM.
If nil, do not use an alternate background. Other values are reserved
for future use."
  server
)

120
121
122
123
124
125
126
127
128
129
(def-kom-var kom-highlight-first-line t
  "*If t, use kom-first-line-face to highlight the first line of each text."
  server
)

(def-kom-var kom-highlight-dashed-lines t
  "*If t, use kom-dashed-lines-face to highlight dashed lines around texts."
  server
)

130
131
132
133
134
135
136
(def-kom-var kom-extended-status-information t
  "*If t, list extended status information for all objects in LysKOM.
Extended status information include such information as read FAQs.
Values other than t or nil are reserved for future extensions."
  server
)

David Byers's avatar
David Byers committed
137
138
139
140
141
142
(def-kom-var kom-auto-list-faqs t
  "*If non-nil, list unread FAQs when entering a conference or logging
on to the server."
  server
)

143
(def-kom-var kom-auto-review-faqs t
David Byers's avatar
David Byers committed
144
145
  "*If non-nil, automatically review unread FAQs when entering a
conference or logging on to the server."
146
147
148
  server
)

David Byers's avatar
X    
David Byers committed
149
(def-kom-var kom-allow-incompleteness nil
150
151
  "*If nil, commands like kom-list-news will wait for the prefetch.
If this flag is set to t, some commands may give incomplete answers,
152
but it might make them faster, especially during the login phase."
David Byers's avatar
X    
David Byers committed
153
154
  server
)
155

David Byers's avatar
X    
David Byers committed
156
(def-kom-var kom-bury-buffers t
157
158
159
  "*Controls the behaviour of kom-next-kom and its cousins.
If this variable is non-nil the current buffer is sent to the back
of the buffer list when one of the commands `kom-next-kom',
David Byers's avatar
X    
David Byers committed
160
161
`kom-previous-kom' or `kom-next-unread-kom' is invoked."
  server)
162

David Byers's avatar
X    
David Byers committed
163
(def-kom-var kom-write-texts-in-window nil
164
  "*Where to edit texts. One of nil, 'other, 'new-frame, 'other-frame, a string
David Byers's avatar
David Byers committed
165
166
167
or a buffer.

nil means edit texts in the same window as the LysKOM buffer.
168
169
170
'other means edit in another window, creating it if necessary.
'other-frame means edit in another frame, if there is one.
'new-frame means create a new frame for editing. The frame will be removed 
David Byers's avatar
David Byers committed
171
          when editing is finished.
172
A string or buffer means edit in the indicated buffer."
David Byers's avatar
X    
David Byers committed
173
  server)
174

David Byers's avatar
X    
David Byers committed
175
(def-kom-var kom-view-commented-in-window 'other
176
  "*Where to view commented texts. See kom-write-texts-in-window for details."
David Byers's avatar
X    
David Byers committed
177
  server)
David Byers's avatar
David Byers committed
178

David Byers's avatar
X    
David Byers committed
179
180
181
182
(def-kom-var kom-edit-filters-in-window nil
  "*Where to edit filters. See kom-write-texts-in-window for
more information."
  server)
David Byers's avatar
David Byers committed
183

David Byers's avatar
X    
David Byers committed
184
185
186
187
(def-kom-var kom-list-membership-in-window 'other
  "*Where to list membership. See kom-write-texts-in-window for
more information."
  server)
188

189
190
191
192
193
(def-kom-var kom-personal-messages-in-window 'other
  "*Where to display personal messages. See kom-write-texts-in-window 
for more information."
  server)

David Byers's avatar
X    
David Byers committed
194
195
196
(def-kom-var kom-customize-format 'long
  "*Format of the customize buffer. Must be long or short."
  server)
197

David Byers's avatar
X    
David Byers committed
198
199
200
(def-kom-var kom-user-prompt-format "%[%c% %m%] - "
  "*Format of LysKOM prompt when waiting for input."
  server)
David Byers's avatar
David Byers committed
201

Per Cederqvist's avatar
.  
Per Cederqvist committed
202

David Byers's avatar
X    
David Byers committed
203
204
205
(def-kom-var kom-user-prompt-format-executing "%[%c% %m%]."
  "*Format of LysKOM prompt when executing a default command"
  server)
David Byers's avatar
David Byers committed
206
207


David Byers's avatar
X    
David Byers committed
208
209
210
(def-kom-var kom-enabled-prompt-format "%[%c% %m%] # "
  "*Format of LysKOM prompt when in enabled mode."
  server)
David Byers's avatar
David Byers committed
211

212

David Byers's avatar
X    
David Byers committed
213
214
215
216
(def-kom-var kom-enabled-prompt-format-executing "%[%c% %m%]."
  "*Format of LysKOM prompt when executing a default command in 
enabled mode."
  server)
David Byers's avatar
David Byers committed
217

David Byers's avatar
David Byers committed
218
219
220
221
222
223
224
225
(def-kom-var kom-anonymous-prompt-format "%[%c% %m%] (%a) - "
  "*Format of the LysKOM prompt when running anonymously."
  server)

(def-kom-var kom-anonymous-prompt-format-executing "%[%c% %m%] (%a)."
  "*Format of the LysKOM prompt when executing a command anonymously."
  server)

226
227
228
229
(def-kom-var kom-show-week-number t
  "*If non-nil show the ISO week number when displaying the time."
  server)

David Byers's avatar
David Byers committed
230

David Byers's avatar
X    
David Byers committed
231
232
233
(def-kom-var kom-cite-string ">"
  "*String to insert before each line of a commented text."
  server)
234

235
236
237
238
239
240
(def-kom-var kom-created-texts-are-saved nil
  "*If non-nil, save all created texts to a file. 
The value of this variable is the file name on which to save new texts."
  server
  inherited)

David Byers's avatar
X    
David Byers committed
241
242
243
(def-kom-var kom-created-texts-are-read t
  "*Non-nil means automatically mark texts that you create as read."
  server)
David Byers's avatar
David Byers committed
244

David Byers's avatar
X    
David Byers committed
245
(def-kom-var kom-customize-in-window nil
246
  "*Where to customize LysKOM. See kom-write-texts-in-window."
David Byers's avatar
X    
David Byers committed
247
  server)
Per Cederqvist's avatar
.  
Per Cederqvist committed
248

David Byers's avatar
X    
David Byers committed
249
(def-kom-var kom-prioritize-in-window nil
250
  "*Where to prioritize conferences. See kom-write-texts-in-window."
David Byers's avatar
X    
David Byers committed
251
  server)
David Byers's avatar
David Byers committed
252

253
(def-kom-var kom-default-mark nil
254
  "*If non-nil (must be an integer), the user is not asked for type of mark."
David Byers's avatar
X    
David Byers committed
255
  server)
Per Cederqvist's avatar
.  
Per Cederqvist committed
256

257
258
259
260
(def-kom-var kom-symbolic-marks-alist '(("Standard" . 100))
  "*Assoc list which maps symbolic mark strings to mark numbers."
  server)

David Byers's avatar
X    
David Byers committed
261
(def-kom-var kom-reading-puts-comments-in-pointers-last t
262
  "*If non-nil, the texts are shown with comment references at the end."
David Byers's avatar
David Byers committed
263
264
  server
  inherited)
David Byers's avatar
David Byers committed
265

266
267
268
269
270
(def-kom-var kom-review-uses-cache t
  "*If non-nil, review commands don't use the cache."
  server
  inherited)

271
272
273
274
275
(def-kom-var kom-review-marks-texts-as-read nil
  "*If non-nil, review commands mark the reviewed texts as read."
  server
  inherited)

David Byers's avatar
David Byers committed
276
277
278
279
280
(def-kom-var kom-postpone-default 17
  "*The number of articles to postpone by default."
  server)


David Byers's avatar
X    
David Byers committed
281
(def-kom-var kom-dashed-lines t
282
  "*If non-nil, all texts will be surrounded by lines of dashes."
David Byers's avatar
David Byers committed
283
284
  server
  inherited)
Per Cederqvist's avatar
.  
Per Cederqvist committed
285

286
(def-kom-var kom-long-lines nil
287
  "*If non-nil, some lines and borders will be made longer."
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
  server
  inherited)

(def-kom-var kom-text-footer-dash-length 52
  "*If non-nil, the total length of the text footer, when dashes are in use.
Note that the footer may end up longer than this if one or more elements
together are longer than this length.

This length is currently ignored when kom-text-footer-format is used."
  server
  inherited)

(def-kom-var kom-text-header-dash-length 60
  "*If non-nil, the total length of the dashes before a text body.
If kom-dashed-lines is non-nil, this is ignored."
  server
  inherited)



308
309
310
311
312
313
314
315
316
317
318
319
320
321
(def-kom-var kom-text-footer-format nil
  "*If non-nil, this specifies the format of a text footer.

The following format directives are legal:

    %n      The text number.
    %p      The number of the author.
    %P      The name of the author
    %-      A bunch of dashes
    %f      Information about the text in parentheses.

Format letters can be prefixed with a number specifying the minimum
field width. The field width can be prefixed with an equals sign which
means that the field is exactly as wide as specified (contents may be
322
truncated). A negative field width means left justify the contents.
323
324

The field width of %- is special. It specifies the maximum number of
325
dashes printed. The actual number will be the maximum minus the
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
length of the author's name, if it is included anywhere in the format
string.

When set, this variable overrides kom-dashed-lines and
kom-show-author-at-end.

The default format is equivalent to the following strings, depending on 
the settings of kom-dashed-lines and kom-show-author-at-end.

kom-dashed-lines    kom-show-author-at-end      Format
t                   t                           \"(%n) /%P/%42-%f\"
t                   nil                         \"(%n) %42-%f\"
nil                 t                           \"(%n) /%P/ %f\"
nil                 nil                         \"(%n) %f\"
"
  server
  inherited)



346
(def-kom-var kom-show-creating-software nil
347
  "*If non-nil, show the creating software of each text, if specified."
348
349
350
  server
  inherited)

David Byers's avatar
David Byers committed
351
(def-kom-var kom-show-author-at-end t
352
  "*If non-nil, the author will be shown at the end of each text."
David Byers's avatar
David Byers committed
353
354
  server
  inherited)
David Byers's avatar
David Byers committed
355

356
(def-kom-var kom-truncate-threshold nil
357
358
  "*If non-nil, truncate long texts when reviewing.
If the text is longer (in lines), the threshold it will be
359
360
361
truncated to `kom-truncate-show-lines' length."
  server)

362
(def-kom-var kom-truncate-show-lines 10
363
364
365
366
367
368
369
  "*How many lines to show after truncating.
If the text is truncated by `kom-truncate-threshold', show this many
lines.  If this is greater than the threshold, the threshold will be
used."
  server)


David Byers's avatar
X    
David Byers committed
370
(def-kom-var kom-print-number-of-unread-on-entrance t
371
  "*If non-nil, print automatically the number of unread articles when
David Byers's avatar
X    
David Byers committed
372
373
entering a conference."
  server)
Per Cederqvist's avatar
.  
Per Cederqvist committed
374

375
(def-kom-var kom-show-unread-in-frame-title t
376
  "*If non-nil, show an unread indicator in the frame title of each
377
378
379
LysKOM session."
  server)

David Byers's avatar
X    
David Byers committed
380
(def-kom-var kom-presence-messages t
381
  "*If non-nil, LysKOM prints continuous info about what other people are doing.
Per Cederqvist's avatar
.  
Per Cederqvist committed
382
Info is printed on the message line and never in the buffer. If minibuffer is
383
used, no message is printed.
Linus Tolke's avatar
Linus Tolke committed
384

David Byers's avatar
David Byers committed
385
386
387
388
A list of integers means show messages for those users.

The value 'friends means show messages for the users in kom-friends.

389
390
391
392
393
The value 'morons means show messages for the users in kom-morons.

The value 'friends-and-morons means show messages for the users in 
kom-friends and kom-morons.

394
If you want the messages in the buffer, you could set the variable 
David Byers's avatar
X    
David Byers committed
395
396
kom-presence-messages-in-buffer."
  server)
David Byers's avatar
David Byers committed
397

David Byers's avatar
X    
David Byers committed
398
(def-kom-var kom-presence-messages-in-buffer nil
399
  "*If t, LysKOM prints information about what other people are doing in the buffer.
Per Cederqvist's avatar
.  
Per Cederqvist committed
400
401
All printing is done just before the prompt.
If nil no messages are printed.
402
403
If 'presence, messages about people logging in, out and people 
changing name are printed."
David Byers's avatar
X    
David Byers committed
404
  server)
Per Cederqvist's avatar
.  
Per Cederqvist committed
405

David Byers's avatar
X    
David Byers committed
406
(def-kom-var kom-show-where-and-what t
Per Cederqvist's avatar
.  
Per Cederqvist committed
407
  "*Non-nil means kom-who-is-on shows from which machine the user is running
David Byers's avatar
X    
David Byers committed
408
409
and what he is doing."
  server)
David Byers's avatar
David Byers committed
410

411
412
(def-kom-var kom-show-since-and-when nil
  "*Non-nil means kom-who-is-on shows when the user connected and when
413
he last was active."
414
  server)
Per Cederqvist's avatar
.  
Per Cederqvist committed
415

David Byers's avatar
X    
David Byers committed
416
(def-kom-var kom-idle-hide 30
417
  "*The number of minutes of idle-time before a user is excluded from the list
David Byers's avatar
X    
David Byers committed
418
419
of users. This can be overridden by a prefix argument to `kom-who-is-on'."
  server)
420

David Byers's avatar
X    
David Byers committed
421
422
423
(def-kom-var kom-show-footnotes-immediately t
  "*Non-nil means show footnotes immediately following the text."
  server)
424

David Byers's avatar
X    
David Byers committed
425
(def-kom-var kom-follow-comments-outside-membership nil
426
427
428
  "*Show comments in conferences you are not a member of.

If this variable is nil, texts with no recipient you are a member of
David Byers's avatar
X    
David Byers committed
429
430
will not be shown."
  server)
431

David Byers's avatar
David Byers committed
432
433
434
435
(def-kom-var kom-follow-attachments t
  "*Follow attachments as if they are regular comments."
  server)

436
437
438
439
;;(def-kom-var kom-who-buffer-size-when-displaying 10
;;  "Size of window to display the who-buffer.
;;This is used when executing the kom-display-who-buffer command."
;;  server)
Per Cederqvist's avatar
.  
Per Cederqvist committed
440

David Byers's avatar
X    
David Byers committed
441
442
443
(def-kom-var kom-read-depth-first t
  "*Non-nil means read comments and footnotes to a text before other texts."
  server)
David Byers's avatar
David Byers committed
444

David Byers's avatar
X    
David Byers committed
445
(def-kom-var kom-continuous-scrolling t
446
  "*Non-nil means scroll LysKOM window as text is inserted. The last viewed
David Byers's avatar
X    
David Byers committed
447
448
position (generally the most recent prompt) will always be visible."
  server)
449
450


451
;; Should this be set to nil if baud-rate is low?
David Byers's avatar
X    
David Byers committed
452
(def-kom-var kom-deferred-printing t
453
  "*Non-nil means delay printing of some information not in the cache.
454
455
You might want to turn this off to have the old, linear behaviour."
  server)
456

David Byers's avatar
X    
David Byers committed
457
458
(def-kom-var lyskom-defer-indicator "[...]"
  "String to display while LysKOM is waiting for the real string.")
459

460
461
462
463
464
465
(def-kom-var kom-review-priority nil
  "*If non-nil, the priority to use when reviewing texts. Set this to
255 or higher to avoid texts and conferences with higher priority to
break in while reviewing."
  server)

David Byers's avatar
X    
David Byers committed
466
(def-kom-var kom-higher-priority-breaks nil
467
468
469
  "*Non-nil means allow texts from conferences with higher priority to break in.
If the value is 'express, texts are allowed to break in the middle of a
comment chain. Otherwise we don't let them in until the end of the comment
David Byers's avatar
X    
David Byers committed
470
471
tree."
  server)
Per Cederqvist's avatar
.  
Per Cederqvist committed
472

473
474
(def-kom-var kom-server-priority-breaks nil
  "*Non-nil means allow servers with a higher priority to break in.
475
476
Valid values are 'express, 'express-letters, 'letters, 'after-conf, 
'after-conf-letters, t and 'when-done.
477

478
'express means break immediately when a text arrives in a prioritized
479
480
session.

481
'express-letters means break immediately when a letter arrives in a 
482
483
484
485
486
prioritized session.

t means break after the current comment chain when a text arrives in 
a prioritized session.

487
'letters means break after the current comment chain when a letter
488
489
arrives in a prioritized session.

490
'after-conf means break after the current conference when a text
491
492
arrives in a prioritized session.

493
'after-conf-letters means break after the current conference when a
494
495
letter arrives in a prioritized session.

496
'when-done means prompt user to go to the next session with unreads
497
498
499
500
501
after everything has been read. This overrides kom-do-when-done as
long as there are sessions with unread texts.
"
  server)

David Byers's avatar
X    
David Byers committed
502
(def-kom-var lyskom-view-text-hook nil
503
  "*Hook that is called before a text is shown. When the hooks are
504
505
called, lyskom-view-text-text is bound to the text mass of the 
text and lyskom-view-text-text-stat to the text-stat of the text
506
507
to be shown."
  local-hook)
508
509


David Byers's avatar
X    
David Byers committed
510
(def-kom-var lyskom-send-message-hook '(lyskom-send-message-trim-newlines)
David Byers's avatar
David Byers committed
511
512
513
514
515
516
517
  "*Hook that is called before a personal, group or common message is sent. 

When called, lyskom-message-string is bound to the message that will be sent
and lyskom-message-recipient to the conf-stat of the recipient or nil if
the recipient does not exist or if the message is a common message.

If lyskom-message-string is set to nil by a hook, the message will not
518
519
be sent."
  local-hook)
David Byers's avatar
David Byers committed
520

David Byers's avatar
X    
David Byers committed
521
(def-kom-var lyskom-send-message-setup-hook nil
522
523
  "*Hook that is called when the minibuffer is entered to read a message."
  local-hook)
524

David Byers's avatar
X    
David Byers committed
525
(def-kom-var lyskom-send-message-exit-hook nil
526
527
  "*Hook that is called when the minibuffer is exited after reading a message."
  local-hook)
528

David Byers's avatar
David Byers committed
529
530
(def-kom-var lyskom-send-text-hook nil
  "*Hook that is called before sending a text. Hook functions return t to
531
signal success and nil to prevent the text from being sent."
532
  local-hook)
David Byers's avatar
David Byers committed
533

David Byers's avatar
X    
David Byers committed
534
(def-kom-var lyskom-after-load-hook nil
535
  "*Hook to run once after LysKOM is loaded.")
David Byers's avatar
David Byers committed
536

David Byers's avatar
David Byers committed
537
538
539
(def-kom-var lyskom-change-conf-hook nil
  "*Hook to run when changing conferences.
The functions in this list are run with two arguments. The first is the 
540
541
542
543
544
545
546
547
548
549
550
551
552
current conf-no and the second is the conf-no being changed to.

This hook is run before lyskom-current-conf is changed, and before any
standard messages have been printed."
  local-hook)

(def-kom-var lyskom-after-change-conf-hook nil
  "*Hook to run when changing conferences.
The functions in this list are run with two arguments. The first is the 
current conf-no and the second is the conf-no being changed to.

This hook is run after lyskom-current-conf is changed, and after any
standard messages have been printed."
553
  local-hook)
David Byers's avatar
David Byers committed
554

David Byers's avatar
X    
David Byers committed
555
(def-kom-var lyskom-login-hook nil
556
  "*What to do when logged in.
557
This hook is called after we have logged in but before any command is
558
accepted from the keyboard. It is called immediately before
559
560
kom-login-hook."
  local-hook)
561

David Byers's avatar
X    
David Byers committed
562
(def-kom-var kom-login-hook nil
Per Cederqvist's avatar
.  
Per Cederqvist committed
563
564
  "*What to do when logged in.
This is a list of commands that are executed after we have logged in but before
David Byers's avatar
X    
David Byers committed
565
566
any command is accepted from the keyboard. See also lyskom-login-hook."
  server)
David Byers's avatar
David Byers committed
567

568
569
570
(def-kom-var kom-confirm-add-recipients t
  "*When non-nil, offer to add cc-recipient instead of full recipient."
  server)
571

Per Cederqvist's avatar
.  
Per Cederqvist committed
572

David Byers's avatar
X    
David Byers committed
573
(def-kom-var kom-do-when-done '(kom-review-all-marked-texts kom-display-time)
Per Cederqvist's avatar
.  
Per Cederqvist committed
574
575
576
577
578
  "*What to do when all texts are read.
This is a list of commands and lists of commands that are prompted for
and executed when there are no more new texts.  The last element in
the list is the one that will never be removed from the list.
A command can be one of:
579

Per Cederqvist's avatar
.  
Per Cederqvist committed
580
type			prompt
581
582
583
584
585
------------------------------
lyskom-function		from the lyskom-command-name function
command			\"Command:\" (name of function or definition of
			lambda expression)
keyboard macro		\"Command:\" (keyboard macro definition)"
David Byers's avatar
X    
David Byers committed
586
  server)
David Byers's avatar
David Byers committed
587

David Byers's avatar
X    
David Byers committed
588
(def-kom-var kom-page-before-command nil
589
  "*This is a list of all commands before which the screen is cleared.
David Byers's avatar
X    
David Byers committed
590
591
If it isn't a list and isn't nil the screen is cleared before all commands."
  server)
Per Cederqvist's avatar
.  
Per Cederqvist committed
592

David Byers's avatar
X    
David Byers committed
593
(def-kom-var kom-permissive-completion t
594
595
  "*If t, completion on logged-in persons will usually also include
persons who are not logged in. Values other than t or nil are reserved
David Byers's avatar
X    
David Byers committed
596
597
for future use."
  server)
598

599
600
601
602
603
(def-kom-var kom-unsubscribe-makes-passive t
  "*If non-nil subtracting oneself from a conference makes the membership
passive. A second leave will actually remove the membership."
  server)

David Byers's avatar
David Byers committed
604
(def-kom-var kom-membership-default-priority 'ask
Per Cederqvist's avatar
.  
Per Cederqvist committed
605
606
607
608
  "*Default priority when joining a new conference.
If a valid priority then new conferences are read with this priority. 
Otherwise ask the user for a priority.

David Byers's avatar
X    
David Byers committed
609
610
Valid priorities are only the range 0-255."
  server)
David Byers's avatar
David Byers committed
611

David Byers's avatar
X    
David Byers committed
612
(def-kom-var kom-membership-default-placement 'last
Per Cederqvist's avatar
.  
Per Cederqvist committed
613
614
615
616
617
  "*Tells the system where to put new conferences.
The value can be one of the following:
'first => before all other conferences.
'last => after all other conferences.
a number => at that position
618
otherwise => the new conference is entered after all conferences."
David Byers's avatar
X    
David Byers committed
619
  server)
David Byers's avatar
David Byers committed
620

David Byers's avatar
X    
David Byers committed
621
(def-kom-var lyskom-current-prompt nil
622
623
  "The current prompt or nil.
This is either nil, indicating that there is currently no prompt, or
624
a symbol indicating which command is prompted in the LysKOM buffer."
David Byers's avatar
X    
David Byers committed
625
  local)
David Byers's avatar
David Byers committed
626

David Byers's avatar
X    
David Byers committed
627
628
629
630
631
632
(def-kom-var lyskom-current-prompt-text nil
  "The current prompt text or nil.
This is either nil, indicating that there is currently no prompt, or
a string indicating the prompt shown in the LysKOM buffer."
  local)

633
(def-kom-var lyskom-current-prompt-args nil
634
  "The current prompt arguments.
635
636
637
These are arguments used to format the current prompt."
  local)

638
639
640
641
642
(def-kom-var lyskom-current-prompt-timestamp nil
  "The creationtime of the current prompt.
This is used when updating the prompt and on lyskom-start-of-command."
  local)

643
644
645
646
(def-kom-var lyskom-need-prompt-update nil
  "Non-nil if all prompts need to be updated."
  local)

David Byers's avatar
X    
David Byers committed
647
(def-kom-var kom-show-personal-messages-in-buffer t
648
649
650
651
  "*Buffer to show personal messages in.
If nil, discard them.
If t, insert them in the *kom* buffert.
If non-nil and non-t this should be a buffer or a name of a (possibly
David Byers's avatar
X    
David Byers committed
652
653
nonexistent) buffer in which the message is inserted."
  server)
David Byers's avatar
David Byers committed
654

David Byers's avatar
X    
David Byers committed
655
(def-kom-var kom-pop-personal-messages nil
656
  "*Non-nil means pop up a buffer with personal messages as they arrive.
David Byers's avatar
X    
David Byers committed
657
658
kom-show-personal-messages-in-buffer decides which buffer to pop."
  server)
659

660
661
662
(def-kom-var kom-ding-pause-amount 0.1
  "*Amount of time to wait between successive beeps.")

David Byers's avatar
X    
David Byers committed
663
(def-kom-var kom-ding-on-new-letter nil
664
  "*Non-nil means ding if a message arrives in the letter box. See 
David Byers's avatar
X    
David Byers committed
665
666
kom-ding-on-priority-break for valid values."
  server)
667
668


David Byers's avatar
X    
David Byers committed
669
(def-kom-var kom-ding-on-priority-break 1
670
671
  "*Non-nil means ding if a higher priority text or conference breaks in.
A number means the number of times to ding. A string is an argument for the
David Byers's avatar
X    
David Byers committed
672
673
program named by kom-audio-player."
  server)
David Byers's avatar
David Byers committed
674

David Byers's avatar
X    
David Byers committed
675
(def-kom-var kom-ding-on-wait-done 1
676
677
678
  "*Non-nil means ding when busy-waiting finishes.
A number means the number of times to ding. A string is an argument
for the program named by kom-audio-player. A symbol is interpreted as a 
David Byers's avatar
X    
David Byers committed
679
680
function to call."
  server)
681

David Byers's avatar
X    
David Byers committed
682
(def-kom-var kom-ding-on-common-messages 0
683
684
685
686
687
688
689
  "*Non-nil means ding as alarm messages arrive. 
A number means the number of times to ding. A string is an argument
for the program named by kom-audio-player. A symbol is interpreted as
a function to call. A list consisting of pairs (KEY . VALUE) is used
for fine-grained control. The list is searched for a pair where KEY
matches the sender identity. The corresponding VALUE is used as the
specification on how to beep."
David Byers's avatar
X    
David Byers committed
690
  server)
David Byers's avatar
David Byers committed
691

David Byers's avatar
X    
David Byers committed
692
(def-kom-var kom-ding-on-group-messages 1
693
  "*Non-nil means ding as group messages arrive.
694
695
696
697
698
699
A number means the number of times to ding. A string is an argument
for the program named by kom-audio-player. A symbol is interpreted as
a function to call. A list consisting of pairs (KEY . VALUE) is used
for fine-grained control. The list is searched for a pair where KEY
matches the recipient identity. The corresponding VALUE is used as the
specification on how to beep."
David Byers's avatar
X    
David Byers committed
700
  server)
701

David Byers's avatar
X    
David Byers committed
702
(def-kom-var kom-ding-on-personal-messages 2
703
  "*Non-nil means ding as personal messages arrive.
704
705
706
707
708
709
A number means the number of times to ding. A string is an argument
for the program named by kom-audio-player. A symbol is interpreted as
a function to call. A list consisting of pairs (KEY . VALUE) is used
for fine-grained control. The list is searched for a pair where KEY
matches the sender identity. The corresponding VALUE is used as the
specification on how to beep."
David Byers's avatar
X    
David Byers committed
710
  server)
David Byers's avatar
David Byers committed
711
712


David Byers's avatar
David Byers committed
713
(def-kom-var kom-ding-on-no-subject 2
714
  "*How to ding if the user has not entered a subject line.
715
716
A number means the number of times to ding. A string is an argument for the
program named by kom-audio-player. A symbol is interpreted as a function 
David Byers's avatar
David Byers committed
717
718
to call."
  server)
David Byers's avatar
David Byers committed
719

720

David Byers's avatar
X    
David Byers committed
721
(def-kom-var kom-audio-player "audioplay"
David Byers's avatar
David Byers committed
722
723
  "*Program to play audio files."
  server)
David Byers's avatar
David Byers committed
724

Per Cederqvist's avatar
.  
Per Cederqvist committed
725

726
727
728
729
730
731
732
733
(def-kom-var kom-ignore-message-senders nil
  "*List of senders whose personal, group and alarm messages are ignored."
  server)

(def-kom-var kom-ignore-message-recipients nil
  "*List of recipients you do not want group messages to."
  server)

734
735
736
737
(def-kom-var kom-show-personal-message-date t
  "*Show date on personal messages is non-nil."
  server)

David Byers's avatar
X    
David Byers committed
738
(def-kom-var kom-default-message-recipient 'group
David Byers's avatar
David Byers committed
739
740
  "*Determines default recipient of personal messages.

741
742
743
744
745
746
'everybody means the default recipient is everybody.
'group     means the default recipient is the group to which the last
           message was sent, if it was a group message. If the last message
           was a personal message or a common message, it means the same as 
           'sender. 
'sender    means the sender of the last message received."
David Byers's avatar
X    
David Byers committed
747
  server)
David Byers's avatar
David Byers committed
748
749


David Byers's avatar
X    
David Byers committed
750
(def-kom-var lyskom-filter-outgoing-messages t
751
  "*t if outgoing remote-control messages and automatic replies are not
752
753
to be displayed in the buffer."
  server)
David Byers's avatar
David Byers committed
754
755


David Byers's avatar
X    
David Byers committed
756
(def-kom-var kom-friends nil
David Byers's avatar
David Byers committed
757
758
759
  "*List of people whose names should be formatted using kom-friends-face.
Also used in kom-who-is-on-and-friend. This is a list of integers (person
numbers)."
David Byers's avatar
X    
David Byers committed
760
  server)
761

762
763
764
765
(def-kom-var kom-morons nil
  "*List of people whose names should be formatted using kom-morons-face."
  server)

766
767
768
(def-kom-var kom-dont-check-commented-authors nil
  "*List of recipients who do not need to be added to comments that they
might not see. Typically this list consists of import agents."
769
770
  server
  inherited)
771

David Byers's avatar
X    
David Byers committed
772
773
(def-kom-var kom-default-face-scheme nil  
  "*Face scheme to use per default for new logins.")
David Byers's avatar
David Byers committed
774

David Byers's avatar
David Byers committed
775
776
777
778
(def-kom-var kom-smileys t
  "*Non-nil means to reformat smileys in text."
  server)

David Byers's avatar
X    
David Byers committed
779
(def-kom-var kom-text-properties t
780
  "*Non-nil means to insert text properties in the Emacs buffer for
David Byers's avatar
X    
David Byers committed
781
various LysKOM elements.")
782

David Byers's avatar
X    
David Byers committed
783
784
(def-kom-var kom-use-button-hints t
  "*Non-nil means use button hints for overriding default actions.")
David Byers's avatar
David Byers committed
785

David Byers's avatar
David Byers committed
786
(def-kom-var kom-autowrap t
David Byers's avatar
David Byers committed
787
788
  "*Non-nil means auto wrap articles with discretion.
A number means wrap articles shorter than the number (in bytes)."
David Byers's avatar
David Byers committed
789
790
  server)

791
792
793
(def-kom-var kom-keep-alive-interval 180
  "*The number of seconds between periodic requests used to keep the session alive"
  server)
794

795
796
797
798
(defvar lyskom-transforming-external-text nil
  "Dynamically bound to non-nil when transforming text in which text,
conference and person buttons are not expected.")

David Byers's avatar
David Byers committed
799
(def-kom-var lyskom-url-protocol-regexp
800
801
  "\\(file\\|ftp\\|gopher\\|http\\|https\\|news\\|wais\\|mailto\\|telnet\\):"
  "Regexp to match the protocol part of a URL.")
David Byers's avatar
David Byers committed
802

David Byers's avatar
X    
David Byers committed
803
(def-kom-var lyskom-text-buttons
804
805
  '(
    ;; Text numbers
806
807
808
809
810
811
    ("\\(\\<[0-9][0-9][0-9][0-9]\\([0-9]\\)?\\([0-9]\\)?\\([0-9]\\)?\\>\\)" 
                                        ; Match
     text                               ; Button type
     0                                  ; Portion that's a button
     1                                  ; Portion that's the arg
     nil                                ; Face or nil (=default)
812
813
     )

David Byers's avatar
David Byers committed
814
815
    ;; Email

David Byers's avatar
David Byers committed
816
    ("\\(\\b\\|^\\)[^()<>@,;:\"\\\\\000- ]+@[^\000- <>;,.'\"!:?) \t\012\014]+\\(\\.[^\000- <>;,.'\"!:?)]+\\)+"
David Byers's avatar
David Byers committed
817
818
     email 0 0 kom-url-face)

819
820
    ;; URLs

821
    ("\\b\\(www\\|ftp\\|home\\)\\.[^\t \012\014\"<>|\\]*[^\t \012\014\"<>|.,!(){}?'`:]" 
David Byers's avatar
David Byers committed
822
823
     pseudo-url 0 nil kom-url-face)

824
    ("\\(file://\\|ftp://\\|gopher://\\|http://\\|https://\\|news:\\|wais://\\|mailto:\\|telnet:\\)[^\t \012\014\"<>|\\]*[^\t \012\014\"<>|.,!(){}?'`:]" 
825
     url 0 nil kom-url-face)
David Byers's avatar
X    
David Byers committed
826
827
828
    ("<URL:\\s-*\\([^>]*\\)\\s-*>"
     url 1 1 kom-url-face)

829
830
    ;; JySKom enhancements

831
832
833
834
835
836
    ("<(?m[|ö]te[ \t\n]*\\([0-9]+\\)\\([^0-9>]?\\|[^0-9>][^>]*\\))?>"
     conf 0 1 nil)
    ("<(?text[ \t\n]*\\([0-9]+\\)\\([^0-9>]?\\|[^0-9>][^>]*\\))?>"
     text 0 1 nil)
    ("<(?person[ \t\n]*\\([0-9]+\\)\\([^0-9>]?\\|[^0-9>][^>]*\\))?>"
     pers 0 1 nil)
David Byers's avatar
David Byers committed
837

838
839
    ;; Info node reference

David Byers's avatar
David Byers committed
840
    ("\\*Note[ \n\t]+\\([^:\n]*\\(\n[^:\n]*\\)?\\):\\s-*\\(\\(([^\)]+)\\)?[^.,\t\n]*\\(\n[^.,\t\n]*\\)?\\)[.,\t]" 
841
     info-node 1 3 kom-url-face)
842

David Kågedal's avatar
David Kågedal committed
843
    )
844
845
846
  "List of buttons to install in the text mass of LysKOM objects. Each element is
a list consisting of REGEXP TYPE BUTTON-MATCH BUTTON-ARG-MATCH FACE.
REGEXP is the regexp to look for in the text.
847
TYPE is the button type. Valid button types are defined in lyskom-button-actions.
848
BUTTON-MATCH is the number of the parenthesized expression that is the actual button.
849
BUTTON-ARG-MATCH is the number of the expression to be used as the button argument.
David Byers's avatar
X    
David Byers committed
850
FACE is the text face to apply to the button, or nil to use the default face.")
851

David Byers's avatar
X    
David Byers committed
852
(def-kom-var kom-url-viewer-preferences '("emacs"
853
854
                                          "windows"
                                          "w3")
David Byers's avatar
David Byers committed
855

856
  "*LysKOM will attempt to use URL viewers in the order specified here.
David Byers's avatar
David Byers committed
857
858
859
kom-url-managers is a list of all available viewers. Note that the elements
are all strings.

860
When you select a URL, this list is used to determine which URL
David Byers's avatar
David Byers committed
861
862
863
864
865
866
viewer to use in the following manner: Each element is in turn matched
against the manager regexp for each manager in kom-url-managers, and the
first manager found that matches is used to display the URL.

See kom-url-managers for a list of all available URL viewers. See
kom-netscape-command and kom-mosaic-command for information specific 
David Byers's avatar
David Byers committed
867
868
to some URL viewers."
  server)
869
870


David Byers's avatar
X    
David Byers committed
871
872
(def-kom-var kom-url-managers '(("default"
                            ".*"
873
                            "Browse-URL"
David Byers's avatar
X    
David Byers committed
874
875
                            lyskom-view-url-browse-url)
                           ("w3" 
876
877
878
			    "\\(http\\|gopher\\|ftp\\)"
			    "Emacs W3" 
			    lyskom-view-url-w3)
879
880
                           ("windows"
                            ".*"
881
                            "web browser"
882
                            lyskom-view-url-windows)
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
			   ("netscape"
			    ".*"
			    "Netscape Navigator"
			    lyskom-view-url-netscape)
			   ("\\(emacs\\|dired\\)"
			    "\\(ftp\\|file\\)"
			    "dired"
			    lyskom-view-url-dired)
			   ("\\(emacs\\|telnet-mode\\)"
			    "telnet"
			    "emacs telnet"
			    lyskom-view-url-telnet)
			   ("\\(emacs\\|mail-mode\\)"
			    "mailto"
			    "mail-mode"
			    lyskom-view-url-mailmode)
			   ("mosaic"
Peter Liljenberg's avatar
Peter Liljenberg committed
900
901
902
903
904
905
			    "\\(http\\|gopher\\|ftp\\|mailto\\|news\\|wais\\|file\\|telnet\\)"
			    "NCSA Mosaic"
			    lyskom-view-url-mosaic)
			   ("lynx"
			    "\\(http\\|gopher\\|ftp\\|mailto\\|news\\|wais\\|file\\|telnet\\)"
			    "Lynx"
Ulrik Haugen's avatar
Ulrik Haugen committed
906
907
908
909
910
			    lyskom-view-url-lynx)
			   ("galeon"
			    "\\(http\\|gopher\\|ftp\\|mailto\\|news\\|wais\\|file\\|telnet\\)"
			    "Galeon"
			    lyskom-view-url-galeon))
911
912

  "List of URL managers. Each element is a list consisting of
David Byers's avatar
David Byers committed
913
(MANAGER-REGEXP PROTOCOLS NAME VIEW-FUNCTION). When LysKOM attempts to
914
view a URL, kom-url-viewer-preferences is scanned, and the URL
David Byers's avatar
David Byers committed
915
916
917
manager whose MANAGER-REGEXP first matches an element in
kom-url-viewer-preferences and whose PROTOCOLS matches the protocol of
the selected URL is used to view the URL by calling its VIEW-FUNCTION
David Byers's avatar
X    
David Byers committed
918
with the URL and the manager entry as arguments.")
David Byers's avatar
David Byers committed
919

920
921
922
923
924
925
(def-kom-var kom-windows-browser-command ""
  "*Program to run to open a URL in Windows. If it is the empty
string, a couple of commands that are likely the work on Windows will
be tried."
  server)

David Byers's avatar
X    
David Byers committed
926
(def-kom-var kom-mosaic-command "/usr/local/bin/mosaic"
927
  "*Command to run to start Mosaic."
David Byers's avatar
David Byers committed
928
  server)
David Byers's avatar
David Byers committed
929

David Byers's avatar
X    
David Byers committed
930
(def-kom-var kom-netscape-command "netscape"
David Byers's avatar
David Byers committed
931
932
933
934
935
936
937
  "*Command to run to start Netscape.

If a string, it should be a command that starts Netscape with no
arguments. If a list, the first element must be a command that starts
Netscape. The remaining elements are used as arguments to Netscape.

For instance, a value of \"netscape\" is valid, but \"netscape -d host:0\"
David Byers's avatar
David Byers committed
938
939
is not. Instead, the latter should be \(\"netscape\" \"-d\" \"host:0\"\)"
  server)
David Byers's avatar
David Byers committed
940

Ulrik Haugen's avatar
Ulrik Haugen committed
941
942
943
944
945
946
947
948
949
950
951
(def-kom-var kom-galeon-command "galeon"
  "*Command to run to start Galeon.

If a string, it should be a command that starts Galeon with no
arguments. If a list, the first element must be a command that starts
Galeon. The remaining elements are used as arguments to Galeon.

For instance, a value of \"galeon\" is valid, but \"galeon --display host:0\"
is not. Instead, the latter should be \(\"galeon\" \"--display\" \"host:0\"\)"
  server)

Peter Liljenberg's avatar
Peter Liljenberg committed
952
953
954
(def-kom-var kom-lynx-terminal 'xterm
  "*Where to start Lynx.
Valid values are 'xterm (start Lynx in an xterm) and 'terminal (start
955
Lynx in Emacs terminal mode).")
Peter Liljenberg's avatar
Peter Liljenberg committed
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970

(def-kom-var kom-lynx-xterm-command
  '("xterm" "-geometry" "90x50+100+100" "-e" "lynx")
  "*Command to run to start Lynx in an xterm.
Must be a list of strings, where the first element is the name of the
xterm program, and the remaining elements are arguments to the
xterm. The last elements should be \"-e\" \"lynx\", or something similar,
to start Lynx.")

(def-kom-var kom-lynx-terminal-command "lynx"
  "*Command to run Lynx in Emacs terminal mode.

This can be either a string, to start Lynx with no arguments, or a
list of strings, where the first element is the command, and the rest
are arguments to Lynx.")
971

David Byers's avatar
X    
David Byers committed
972
(def-kom-var kom-confirm-multiple-recipients 'after
973
974
  "*Non-nil means ask the user for confirmation about recipients.
When the user writes a comment to a text with more than one recipient
975
976
he gets a y-or-n-p question for all recipients. 'before means check
before opening the edit buffer. Anything else means check before
David Byers's avatar
X    
David Byers committed
977
978
sending the article."
  server)
979

David Byers's avatar
David Byers committed
980
981
982
983
984
985
986
987
(def-kom-var kom-check-for-new-comments t
  "*Non-nil means check that no new comments have been written to a commented
texts since the last check. A list means check in all conferences except
those listed. A function means call the function and check if non-nil is
returned. The function is called with the commented text's text-stat as
an argument."
  server)

David Byers's avatar
X    
David Byers committed
988
(def-kom-var kom-check-commented-author-membership t
989
990
  "*Non-nil means check that the authors of the commented texts are
members of at least one of the recipient conferences. If not, offer to
David Byers's avatar
X    
David Byers committed
991
992
add them as recipients."
  server)
993

David Byers's avatar
X    
David Byers committed
994
(def-kom-var kom-inhibit-typeahead nil
995
  "*If non-nil, discard keyboard input that arrives while a LysKOM command is
David Byers's avatar
X    
David Byers committed
996
997
executing. "
  server)
998

David Byers's avatar
X    
David Byers committed
999
(def-kom-var kom-max-buffer-size nil
1000
  "*If non-nil, ensure that buffers won't grow any larger than this."
For faster browsing, not all history is shown. View entire blame