vars.el.in 138 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
;;;; ================================================================
;;;; ================================================================
;;;;
;;;; File: vars.el
;;;;
;;;; This file contains almost all the variables used in lyskom.
;;;;

33
34
35
;;;; Note: put "**" at the front of docstrings that are ready
;;;; for use in DocBook autogeneration.

Per Cederqvist's avatar
.    
Per Cederqvist committed
36

David Byers's avatar
X    
David Byers committed
37
38
39
(setq lyskom-clientversion-long 
      (concat lyskom-clientversion-long
	      "$Id$\n"))
40

41
42
(defvar lyskom-dummy-variable-to-fool-the-byte-compiler)

David Byers's avatar
David Byers committed
43
(defvar lyskom-mule-compiled
44
45
  (eval-when-compile (and (fboundp 'multibyte-string-p)
                          (multibyte-string-p "ÅÄÖ")))
David Byers's avatar
David Byers committed
46
47
  "Non-nil if the client was compiled with multibyte characters enabled")

David Byers's avatar
X    
David Byers committed
48
(provide 'lyskom)
49

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

David Byers's avatar
David Byers committed
52
53
54
55
56
57
58
59
60
61
62
(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.

63
Don't change these. They are defined by the protocol.")
64

David Byers's avatar
David Byers committed
65
66
67
68
69
70
(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.

71
Don't change these. They are defined by the protocol.")
David Byers's avatar
David Byers committed
72
73


David Byers's avatar
X    
David Byers committed
74
75

(defun lyskom-protect-variable (sym) 
David Byers's avatar
David Byers committed
76
  "Protect SYM from being killed when deleting local variables."
David Byers's avatar
X    
David Byers committed
77
78
79
80
81
  (put sym 'permanent-local t)
  (lyskom-local-variable sym)
  (add-to-list 'lyskom-protected-variables sym))

(defun lyskom-local-variable (sym)
David Byers's avatar
David Byers committed
82
  "Define SYM as a buffer-local variable"
David Byers's avatar
X    
David Byers committed
83
84
85
  (add-to-list 'lyskom-local-variables sym))

(defun lyskom-inherited-variable (sym)
David Byers's avatar
David Byers committed
86
87
  "Define SYM as a variable that is inherited when creating new buffers.
Inheritance only works with the LysKOM buffer handling functions."
David Byers's avatar
X    
David Byers committed
88
89
90
91
  (add-to-list 'lyskom-inherited-variable sym)
  (lyskom-protect-variable sym))

(defun lyskom-setup-local-variables ()
David Byers's avatar
David Byers committed
92
  "Set up all globally defined local variables in the current buffer."
David Byers's avatar
X    
David Byers committed
93
94
  (mapcar 'make-local-variable lyskom-local-variables)
  (mapcar 'make-local-hook lyskom-local-hooks))
Per Cederqvist's avatar
.    
Per Cederqvist committed
95

David Byers's avatar
David Byers committed
96
97
98
(defvar lyskom-is-loaded nil
  "Non-nil when lyskom has been loaded.")

99
100
101
(defvar lyskom-have-one-login nil
  "Non-nil after the first login")

David Byers's avatar
David Byers committed
102

David Byers's avatar
David Byers committed
103
104
(def-kom-var kom-dont-read-saved-variables '(kom-dont-read-saved-variables
                                             lyskom-login-hook)
David Byers's avatar
David Byers committed
105
  "**Determines which LysKOM variables to not store in the server.
106
107
108
109
110
111
112
113
114
115

For the most part you do not have to modify this variable. Any variables
set before LysKOM is loaded will not be read from the server.
This variable should `nil', `t' or a list of symbols. 

The value `nil' means read all variables from the server. The value
`t' means read no variables from the server. When the value is a list
of symbols, those variables will not be read from the server.

Any other values are reserved for future use.")
David Byers's avatar
David Byers committed
116

117
118
119
120
(defmacro lyskom-maybe-setq (var value)
  "This is a wrapper around setq that does nothing
if the variable is in kom-dont-read-saved-variables."
  `(cond ((eq kom-dont-read-saved-variables t) nil)
121
         ((memq ,var kom-dont-read-saved-variables) nil)
David Byers's avatar
David Byers committed
122
         (t (set ,var ,value))))
123
124
125
126
127

(defmacro lyskom-maybe-setq-default (var value)
  "This is a wrapper around setq-default that does nothing
if the variable is in kom-dont-read-saved-variables."
  `(cond ((eq kom-dont-read-saved-variables t) nil)
128
         ((memq ,var kom-dont-read-saved-variables) nil)
David Byers's avatar
David Byers committed
129
         (t (set-default ,var ,value))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
130
131
132
133
134
135
136

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


;;; User flags

137
138
139
140
141
142
143
144
145
146
147
148
(def-kom-var kom-show-sync-messages nil
  "**Controls display of database saving message.

When this variable is set to `t', the client will show a message in
the echo area when the LysKOM server signals that it is saving the
database. When set to `nil', no message is shown (the mode line is
changed regardless of the setting of this variable).

Values other than `t' and `nil' are reserved for future use."
  server)


149
150
151
152
(def-kom-var kom-text-links
  '((t ("\\<bug[ \t\n]+\\([0-9]+\\)\\>"
	"http://bugzilla.lysator.liu.se/show_bug.cgi?id=\\1"
	0 t)))
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
  "**Defines patterns for automatic links in the text.

This variable defines patterns to look for in text and convert to
links to URLs. The value of this variable must be an alist, where the
key (car) is a conference number and the value (cdr) is a list of link
specifications for that conference. The special value `t' for the key
indicates a list of patterns to apply in all conferences. Key values
other than positive integers and `t' are reserved for future use.

Each link specification is in turn a list \(`PATTERN' `REPLACEMENT'
`HIGHLIGHT' `IGNORE-CASE'), where `PATTERN' is a regular expression to
look for in the text, `REPLACEMENT' is used to generate a URL from the
text matching `PATTERN', `HIGHLIGHT' is the pattern group to highlight
as a URL and `IGNORE-CASE' specifies whether matching is
case-sensitive or not.

Each text is examined for each `PATTERN'. If a match is found, a URL
is created from `REPLACEMENT'. All characters except \ are copied
verbatim. The backslash character starts one of the following
sequences:

    Sequence    Meaning
    \&          Substitute the matched text
    \N          Substitute match for text matching the Nth (...)
                group in `PATTERN'
    \\          Insert one backslash.

The `HIGHLIGHT' parameter specifies which (...) group in `PATTERN'
to highlight as an URL. Use `0' to highlight the entire match.

Finally, if `IGNORE-CASE' is `t', then ignore character case while
looking for `PATTERN'. Values other than `t' and `nil' are reserved
for future use.

When a text has more than one recipient, links will be generated for
all recipients. The order in which the recipients are examined and
the priority among links that match the same text is undefined."
190
191
  server)

192

193
(defconst kom-old-farts-text-prompt-strategy
David Byers's avatar
David Byers committed
194
195
  '((kom-comment-previous . ((t   . lyskom-get-previous-text)
			     (nil . lyskom-get-previous-text)))
David Byers's avatar
David Byers committed
196
197
198
199
    (kom-view-previous-commented-text . ((t   . lyskom-get-previous-text)
                                         (nil . lyskom-get-previous-text)))
    (kom-private-answer-previous . ((t   . lyskom-get-previous-text)
                                    (nil . lyskom-get-previous-text)))
David Byers's avatar
David Byers committed
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
    (t . ((t   . lyskom-get-last-read-text)
	  (nil . lyskom-get-last-read-text)
	  (0   . lyskom-get-text-at-point)
	  (-     lyskom-get-text-above-point (lambda (&optional args) 1))
	  (listp . lyskom-prompt-for-text-no)
	  (lyskom-plusp . lyskom-get-explicit-text)
	  (lyskom-minusp  lyskom-get-text-above-point abs))))
"Put in your `kom-pick-text-no-strategy-alist' to get the 0.46 behaviour:
 * No prefix argument refers to the most recently read text.
 * The prefix argument zero refers to the text under point.
 * A positive prefix argument is interpreted as a text-no.
 * A negative prefix argument will try to find the text-no
   of the text `arg' messages above point from the current
   kom buffer.")

215
216
217
218
(defconst lyskom-old-farts-text-prompt-strategy
  kom-old-farts-text-prompt-strategy
  "Obsolete: Alias for kom-old-farts-text-prompt-strategy.")

David Byers's avatar
David Byers committed
219
(def-kom-var kom-pick-text-no-strategy-alist
David Byers's avatar
David Byers committed
220
221
  '((kom-comment-previous . ((t   . lyskom-get-previous-text)
                             (nil . lyskom-get-previous-text)))
David Byers's avatar
David Byers committed
222
223
    (kom-view-previous-commented-text . ((t   . lyskom-get-previous-text)
                                         (nil . lyskom-get-previous-text)))
David Byers's avatar
David Byers committed
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
    (kom-private-answer-previous . ((t   . lyskom-get-previous-text)
                                    (nil . lyskom-get-previous-text)))
    (t . ((t   . lyskom-get-text-at-point) ; default for prompts
          (nil . lyskom-get-text-at-point) ; no prefix arg
          (0   . lyskom-prompt-for-text-no)
          (-     lyskom-get-text-above-point (lambda (&optional arg) 1))
          (listp lyskom-get-text-at-point-ancestor
                 (lambda (arg) (/ (logb (car arg)) 2)))
          (lyskom-plusp . lyskom-get-text-below-point)
          (lyskom-minusp  lyskom-get-text-above-point abs))))
  "**Defines how prefix arguments are used by commands to find a text to operate on.

The keys \(cars) of the list are either one of the functions that
invoke `lyskom-read-text-no-prefix-arg' or the value `t' for the
strategy common to all such functions. For functions in the list, the
strategy is chosen from the cdr of that entry and, if and when no
matching rule was found that way, from the common strategy.

Each value \(cdr) of the list is an alist specifying how to do when
mapping a prefix argument to a text number.

The keys \(cars) of this alist are the predicates for which the values
\(cdrs) map functions that retrieve the text number to operate on.
Each predicate is tested in turn on the prefix argument, and when one
returns non-nil, the cdr gets invoked. This process is repeated until
all predicates have been tested or a cdr returned a non-nil value,
whichever comes first. If you like, the cars can also be the actual
prefix-arg values (-, 0 or nil, for example) that you want to invoke
some special rule for. The value `t' means that the behaviour given by
the cdr stipulates the default value for the prompt, when one is
shown.
David Byers's avatar
David Byers committed
255
256
257

The cdrs on the list may be either of:

David Byers's avatar
David Byers committed
258
259
260
261
262
263
264
265
* a function, in which case it gets called with four parameters: the
  prefix argument, the `PROMPT' that would be used to ask the user for a
  text number, a (possibly nil) `DEFAULT' choice for that prompt, and a
  `CONSTRAINT' value, all as provided in the call to
  `lyskom-read-text-no-prefix-arg' (see its docs). Returning a positive
  integer means return that text number. Returning a common lyskom
  format string aborts, showing your helpful error description. A
  `nil' return value means try the next rule to get a text number.
David Byers's avatar
David Byers committed
266
267
268
269
270

* a list of two functions, optionally followed by additional list items,
  in which case the second function is called to change the prefix argument
  parameter for the first function, which is then called as above. Any extra
  items on the argument list will be appended to its argument list. Hence, a
David Byers's avatar
David Byers committed
271
272
  `\(my-get-text-no abs 17 4711)' entry would result in the following call:
  `\(funcall my-get-text-no (abs prefix-arg) prompt default nil 17 4711)'."
David Byers's avatar
David Byers committed
273
274
  )

David Byers's avatar
David Byers committed
275
(def-kom-var kom-url-transformation-rules 
276
277
278
  '(
    ("^http://[^/]*aftonbladet\\.se/.*/story/.*html?$" . "\\&.")
    )
David Byers's avatar
David Byers committed
279
280
281
282
283
284
  "**An alist specifying transformations to be applied to URLs.

Elements in this list are of the form `(PATTERN . REPLACEMENT)'.
Before an URL is opened, it is transformed by matching the URL against
each `PATTERN' in turn, and when a match is found, generating a new
URL according to `REPLACEMENT'.
David Byers's avatar
David Byers committed
285

David Byers's avatar
David Byers committed
286
287
All characters in `REPLACEMENT' except \ are copied verbatim. The
backslash character starts one of the following sequences:
David Byers's avatar
David Byers committed
288

David Byers's avatar
David Byers committed
289
290
291
292
293
294
    Sequence    Meaning
    \&          Substitute the matched text
    \N          Substitute match for text matching the Nth (...)
                group in `PATTERN'
    \\          Insert one backslash.
"
David Byers's avatar
David Byers committed
295
296
297
298
  server
  )


299
(def-kom-var kom-check-configuration-on-startup t
David Byers's avatar
David Byers committed
300
301
302
303
304
305
306
307
308
309
310
311
312
  "**When non-nil, check Emacs configuration on client startup.

Valid values for this variable are `t' and `nil'. All other values are
reserved for future extensions. When non-nil, several checks will be
performed:

* Check that multibyte character support is enabled, if available.

* Check that the character coding Emacs uses matches the coding system
  used by the server.

Warnings will be shown in the LysKOM buffer on logon.
")
313

David Byers's avatar
David Byers committed
314

315
(def-kom-var kom-keyboard-menu-immediate-selection nil
David Byers's avatar
David Byers committed
316
317
318
319
320
321
322
323
324
  "**Controls how keyboard menus work.

When displaying text-based menus (typically by pressing the `=' key
when the cursor is on an active area), there are two modes of
selection. Setting this variable to `t' means pressing the letter
corresponding to an item selects that item. When this variable is
`nil', selection has to be confirmed by pressing enter.

Values other tha `t' and `nil' are reserved for future use."
325
326
327
  server)


328
(def-kom-var kom-edit-hide-add-button nil
David Byers's avatar
David Byers committed
329
330
331
332
333
  "**Controls the \"add\" button in the edit buffer.

When set to `t', hide the add button shown after the headers when
editing a text. When set to `nil' (the default), show the button.
Values other than `t' and `nil' are reserved for future use."
334
335
336
  server
)

David Byers's avatar
David Byers committed
337
(def-kom-var kom-max-overlays 120
David Byers's avatar
David Byers committed
338
339
340
341
342
343
344
345
346
347
348
349
350
351
  "**Maximum number of overlays to use to highlight texts.

When a text is displayed with its own background color (see
`kom-highlight-text-body', `kom-highlight-first-line',
`kom-highligh-dashed-linse', `kom-async-highlight-text-body' and
`kom-async-highlight-dashed-lines') one or more overlays are created.
Since a large number of overlays has a serious impact on performance,
the total number of overlays in the buffer can be limited using this
variable.

When set to a positive integer, limit the number of overlays to that
number. When set to `nil', do not limit the number of overlays. Values
other than a positive integer and `nil' are reserved for future use
and may cause unpredictible results."
David Byers's avatar
David Byers committed
352
353
354
  server
)

355
(def-kom-var kom-highlight-text-body t
David Byers's avatar
David Byers committed
356
357
358
  "**Controls highlighting of text bodies.

If `t', overlay `kom-text-body-face' on printed text bodies in LysKOM.
David Byers's avatar
David Byers committed
359
360
When this is enabled, an overlay or extent will be created that may
override certain aspects of the underlying text's formatting. Values
David Byers's avatar
David Byers committed
361
362
363
364
other than `t' or `nil' are reserved for future use.

See `kom-max-overlays' for information on how to limit the number of
overlays."
365
366
367
  server
)

368
(def-kom-var kom-highlight-first-line t
David Byers's avatar
David Byers committed
369
370
371
372
373
374
375
376
377
  "**Controls highlighting of the first line of text headers.

If `t', overlay `kom-first-line-face' on the first header line of
texts. When this is enabled, an overlay or extent will be created that
may override certain aspects of the underlying text's formatting.
Values other than `t' or `nil' are reserved for future use.

See `kom-max-overlays' for information on how to limit the number of
overlays."
378
379
380
381
  server
)

(def-kom-var kom-highlight-dashed-lines t
David Byers's avatar
David Byers committed
382
383
384
385
386
387
388
389
390
  "**Controls highlighting of dashed lines around texts.

If `t', overlay `kom-dashed-lines-face' on the lines surrounding
texts. When this is enabled, an overlay or extent will be created that
may override certain aspects of the underlying text's formatting.
Values other than `t' or `nil' are reserved for future use.

See `kom-max-overlays' for information on how to limit the number of
overlays."
391
392
393
  server
)

394
(def-kom-var kom-async-highlight-text-body t
David Byers's avatar
David Byers committed
395
396
397
398
399
400
401
402
403
  "**Controls highlighting of asynchronous messages.

If `t', overlay `kom-async-text-body-face' on asynchronous messages in
LysKOM. When this is enabled, an overlay or extent will be created
that may override certain aspects of the underlying text's formatting.
Values other than `t' or `nil' are reserved for future use.

See `kom-max-overlays' for information on how to limit the number of
overlays."
404
405
406
407
  server
)

(def-kom-var kom-async-highlight-dashed-lines t
David Byers's avatar
David Byers committed
408
409
410
411
412
413
414
415
416
  "**Controls highlighting of dashed lines around asynchronous messages.

If `t', overlay `kom-dashed-lines-face' on the lines surrounding
messages. When this is enabled, an overlay or extent will be created
that may override certain aspects of the underlying text's formatting.
Values other than `t' or `nil' are reserved for future use.

See `kom-max-overlays' for information on how to limit the number of
overlays."
417
418
419
  server
)

David Byers's avatar
David Byers committed
420
(def-kom-var kom-extended-status-information nil
David Byers's avatar
David Byers committed
421
422
423
424
425
426
427
428
429
430
431
  "**Controls display of extra information when displaying LysKOM objects.

If `t', extended status information is listed for all objects in
LysKOM. The information controlled by this variable is the kind of
data that most users are not interested in, and, if displayed, would
make more important information hard to find.

Currently this includes read FAQs (on conferences).

Values other than `t' or `nil' are reserved for future extensions."
server )
432

David Byers's avatar
David Byers committed
433
(def-kom-var kom-auto-list-faqs t
David Byers's avatar
David Byers committed
434
435
436
437
438
439
440
441
  "**Controls automatic display of FAQs.

When this variable is set to `t', list unread FAQs when entering a
conference or logging on to the server. When entering a conference,
list FAQs for that conference that have not been read. When logging
on, list FAQs for the server that have not been read.

Values other than `t' or `nil' are reserved for future extension."
David Byers's avatar
David Byers committed
442
443
444
  server
)

445
(def-kom-var kom-auto-review-faqs t
David Byers's avatar
David Byers committed
446
447
448
449
450
451
452
453
454
  "**Controls automatic review of FAQs.

When set to `t', automatically review unread FAQs when entering a
conference or logging on to the server. When entering a conference,
FAQs that are unread for that conference will be reviewed. When
logging on, FAQs that are unread for the server will be reviewed.

Values other than `t' or `nil' are reserved for future use."

455
456
457
  server
)

David Byers's avatar
X    
David Byers committed
458
(def-kom-var kom-allow-incompleteness nil
David Byers's avatar
David Byers committed
459
460
461
462
463
464
465
466
467
468
  "**Allow or disallow operation on incomplete membership information.

If `nil', commands like `kom-list-news' will wait for all membership
information to be read. If this flag is set to `t', commands will not
wait for all membership information. Not waiting for complete
information allows certain commands to execute faster, particularly
during the login phase, but may result in incorrect or incomplete
answers.

Values other than `t' or `nil' are reserved for future use."
David Byers's avatar
X    
David Byers committed
469
470
  server
)
471

David Byers's avatar
X    
David Byers committed
472
(def-kom-var kom-bury-buffers t
David Byers's avatar
David Byers committed
473
474
475
476
477
478
479
  "**Controls the behaviour of `kom-next-kom' and its cousins.

If this variable is `t' the current buffer is sent to the back of the
buffer list when one of the commands `kom-next-kom',
`kom-previous-kom' or `kom-next-unread-kom' is invoked.

Values other than `t' or `nil' are reserved for future use."
David Byers's avatar
X    
David Byers committed
480
  server)
481

David Byers's avatar
X    
David Byers committed
482
(def-kom-var kom-write-texts-in-window nil
David Byers's avatar
David Byers committed
483
  "**Determines where to edit texts.
David Byers's avatar
David Byers committed
484

David Byers's avatar
David Byers committed
485
486
487
488
489
490
491
492
493
494
The value must be one of `nil', `other', `new-frame', `other-frame', a
string or a buffer.

When set to `nil', edit texts in the same window as the LysKOM buffer.
When set to `other', edit in another window, creating it if necessary.
When set to `other-frame', edit in another frame, if there is one
\(otherwise edit in the same window as the LysKOM buffer). When set to
`new-frame', create a new frame for editing. This frame will be
removed when editing is finished. A string means edit in the buffer
with that name. A buffer means edit in that buffer."
David Byers's avatar
X    
David Byers committed
495
  server)
496

David Byers's avatar
X    
David Byers committed
497
(def-kom-var kom-view-commented-in-window 'other
David Byers's avatar
David Byers committed
498
499
500
  "**Where to view commented texts. 

See the documentation for `kom-write-texts-in-window' for details."
David Byers's avatar
X    
David Byers committed
501
  server)
David Byers's avatar
David Byers committed
502

David Byers's avatar
X    
David Byers committed
503
(def-kom-var kom-edit-filters-in-window nil
David Byers's avatar
David Byers committed
504
505
506
  "**Where to edit filters with `kom-filter-edit'.

See the documentation for `kom-write-texts-in-window' for details."
David Byers's avatar
X    
David Byers committed
507
  server)
David Byers's avatar
David Byers committed
508

David Byers's avatar
X    
David Byers committed
509
(def-kom-var kom-list-membership-in-window 'other
David Byers's avatar
David Byers committed
510
511
512
  "**Where to list membership with `kom-list-membership'.

See the documentation for `kom-write-texts-in-window' for details."
David Byers's avatar
X    
David Byers committed
513
  server)
514

515
(def-kom-var kom-personal-messages-in-window 'other
David Byers's avatar
David Byers committed
516
517
518
  "**Where to display personal messages. 

See the documentation for `kom-write-texts-in-window' for details."
519
520
  server)

David Byers's avatar
X    
David Byers committed
521
(def-kom-var kom-customize-format 'long
David Byers's avatar
David Byers committed
522
523
524
525
526
527
528
529
  "**Determines the format of the customize buffer.

This variable currently only controls initial display of documentation
in the customize buffer (the buffer shown by `kom-customize'. When set
to the symbol `long', display documentation. When set to the symbol
`short', don't display documentation.

Values other than `long' or `short' are reserved for future use."
David Byers's avatar
X    
David Byers committed
530
  server)
531

David Byers's avatar
X    
David Byers committed
532
(def-kom-var kom-user-prompt-format "%[%c% %m%] - "
David Byers's avatar
David Byers committed
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
  "**Format of LysKOM prompt when waiting for input.

The value of this variable must be a string, which is displayed as the
LysKOM prompt, while waiting for a command. The string may contain the
following special sequences:

    Sequence    Meaning
    %c          Inserts the current default command.
    %[          Inserts `[' if the ansaphone is on.
    %]          Inserts `]' is the ansaphone is on.
    %m          Inserts information about recorded messages.
    %s          Inserts the name of the LysKOM system
    %S          Inserts the server name.
    %p          Inserts the name of the user currently logged on.
    %w          Inserts the name of the current conference.
    %a          Inserts `anonymous' in the current language.
    %A          Inserts `Anonymous' in the current language.
    %#          Inserts the current session number.
    %           Inserts a space if it seems necessary (percent SPC).
    %%          Inserts a percent sign.

Here are a few examples:

    \"%[%c% %m%] - \"             The default prompt
    \"%[%s: %c% %m%] - \"         Could display \"LysKOM: Time - \"

Note that multiline prompts are not supported."
David Byers's avatar
X    
David Byers committed
560
  server)
David Byers's avatar
David Byers committed
561

Per Cederqvist's avatar
.    
Per Cederqvist committed
562

David Byers's avatar
X    
David Byers committed
563
(def-kom-var kom-user-prompt-format-executing "%[%c% %m%]."
David Byers's avatar
David Byers committed
564
565
566
567
  "**Format of LysKOM prompt when executing a default command.

The value of this variable must be a string. See
`kom-user-prompt-format' for details."
David Byers's avatar
X    
David Byers committed
568
  server)
David Byers's avatar
David Byers committed
569
570


David Byers's avatar
X    
David Byers committed
571
(def-kom-var kom-enabled-prompt-format "%[%c% %m%] # "
David Byers's avatar
David Byers committed
572
573
574
575
  "**Format of LysKOM prompt when privileges are enabled..

The value of this variable must be a string. See
`kom-user-prompt-format' for details."
David Byers's avatar
X    
David Byers committed
576
  server)
David Byers's avatar
David Byers committed
577

578

David Byers's avatar
X    
David Byers committed
579
(def-kom-var kom-enabled-prompt-format-executing "%[%c% %m%]."
David Byers's avatar
David Byers committed
580
  "**Format of LysKOM prompt when executing a default command when
David Byers's avatar
David Byers committed
581
582
583
584
privileges are enabled. 

The value of this variable must be a string. See
`kom-user-prompt-format' for details."
David Byers's avatar
X    
David Byers committed
585
  server)
David Byers's avatar
David Byers committed
586

David Byers's avatar
David Byers committed
587
(def-kom-var kom-anonymous-prompt-format "%[%c% %m%] (%a) - "
David Byers's avatar
David Byers committed
588
589
590
591
592
593
  "**Format of the LysKOM prompt when running anonymously.

The value of this variable must be a string. See
`kom-user-prompt-format' for details. See `kom-become-anonymous' for
information on anonymous mode.
"
David Byers's avatar
David Byers committed
594
595
596
  server)

(def-kom-var kom-anonymous-prompt-format-executing "%[%c% %m%] (%a)."
David Byers's avatar
David Byers committed
597
598
599
600
601
  "**Format of the LysKOM prompt when executing a command anonymously.

The value of this variable must be a string. See
`kom-user-prompt-format' for details. See `kom-become-anonymous' for
information on anonymous mode."
David Byers's avatar
David Byers committed
602
603
  server)

604
(def-kom-var kom-show-week-number t
David Byers's avatar
David Byers committed
605
606
607
608
609
610
611
  "**Controls display of week numbers in `kom-display-time'.

If set to `t' show the ISO week number when displaying the time. If
set to `nil', don't display the time. All other values are reserved
for future use.

For this feature to work, the calendar package must be installed."
612
613
  server)

David Byers's avatar
David Byers committed
614

David Byers's avatar
X    
David Byers committed
615
(def-kom-var kom-cite-string ">"
David Byers's avatar
David Byers committed
616
617
618
619
620
  "**String to insert before each line of a commented text.

When citing a text in edit-mode, this string will be inserted before
each line. Although citing is not common and usually not useful in
LysKOM, there is occasionally reason to cite a commented text."
David Byers's avatar
X    
David Byers committed
621
  server)
622

623
(def-kom-var kom-created-texts-are-saved nil
David Byers's avatar
David Byers committed
624
625
626
627
628
629
  "**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. Each time a text is created, it is appended to this file.
Values other than a string may produce unpredictible results, and are
reserved for future extensions."
630
631
632
  server
  inherited)

633
(def-kom-var kom-created-texts-are-read nil
David Byers's avatar
David Byers committed
634
635
636
637
638
639
640
  "**Non-`nil' means automatically mark texts that you create as read.

When set to `t', all text you write are automatically marked as read,
except when running in anonymous mode. When set to `nil', your texts
will be shown as all others.

Values other than `t' and `nil' are reserved for future extensions."
David Byers's avatar
X    
David Byers committed
641
  server)
David Byers's avatar
David Byers committed
642

643
(def-kom-var kom-mark-read-texts-as-read-in-new-recipient t
David Byers's avatar
David Byers committed
644
645
646
647
648
649
650
651
652
  "**Controls whether to mark read texts as read in new recipients the acquire.

When this is set to `t', silently mark texts as read when they are
added to a new recipient, if they have been read in any conference.
When `nil', do not mark as read. This feature only works when you are
logged on. Texts added to new conferences while you are not logged on
will not be marked as read in the new recipient.

Values other than `t' or `nil' are reserved for future extensions."
653
654
  server)

David Byers's avatar
X    
David Byers committed
655
(def-kom-var kom-customize-in-window nil
David Byers's avatar
David Byers committed
656
657
658
  "**Where to customize LysKOM with `kom-customize'.

See the documentation for `kom-write-texts-in-window' for details."
David Byers's avatar
X    
David Byers committed
659
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
660

David Byers's avatar
X    
David Byers committed
661
(def-kom-var kom-prioritize-in-window nil
David Byers's avatar
David Byers committed
662
663
664
  "**Where to prioritize conferences with `kom-prioritize'.

See the documentation for `kom-write-texts-in-window' for details."
David Byers's avatar
X    
David Byers committed
665
  server)
David Byers's avatar
David Byers committed
666

667
(def-kom-var kom-default-mark nil
David Byers's avatar
David Byers committed
668
669
670
671
672
673
674
  "**The default mark used by `kom-mark-text'.

When set to an integer, `kom-mark-text' will not ask for a mark, but
simply mark with that number. When set to `nil', `kom-mark-text' will
ask for a mark.

Values other than integers and `nil' are reserved for future use."
David Byers's avatar
X    
David Byers committed
675
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
676

677
(def-kom-var kom-symbolic-marks-alist '(("Standard" . 100))
David Byers's avatar
David Byers committed
678
679
680
681
682
683
684
  "**Association list that maps symbolic marks to mark numbers.

Internally, texts can only be marked with numbers. The elisp client
implements symbolic marks through this mapping from mark names to
numbers. Each element of this list is a pair \(`NAME' . `MARK'), where
`NAME' is the name of the mark, and `MARK' is the corresponding
numeric mark."
685
686
  server)

David Byers's avatar
X    
David Byers committed
687
(def-kom-var kom-reading-puts-comments-in-pointers-last t
David Byers's avatar
David Byers committed
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
  "**Controls the location where comment pointers are shown.

When set to `t', comment references are shwon at the end of texts.
When set to `nil', comment references are shwon in the headers.

`kom-reading-puts-comments-in-pointers-last' set to `nil'

    398331 1996-09-24  13:22  /2 lines/ George Berkeley
    Recipient: Philosophy <1226>
    Comment in text 398374 by John Locke
    Subject: 
    ------------------------------------------------------------
    An abstract idea is a contradiction in terms.
    (398331) -----------------------------------

`kom-reading-puts-comments-in-pointers-last' set to `t'

    398331 1996-09-24  13:22  /2 lines/ George Berkeley
    Recipient: Philosophy <1226>
    Subject: 
    ------------------------------------------------------------
    An abstract idea is a contradiction in terms.
    (398331) -----------------------------------
    Comment in text 398374 by John Locke
"
David Byers's avatar
David Byers committed
713
714
  server
  inherited)
David Byers's avatar
David Byers committed
715

716
(def-kom-var kom-review-uses-cache t
David Byers's avatar
David Byers committed
717
718
719
720
721
722
723
724
  "**Controls whether review commands use the cache or not.

When set to `t', review commands (such as `kom-review-by-to') will get
texts from the client cache, if possible. This improves performance,
but texts may have changed since they were cached. When set to `nil',
review commands will always get texts from the server.

Values other than `t' and `nil' are reserved for future use."
725
726
727
  server
  inherited)

728
(def-kom-var kom-review-marks-texts-as-read nil
David Byers's avatar
David Byers committed
729
730
731
732
733
734
735
736
737
738
739
740
  "**Controls whether viewing texts with review commands marks then as read.

When set to `t', viewing texts with review commands (e.g.
`kom-review-by-to') will mark unread texts as read. When set to `nil',
texts are not marked as read. 

It is possible to change this setting for a single review command with
the key sequence for `kom-toggle-mark-as-read-prefix'. The value can
be changed for the entire session by using
`kom-make-review-mark-as-read' or `kom-make-review-not-mark-as-read'.

Values other than `t' and `nil' are reserved for future use."
741
742
743
  server
  inherited)

David Byers's avatar
David Byers committed
744
(def-kom-var kom-postpone-default 17
David Byers's avatar
David Byers committed
745
746
747
748
  "**The default number of texts to postpone with `kom-postpone'.

The value of this variable must be a positive integer or zero. All
other values are reserved for future use."
David Byers's avatar
David Byers committed
749
750
751
  server)


David Byers's avatar
X    
David Byers committed
752
(def-kom-var kom-dashed-lines t
David Byers's avatar
David Byers committed
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
  "**Controls display of dashed lines before and after texts.

when set to `t' display dashed lines. When set to `nil', don't display
dashed lines.

`kom-dashed-lines' set to `t'

    892343 1996-09-24  19:21  /2 lines/ Tycho Brahe
    Recipien: Presentation (of new) Members
    Subject: Tycho Brahe
    ------------------------------------------------------------
    Astronomer and discoverer of stars resident on the island of Ven.
    (892343) -----------------------------------

`kom-dashed-lines' set to `nil'

    892343 1996-09-24  19:21  /2 lines/ Tycho Brahe
    Recipien: Presentation (of new) Members
    Subject: Tycho Brahe

    Astronomer and discoverer of stars resident on the island of Ven.
    (892343)

Values other than `t' and `nil' are reserved for future use. 

See `kom-highlight-dashed-lines' and
`kom-async-highlight-dashed-lines' for additional settings that affect
these lines."
David Byers's avatar
David Byers committed
781
782
  server
  inherited)
Per Cederqvist's avatar
.    
Per Cederqvist committed
783

784
(def-kom-var kom-long-lines nil
David Byers's avatar
David Byers committed
785
786
787
788
789
790
791
  "**If non-`nil', some lines and borders will be made longer.

When set to `t', most dashed lines will be longer than the default.
When set to `nil',  use the standard length.

See `kom-text-footer-dash-length', `kom-text-header-dash-length' and
`kom-footer-format' for other related settings."
792
793
794
795
  server
  inherited)

(def-kom-var kom-text-footer-dash-length 52
David Byers's avatar
David Byers committed
796
797
798
799
800
801
802
  "**Control the length of the text footer.

When dashed lines (see `kom-dashed-lines') are in effect, and this is
set to a positive integer, make the text footer at least that many
characters long. Values other than a positive integer are reserved for
future use.

803
804
805
Note that the footer may end up longer than this if one or more elements
together are longer than this length.

David Byers's avatar
David Byers committed
806
This length is currently ignored when `kom-text-footer-format' is used."
807
808
809
810
  server
  inherited)

(def-kom-var kom-text-header-dash-length 60
David Byers's avatar
David Byers committed
811
812
813
814
815
816
817
  "**Control the length of the text footer.

When dashed lines (see `kom-dashed-lines') are in effect, and this is
set to a positive integer, make the dashed line before the text that
many characters long. 

Values other than a positive integer are reserved for future use."
818
819
820
821
822
  server
  inherited)



823
(def-kom-var kom-text-footer-format nil
David Byers's avatar
David Byers committed
824
  "**Defines the format of the text footer.
825

David Byers's avatar
David Byers committed
826
827
828
When set to a string, use that string as the text footer, overriding
all other settings that affect the text footer. The string may contain
the following special sequences:
829

David Byers's avatar
David Byers committed
830
831
832
833
834
835
    Directive   Meaning
    %n          Insert the text number
    %p          Insert the number of the author
    %P          Insert the name of the author
    %-          Insert a bunch of dashes
    %f          Insert special formatting information
836

David Byers's avatar
David Byers committed
837
838
839
840
841
Format directives can be prefixed with a number specifying the minimum
field width (e.g. `%20-'. The field width can be prefixed with an
equals sign (e.g. `%=20p' which means that the field is exactly as
wide as specified (contents may be truncated). A negative field width
means left justify the contents.
842
843

The field width of %- is special. It specifies the maximum number of
David Byers's avatar
David Byers committed
844
845
dashes printed. The actual number will be the maximum minus the length
of the author's name, if it is included anywhere in the format string.
846

David Byers's avatar
David Byers committed
847
848
When set, this variable overrides `kom-dashed-lines' and
`kom-show-author-at-end'.
849
850
851
852

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

David Byers's avatar
David Byers committed
853
854
855
856
857
`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\"
858
859
860
861
862
863
"
  server
  inherited)



864
(def-kom-var kom-show-creating-software nil
David Byers's avatar
David Byers committed
865
866
867
868
869
870
871
872
873
874
875
  "**Controls display of the software used to create each text.

When creating a text, it is possible to attach information about which
client was used to create the text. When this variable is set to `t',
this information, when available,  is displayed in all text headers.
When this variable is set to `nil', the information is not shown.

To display creating software for a text when this is off, review the
text using `kom-review-noconversion'.

Values other than `t' and `nil' are reserved for future use."
876
877
878
  server
  inherited)

David Byers's avatar
David Byers committed
879
(def-kom-var kom-show-author-at-end t
David Byers's avatar
David Byers committed
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
  "**Controls display of author information in the text footer.

When this is set to `t', display the author of each text immediately
after the text. When set to `nil', the author is not displayed.

`kom-show-author-at-end' set to `t' (with dashed lines on):

  892342 1996-09-24  19:21  /2 lines/ Claude Shannon
  Mottagare: Presentation (of new) Members
  Ärende: Claude Shannon
  ------------------------------------------------------------
  Information theoretician
  (892342) /Claude Shannon/------------------------------

`kom-show-author-at-end' set to `nil':

  892342 1996-09-24  19:21  /2 lines/ Claude Shannon
  Recipient: Presentation (of new) Members
  Subject: Claude Shannon
  ------------------------------------------------------------
  Information theoretician
  (892342) -----------------------------------

If `kom-text-footer-format' is set, the value of this variable is
ignored. Values other than `t' and `nil' are reserved for future use."
David Byers's avatar
David Byers committed
905
906
  server
  inherited)
David Byers's avatar
David Byers committed
907

908
(def-kom-var kom-truncate-threshold nil
David Byers's avatar
David Byers committed
909
910
911
912
913
914
915
916
917
918
919
  "**Controls truncation of text when reviewing.

When set to a positive integer, truncate long texts when reviewing. If
the text has more lines than the value of this variable, it will be
truncated to `kom-truncate-show-lines' lines. When a message is
truncated, a note to that effect will be shown in the message footer
unless `kom-text-footer-format' has been set to a string that does not
include the `%f' directive.

When set to `nil', no truncation will occur. Values other than
positive integers and `nil' are reserved for future use."
920
921
  server)

922
(def-kom-var kom-truncate-show-lines 10
David Byers's avatar
David Byers committed
923
924
925
926
927
928
929
  "**Number of lines to display when truncating texts.

The value must be a positive integer. When a text is truncated \(see
`kom-truncate-threshold', the minimum of `kom-truncate-threshold' and
`kom-truncate-show-lines' determines the number of lines to show.

Values other than positive integers are reserved for future use."
930
931
932
  server)


David Byers's avatar
X    
David Byers committed
933
(def-kom-var kom-print-number-of-unread-on-entrance t
David Byers's avatar
David Byers committed
934
935
936
937
938
939
940
941
942
  "**Controls display of number of unread when entering a conference.

When set to `t', the number of unread texts in a conference is
displayed when entering that conference. When set to `nil', the number
of unread texts is not shown. Shortly after logging on, using
`kom-set-unread' or using `kom-recover', the number shown may be
incorrect.

Values other than `t' and `nil' are reserved for future use."
David Byers's avatar
X    
David Byers committed
943
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
944

945
(def-kom-var kom-show-unread-in-frame-title t
David Byers's avatar
David Byers committed
946
947
948
949
950
951
952
  "**Controls display of the unread indicator in the frame title.

When set to `t', an indicator will be shown in the title of each frame
containing a selected LysKOM session with unread texts. When set to
`nil' no indicator will be shown.

Values other than `t' and `nil' are reserved for future extensions."
953
954
  server)

David Byers's avatar
David Byers committed
955
956
957
958
959
960
961
962
963
964
965
;; In the common block of the user-area is a simple boolean variable
;; `presence-messages'.  The control of presence messages in the Emacs
;; Lisp client is more advanced, using two non-boolean variables instead
;; (`kom-presence-messages-in-echo' and `kom-presence-messages-in-buffer').
;;
;; Keep track of the common block variable too, although it isn't used here.
;; `lyskom-save-options' sets it before saving it in obvious cases,
;; but generally it's not possible to know what value it should have.
;; (It could also be used for default values for the presence options for
;; users converting from another client, but that isn't done.)

David Byers's avatar
X    
David Byers committed
966
(def-kom-var kom-presence-messages t
David Byers's avatar
David Byers committed
967
968
969
970
971
972
973
974
975
  "Equivalent of the variable `presence-messages' in the user-area.
This is a boolean where other clients may store whether the user wants
messages about people logging in and out of LysKOM.  Here this is instead
controlled by `kom-presence-messages-in-echo-area' and
`kom-presence-messages-in-buffer', so only use this variable to
influence what this client stores in the common block of the user-area."
  server)

(def-kom-var kom-presence-messages-in-echo-area t
David Byers's avatar
David Byers committed
976
977
978
979
980
  "**Controls display of presence messages in the echo area.

If non-`nil', LysKOM prints continuous info about what other people
are doing. Info is printed on the echo area and never in the buffer.
If minibuffer is used, no message is printed.
Linus Tolke's avatar
Linus Tolke committed
981

David Byers's avatar
David Byers committed
982
983
A list of integers means show messages for those users.

David Byers's avatar
David Byers committed
984
985
986
The value `friends' means show messages for the users in `kom-friends'.

The value `morons' means show messages for the users in `kom-morons'.
David Byers's avatar
David Byers committed
987

David Byers's avatar
David Byers committed
988
989
The value `friends-and-morons' means show messages for the users in 
`kom-friends' and `kom-morons'.
990

David Byers's avatar
David Byers committed
991
992
If you want the messages in the buffer, set the variable 
`kom-presence-messages-in-buffer'.
993

David Byers's avatar
David Byers committed
994
Values other than those listed are reserved for future use."
David Byers's avatar
X    
David Byers committed
995
  server)
David Byers's avatar
David Byers committed
996

David Byers's avatar
David Byers committed
997
998


David Byers's avatar
X    
David Byers committed
999
(def-kom-var kom-presence-messages-in-buffer nil
David Byers's avatar
David Byers committed
1000
  "**Controls display of presence messages in the LysKOM buffer.
David Byers's avatar
David Byers committed
1001

David Byers's avatar
David Byers committed
1002
1003
1004
1005
1006
1007
1008
1009
If non-`nil', LysKOM prints information about what other people are
doing in the LysKOM buffer. All printing is done just before the
prompt.

If `nil' no messages are printed. If `presence', messages about people
logging in, out and people changing name are printed.

All other values are reserved for future use."
David Byers's avatar
X    
David Byers committed
1010
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1011

David Byers's avatar
X    
David Byers committed
1012
(def-kom-var kom-show-where-and-what t
David Byers's avatar
David Byers committed
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
  "**Controls display of hostname and activity information in `kom-who-is-on'. 

When this is set to `t', `kom-who-is-on' and related commands will
display the machine the session is connected from and what the user is
doing. When set to `nil', this information will not be shwon.

Listing frmo `kom-who-is-on' with `kom-show-where-and-what' set to `t':

      User                                   Is in conference             
      At                                     Activity                        
  --------------------------------------------------------------------------
   6810 George Berkeley                      Philosophy                     
        berkeley@emp1.tcd.ie                 (Writing a comment.)           
   7571 John Locke                           Philosophy                     
        eridy@cc.ox.ac.uk                    (Waiting.)                     
  --------------------------------------------------------------------------

Listing frmo `kom-who-is-on' with `kom-show-where-and-what' set to `nil':

      User                                   Is in conference             
  --------------------------------------------------------------------------
   6810 George Berkeley                      Philosophy                     
   7571 John Locke                           Philosophy
  --------------------------------------------------------------------------

Values other than `t' and `nil' are reserved for future use."
David Byers's avatar
X    
David Byers committed
1039
  server)
David Byers's avatar
David Byers committed
1040

1041
(def-kom-var kom-show-since-and-when nil
David Byers's avatar
David Byers committed
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
  "**Controls display of connection time in `kom-who-is-on'.

When set to `t', `kom-who-is-on' and related commands will display the
time when each session connected to the server and when each session
last indicated activity.

Listing frmo `kom-who-is-on' with `kom-show-since-and-when' set to `t':

        User                                 Is in conference             
        Connected                            Active last                  
  --------------------------------------------------------------------------
   6810 George Berkeley                      Philosophy                     
        Thursday 2003-01-09 09:24:56         Active                         
   7571 John Locke                           Philosophy                     
        Saturday 2003-01-11 14:02:47         12 minutes                     
  --------------------------------------------------------------------------


Listing frmo `kom-who-is-on' with `kom-show-since-and-when' set to `nil':

        User                                 Is in conference             
  --------------------------------------------------------------------------
   6810 George Berkeley                      Philosophy                     
   7571 John Locke                           Philosophy
  --------------------------------------------------------------------------

Values other than `t' and `nil' are reserved for future use."
1069
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1070

David Byers's avatar
X    
David Byers committed
1071
(def-kom-var kom-idle-hide 30
David Byers's avatar
David Byers committed
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
  "**Controls display of idle sessions in `kom-who-is-on'.

When set to a positive integer, the number of minutes of idletime
before a user is excluded from the list of users shown by
`kom-who-is-on' and related commands. This can be overridden by a
prefix argument to these commands. When set to `nil', do not hide idle
sessions.

Variables other than positive integers and `nil' are reserved for
future use."
David Byers's avatar
X    
David Byers committed
1082
  server)
1083

David Byers's avatar
X    
David Byers committed
1084
(def-kom-var kom-show-footnotes-immediately t
David Byers's avatar
David Byers committed
1085
1086
1087
1088
1089
1090
1091
  "**Controls display of footnotes.

When set to `t', footnotes will be displayed immediately following the
text. When set to `nil', footnotes will be displayed like regular
comments.

Values other than t and `nil' are reserved for future use."
David Byers's avatar
X    
David Byers committed
1092
  server)
1093

David Byers's avatar
X    
David Byers committed
1094
(def-kom-var kom-follow-comments-outside-membership nil
David Byers's avatar
David Byers committed
1095
1096
1097
1098
1099
1100
1101
  "**Controls display of comments in conferences you are not a member of.

If this variable is set to `nil', texts with no recipient you are a
member of will be ignored when selecting comments to display when
reading. When set to `t', the client will follow comment links
regardless of whether you are a member of any of the recipients of the
comment.
1102

David Byers's avatar
David Byers committed
1103
Values other than `t' and `nil' are reserved for future use."
David Byers's avatar
X    
David Byers committed
1104
  server)
1105

David Byers's avatar
David Byers committed
1106
(def-kom-var kom-follow-attachments t
David Byers's avatar
David Byers committed
1107
1108
1109
1110
1111
  "**Controls how attachments to imported e-mail messages are handled.

When this is set to `t', attachments are followed like regular
comments. When set to `nil', attachments are not followed. To see them
you have to review them manually.
David Byers's avatar
David Byers committed
1112

David Byers's avatar
David Byers committed
1113
1114
Values other than `t' and `nil' are reserved for future use."
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1115

David Byers's avatar
X    
David Byers committed
1116
(def-kom-var kom-read-depth-first t
David Byers's avatar
David Byers committed
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
  "**Determines the order in which to read texts.

When set to `t' \(the default), texts are read in comment order. When
set to `nil', texts are read in chronological order.

When reading in comment order, the next text to read is the first
comment of the most recently read text. If there are no comments, the
next text is a comment to another text. Reading in comment order lets
you view threads of discussion.

Values other than `t' or `nil' are reserved for future use."
David Byers's avatar
X    
David Byers committed
1128
  server)
David Byers's avatar
David Byers committed
1129

David Byers's avatar
X    
David Byers committed
1130
(def-kom-var kom-continuous-scrolling t
David Byers's avatar
David Byers committed
1131
  "**Controls frequency of scrolling.
1132

David Byers's avatar
David Byers committed
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
When set to `t', the LysKOM buffer is scrolled whenever text is
inserted. The last viewed position \(usually the most recent prompt)
will always be visible.

When set to `nil', scrolling takes place less frequently. This is
a suitable setting when running Emacs over a slow link, such as an old
modem.

Values other than `t' and `nil' are reserved for future use."
  server)
1143

David Byers's avatar
X    
David Byers committed
1144
(def-kom-var kom-deferred-printing t
David Byers's avatar
David Byers committed
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
  "**Controls background display of non-cached information.

When set to `t', delay display of \(some) information that has to be
retreived from the server. A placeholder is shown where the
information will be printed, until it is available. This setting
results in a significant improvement in interactive performance.

When set to `nil', do not delay display of any information. This
lowers interactive performance, but may be suitable when running Emacs
over a slow connection.

Values other than `t' and `nil' are reserved for future use."
1157
  server)
1158

David Byers's avatar
David Byers committed
1159
1160
1161
1162
(def-kom-var lyskom-overlay-pool nil  
  "Pool of overlays"
  local)

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

1166
(def-kom-var kom-review-priority nil
David Byers's avatar
David Byers committed
1167
  "**Priority to use when reviewing texts.
1168

David Byers's avatar
David Byers committed
1169
1170
1171
1172
When set to a positive integer, use that as the priority to use when
reviewing texts. By setting `kom-review-priority' higher than 255 (the
maximum conference priority), new texts to conferences will not break
in while reviewing.
1173

David Byers's avatar
David Byers committed
1174
1175
1176
1177
If set to `nil', use the current priority while reviewing. This allows
texts to conferences with priorities higher than that of the current
conference to break in while reviewing (depending on the setting of
`kom-higher-priority-breaks').
1178

David Byers's avatar
David Byers committed
1179
1180
1181
Values other than positive integers and `nil' are reserved for future
use."
  server)
1182

David Byers's avatar
David Byers committed
1183
1184
(def-kom-var kom-higher-priority-breaks nil
  "**Controls how conference priorities are handled.
1185

David Byers's avatar
David Byers committed
1186
1187
1188
1189
1190
When set to `express', texts to conferences with a higher priority
than the current conferences will be shown as soon as the arrive. When
set to `t', texts to prioritized conferences will be shown after the
current comment tree. When set to `nil', prioritized conferences will
be visited when all texts in the current conference have been read.
1191

David Byers's avatar
David Byers committed
1192
1193
1194
Values other than `express', `t' and `nil' are reserved for future
use."
  server)
1195

David Byers's avatar
David Byers committed
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
(def-kom-var kom-server-priority-breaks nil
  "**Controls how server priorities are handled.

A non-`nil' value allows servers with a higher priority than the
current server to break in when new texts arrive. This can be used to
give a work-related server a higher priority than a server used for
frivolous purposes (or, indeed, the other way around).

The following settings are available:

  Value                 Meaning
  `express'             Break in immediately when there are unread
                        texts.
  `express-letters'     Break in immediately when there are unread
                        letters.
  `t'                   Break in after the current comment chain when
                        there are unread texts.
  `letters'             Break in after the current comment-chain when
                        there are unread letters.
  `after-conf'          Break in after the current conference when
                        there are unread texts.
  `after-conf-letters'  Break in after the current conference when
                        there are unread letters.
  `when-done'           Prompt the user to go to the next session with
                        unreads after everything has been read. This
                        overrides `kom-do-when-done' as long as there
                        are sessions with unread texts. 

Values other than those listed above are reserved for future use and
may result in unpredictible behavior.

See `kom-server-priority' for information on setting the server
priority."
1229
1230
  server)

David Byers's avatar
David Byers committed
1231
(def-kom-var kom-view-text-hook nil
David Byers's avatar
David Byers committed
1232
1233
1234
1235
1236
  "**Hook that is called before a text is shown. 

When the hooks are called, `kom-view-text-text' is bound to the text
mass of the text and `kom-view-text-text-stat' to the text-stat of the
text to be shown."
1237
  local-hook)
1238

David Byers's avatar
David Byers committed
1239
1240
1241
1242
1243
1244
(def-kom-var lyskom-view-text-hook nil
  "Obsolete synonym for kom-view-text-hook."
  local-hook)


(def-kom-var lyskom-send-message-hook nil
David Byers's avatar
David Byers committed
1245
  "Obsolete synonym for lyskom-send-message-hook."
David Byers's avatar
David Byers committed
1246
  local-hook)
1247

David Byers's avatar
David Byers committed
1248
(def-kom-var kom-send-message-hook '(lyskom-send-message-trim-newlines)
David Byers's avatar
David Byers committed
1249
  "**Hook that is called before a personal, group or common message is sent. 
David Byers's avatar
David Byers committed
1250

David Byers's avatar
David Byers committed
1251
1252
1253
1254
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.
David Byers's avatar
David Byers committed
1255

David Byers's avatar
David Byers committed
1256
If `lyskom-message-string' is set to nil by a hook, the message will not
1257
1258
be sent."
  local-hook)
David Byers's avatar
David Byers committed
1259

David Byers's avatar
David Byers committed
1260
(def-kom-var kom-send-message-setup-hook nil
David Byers's avatar
David Byers committed
1261
1262
1263
1264
1265
  "**Hook that is called when the minibuffer is entered to read a message.

This hook can be used to set up the minibuffer in a way suitable for
writing messages. For example, the hook might enable `auto-fill-mode'
or set up automatic resizing of the minibuffer."
1266
  local-hook)
1267

David Byers's avatar
David Byers committed
1268
(def-kom-var lyskom-send-message-setup-hook nil
David Byers's avatar
David Byers committed
1269
  "Obsolete synonym for kom-send-message-setup-hook."
David Byers's avatar
David Byers committed
1270
1271
1272
  local-hook)

(def-kom-var kom-send-message-exit-hook nil
David Byers's avatar
David Byers committed
1273
1274
1275
1276
  "**Hook that is called when the minibuffer is exited after reading a message.

Typically this hook will be used to undo the effects of
`kom-send-message-setup-hook'."
1277
  local-hook)
1278

David Byers's avatar
David Byers committed
1279
(def-kom-var lyskom-send-message-exit-hook nil
David Byers's avatar
David Byers committed
1280
  "Obsolete synonym for kom-send-message-exit-hook."
David Byers's avatar
David Byers committed
1281
1282
1283
  local-hook)

(def-kom-var kom-send-text-hook nil
David Byers's avatar
David Byers committed
1284
1285
1286
1287
1288
  "**Hook that is called before sending a text.

This hook is called before the headers are parsed, so it is possible
for the headers to be modified after this hook is called. It is also
possible that the text will not be sent at all."
1289
  local-hook)
David Byers's avatar
David Byers committed
1290

David Byers's avatar
David Byers committed
1291
(def-kom-var lyskom-send-text-hook nil
David Byers's avatar
David Byers committed
1292
  "Obsolete synonym for kom-send-text-hook."
David Byers's avatar
David Byers committed
1293
1294
1295
  local-hook)

(def-kom-var kom-after-load-hook nil
David Byers's avatar
David Byers committed
1296
1297
1298
1299
  "**Hook to run once after LysKOM is loaded.

This is similar in effect to using `eval-after-load', but is
independent of the file name of the client.")
David Byers's avatar
David Byers committed
1300

David Byers's avatar
David Byers committed
1301
(def-kom-var lyskom-after-load-hook nil
David Byers's avatar
David Byers committed
1302
  "Obsolete synonym for kom-after-load-hook.")
David Byers's avatar
David Byers committed
1303
1304

(def-kom-var kom-change-conf-hook nil
David Byers's avatar
David Byers committed
1305
1306
  "**Hook to run when changing conferences.

David Byers's avatar
David Byers committed
1307
The functions in this list are run with two arguments. The first is the 
David Byers's avatar
David Byers committed
1308
1309
current conference number and the second is the number of the
conference being changed to.
1310

David Byers's avatar
David Byers committed
1311
1312
This hook is run before `lyskom-current-conf' is changed, and before
any standard messages have been printed."
1313
1314
  local-hook)

David Byers's avatar
David Byers committed
1315
(def-kom-var lyskom-change-conf-hook nil
David Byers's avatar
David Byers committed
1316
  "Obsolete synonym for kom-change-conf-hook"
David Byers's avatar
David Byers committed
1317
1318
1319
  local-hook)

(def-kom-var kom-after-change-conf-hook nil
David Byers's avatar
David Byers committed
1320
1321
  "**Hook to run when changing conferences.

1322
The functions in this list are run with two arguments. The first is the 
David Byers's avatar
David Byers committed
1323
1324
current conference number and the second is the conference number
being changed to.
1325

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

David Byers's avatar
David Byers committed
1330
(def-kom-var lyskom-after-change-conf-hook nil
David Byers's avatar