vars.el.in 151 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

52
53
54
(defconst lyskom-global-variable-types
  '((boolean (read . lyskom-flag-read-boolean)
             (write . lyskom-flag-write-boolean))
55
56
    (integer (read . lyskom-flag-read-integer)
             (write . lyskom-flag-write-integer))
57
58
59
60
    (symbol-list (read . lyskom-flag-read-symbol-list)
                 (write . lyskom-flag-write-symbol-list))
    (t (read . lyskom-flag-read-from-string)
       (write . prin1-to-string))))
David Byers's avatar
David Byers committed
61

David Byers's avatar
X    
David Byers committed
62
63

(defun lyskom-protect-variable (sym) 
David Byers's avatar
David Byers committed
64
  "Protect SYM from being killed when deleting local variables."
David Byers's avatar
X    
David Byers committed
65
66
67
68
69
  (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
70
  "Define SYM as a buffer-local variable"
David Byers's avatar
X    
David Byers committed
71
72
73
  (add-to-list 'lyskom-local-variables sym))

(defun lyskom-inherited-variable (sym)
David Byers's avatar
David Byers committed
74
75
  "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
76
77
78
79
  (add-to-list 'lyskom-inherited-variable sym)
  (lyskom-protect-variable sym))

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

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

87
88
89
(defvar lyskom-have-one-login nil
  "Non-nil after the first login")

David Byers's avatar
David Byers committed
90

David Byers's avatar
David Byers committed
91
92
(def-kom-var kom-dont-read-saved-variables '(kom-dont-read-saved-variables
                                             lyskom-login-hook)
David Byers's avatar
David Byers committed
93
  "**Determines which LysKOM variables to not store in the server.
94
95
96
97
98
99
100
101
102
103

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
104

105
106
107
108
(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)
109
         ((memq ,var kom-dont-read-saved-variables) nil)
David Byers's avatar
David Byers committed
110
         (t (set ,var ,value))))
111
112
113
114
115

(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)
116
         ((memq ,var kom-dont-read-saved-variables) nil)
117
         (t (set-default ',var ,value))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
118
119
120
121
122
123
124

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


;;; User flags

125
126
127
128
129
130
131
132
133
134
135
(def-kom-var kom-auto-confirm-new-conferences nil
  "**Determines behavior of `kom-list-new-conferences' and `kom-list-new-persons'.

When this variable is set to `t', `kom-list-new-conferences' and
`kom-list-new-persons' will automatically mark all listed conferences
and persons as known. When set to `nil', these commands will ask for
confirmation before marking the listed conferences and persons as known.

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

David Byers's avatar
David Byers committed
136
137
138
139
140
141
142
143
144
(def-kom-var kom-dont-complain-about-missing-presentation nil
  "*Controls whether the client complains when you don't have
a presentation. When set to non-nil, the client will never
complain.

This variable should not be documented. Anybody asocial enough
to want this feature ought to have to work to find it."
  server)

145
146
147
148
149
150
151
152
153
154
155
156
(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)


157
158
159
160
(def-kom-var kom-text-links
  '((t ("\\<bug[ \t\n]+\\([0-9]+\\)\\>"
	"http://bugzilla.lysator.liu.se/show_bug.cgi?id=\\1"
	0 t)))
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
  "**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."
198
199
  server)

200

201
(def-kom-var lyskom-default-conference-strategy
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
  '((kom-delete-conf (what-conf-to-delete
                      (default . (lyskom-default-conference-empty))))

    (kom-sub-self (leave-what-conf
                   (filter . (lyskom-default-conference-not-self))))

    (kom-change-priority (what-to-change-pres-you
                          (default . (lyskom-default-conference-at-point
                                      lyskom-default-conference-self))))

    (kom-change-presentation (what-to-change-pres-you
                              (default . (lyskom-default-conference-at-point
                                          lyskom-default-conference-self))))

    (kom-change-conf-motd (who-to-put-motd-for
                           (default . (lyskom-default-conference-at-point
                                       lyskom-default-conference-self))))

220
    (kom-set-presentation (what-to-set-pres-you
221
222
223
                           (default . (lyskom-default-conference-at-point
                                       lyskom-default-conference-self))))

224
    (kom-set-motd-text (what-to-set-motd-you
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
                        (default . (lyskom-default-conference-at-point
                                    lyskom-default-conference-self))))

    (kom-remove-presentation (who-to-remove-pres-for
                              (default . (lyskom-default-conference-at-point
                                          lyskom-default-conference-self))))

    (kom-unset-conf-motd (who-to-remove-motd-for
                          (default . (lyskom-default-conference-at-point
                                      lyskom-default-conference-self))))

    (kom-go-to-conf (go-to-conf-p
                     (default . (lyskom-default-conference-at-point
                                 lyskom-default-conference-self))
                     (filter . (lyskom-default-conference-not-current))))

    (kom-list-created-conferences (list-confs-created-by
                                   (default . (lyskom-default-conference-at-point
                                               lyskom-default-conference-self))))

    (kom-change-name (name-to-be-changed
                      (default . (lyskom-default-conference-at-point
                                  lyskom-default-conference-self))))

    (kom-change-parenthesis (name-to-be-changed
                             (default . (lyskom-default-conference-at-point
                                         lyskom-default-conference-self))))

    (kom-change-password (whos-passwd
                          (default . (lyskom-default-conference-at-point
                                      lyskom-default-conference-self))))

    (kom-redirect-comments (redirect-for-whom
                            (default . (lyskom-default-conference-at-point
                                        lyskom-default-conference-self)))
                           (redirect-to-which-conf))

    (kom-filter-author (filter-author
                        (default . (lyskom-default-conference-at-point
                                    lyskom-default-conference-last-author))
                        (filter . (lyskom-default-conference-not-self)))
                       (filter-in-conf
                        (filter . (lyskom-default-conference-not-self))))


    (kom-review-by-to (info-by-whom
                       (default . (lyskom-default-conference-at-point
                                   lyskom-default-conference-empty)))
                      (info-to-conf))

    (kom-review-first (info-by-whom
                       (default . (lyskom-default-conference-at-point
                                   lyskom-default-conference-empty)))
                      (info-to-conf))

    (kom-review-all (info-by-whom
                     (default . (lyskom-default-conference-at-point
                                 lyskom-default-conference-empty)))
                    (info-to-conf))

    (kom-unread-by-to (info-by-whom
                       (default . (lyskom-default-conference-at-point
                                   lyskom-default-conference-empty)))
                      (info-to-conf))

    (kom-unread-first (info-by-whom
                      (default . (lyskom-default-conference-at-point
                                  lyskom-default-conference-empty)))
                      (info-to-conf))

    (kom-unread-all (info-by-whom 
                     (default . (lyskom-default-conference-at-point
                                 lyskom-default-conference-empty)))
                    (info-to-conf))

300
301
302
303
    (kom-set-permitted-submitters (conf-to-set-permitted-submitters-q)
                                  (new-permitted-submitters-q
                                   (default . (lyskom-default-conference-empty))))

304
305
306
307
308
    (lyskom (what-is-your-name 
             (default . (lyskom-default-conference-empty))))


    ;; Things I suspect to magical stuff
309
    ;; -- lyskom-add-helper
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364

    (kom-add-recipient (who-to-add-q))
    (kom-add-copy (who-to-add-copy-q))
    (kom-add-bcc (who-to-add-bcc-q))
    (kom-sub-recipient (who-to-sub-q))
    (kom-send-message (who-to-send-message-to))
    (kom-move-text (who-to-move-from-q) (who-to-move-to-q))
    (kom-move-text-tree (who-to-move-from-q) (who-to-move-to-q)
                        (who-to-move-to-or-sub-q))


    ;; Defaults and commands that use the defaults

    (kom-review-presentation (presentation-for-whom))
    (kom-unread-presentation (unread-presentation-for-whom))
    (kom-add-member (who-to-add) (where-to-add))
    (kom-add-self (where-to-add-self))
    (kom-change-priority (change-priority-for-q))
    (kom-sub-member (who-to-exclude) (where-from-exclude))
    (kom-write-text (who-send-text-to))
    (kom-send-letter (who-letter-to))
    (kom-change-supervisor (what-to-change-supervisor-for) (new-supervisor))
    (kom-who-is-on-in-conference (who-is-on-in-what-conference))
    (kom-who-is-present-in-conference (who-is-present-in-what-conference))
    (kom-add-cross-reference (which-conf-to-xref) (which-pers-to-xref))
    (kom-edit-add-cross-reference (which-conf-to-xref) (which-pers-to-xref))
    (kom-edit-insert-link (which-conf-to-link) (which-pers-to-link))
    (kom-status-conf (conf-for-status))
    (kom-status-person (pers-for-status))
    (kom-set-garb-nice (conf-to-set-garb-nice-q))
    (kom-set-super-conf (conf-to-set-super-conf-q) (new-super-conf-q))
    (kom-set-personal-label (label-what-pers) (label-what-conf))
    (kom-is-person-member-of-conference (pers-to-check-mship-for) (conf-to-check-mship-of))
    (kom-will-person-read-text (pers-to-check-will-read-for))
    (kom-create-aux-item (which-conf-to-add-aux-to))
    (kom-recommend-conference (recommend-which-conf))
    (kom-limit-import (limit-import-to-conf))
    (kom-edit-add-recipient (added-recipient))
    (kom-edit-add-bcc (added-blank-carbon-copy))
    (kom-edit-add-copy (added-carbon-copy))
    (kom-edit-move-text (who-to-move-to-q))
    (kom-add-faq (conf-to-add-faq))
    (kom-del-faq (conf-to-del-faq))
    (kom-review-faq (view-which-faq))
    (kom-unread-faq (unread-which-faq))
    (kom-change-conf-faq (what-to-change-faq-you))
    (kom-list-faqs (conf-to-list-faqs))
    (kom-filter-subject (filter-in-conf))
    (kom-filter-recipient (filter-recipient))
    (kom-filter-text (filter-in-conf))

    (t (t (default . (lyskom-default-conference-at-point
                      lyskom-default-conference-current))))
    )

365
366
  "Strategy for the initial value for conference defaults.

David Byers's avatar
David Byers committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
Each element in this list identifies an Emacs och LysKOM command, and
defines the initial values for queries it makes for conference names.

Each element has the following format:

    \(COMMAND . \(\(PROMPT-1 . \(\(default . \(INITIAL-VALUES\\)\\)
                             \(filter  . \(EXCLUDED-CONFS\)\)
                             \(save    . \(SAVE-GROUPS\)\)\)\)
                \(PROMPT-2 . \(\(default . \(INITIAL-VALUES\)\)
                             \(filter  . \(EXCLUDED-CONFS\)\)
                             \(save    . \(SAVE-GROUPS\)\)\)\)
                ...\)\)

COMMAND is the name of a LysKOM or Emacs command. PROMPT-1 and
PROMPT-2 \(there can be any number of prompts liste in a single
command\) are symbols representing the prompt. These are defined
in lyskom-messages in swedish-strings.el and english-strings.el. 

INITIAL-VALUES are functions to call to generate a list of possible
initial values for the prompt. These functions must return lists of
conference numbers. EXCLUDED-CONFS are functions that are called to
eliminate possible initial values. These must take a single argument,
an uconf-stat, and should return the uconf-stat itself if it is a
valid candidate for the initial value, or nil if it is not. Finally,
SAVE-GROUPS are symbols under which the value the user inputs will be
saved.

As a special case, a list in INITIAL-VALUES is interpreted as a
function with arguments. The first element in the list is applied to
the remaining elements.

If `t' is used for COMMAND, it indicates the default to use when no
COMMAND listed matches the current command. If `t' is used for PROMPT,
it indicates defaults, filters and save groups to use when no other
PROMPT matches.


Some useful functions for INITIAL-VALUES are:

lyskom-default-conference-at-point returns the conference shown where
point is. If point is on a conference name, that name will be used as
the initial value.

lyskom-default-conference-current returns the current conference.

lyskom-default-conference-self returns the logged-in person.

lyskom-default-conference-last-author returns the author of the most
recently read text.

lyskom-default-conference-saved returns saved input. This must be
specified as a list in INITAL-VALUES, where the argument (second
element of the list) is the symbol under which the input was saved,
from \(SAVE-GROUPS\) in one or more commands.


Some useful functions for EXCLUDE-CONFS are:

lyskom-default-conference-not-self excludes the logged-in person.

lyskom-default-conference-not-current excludes the current conference.


The format of this variable may change in the future.
")
432
433


434
(defconst kom-old-farts-text-prompt-strategy
David Byers's avatar
David Byers committed
435
436
  '((kom-comment-previous . ((t   . lyskom-get-previous-text)
			     (nil . lyskom-get-previous-text)))
David Byers's avatar
David Byers committed
437
438
439
440
    (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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
    (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.")

456
457
458
459
(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
460
(def-kom-var kom-pick-text-no-strategy-alist
David Byers's avatar
David Byers committed
461
462
  '((kom-comment-previous . ((t   . lyskom-get-previous-text)
                             (nil . lyskom-get-previous-text)))
David Byers's avatar
David Byers committed
463
464
    (kom-view-previous-commented-text . ((t   . lyskom-get-previous-text)
                                         (nil . lyskom-get-previous-text)))
David Byers's avatar
David Byers committed
465
466
    (kom-private-answer-previous . ((t   . lyskom-get-previous-text)
                                    (nil . lyskom-get-previous-text)))
467
468
469
470
    (kom-sub-comment . ((t . lyskom-maybe-get-commented-text)
                        (nil . lyskom-maybe-get-commented-text)))
    (kom-sub-footnote . ((t . lyskom-maybe-get-footnoted-text)
                         (nil . lyskom-maybe-get-footnoted-text)))
David Byers's avatar
David Byers committed
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
    (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
500
501
502

The cdrs on the list may be either of:

David Byers's avatar
David Byers committed
503
504
505
506
507
508
509
510
* 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
511
512
513
514
515

* 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
516
517
  `\(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
518
519
  )

David Byers's avatar
David Byers committed
520
(def-kom-var kom-url-transformation-rules 
521
522
523
  '(
    ("^http://[^/]*aftonbladet\\.se/.*/story/.*html?$" . "\\&.")
    )
David Byers's avatar
David Byers committed
524
525
526
527
528
529
  "**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
530

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

David Byers's avatar
David Byers committed
534
535
536
537
538
539
    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
540
541
542
543
  server
  )


544
(def-kom-var kom-check-configuration-on-startup t
David Byers's avatar
David Byers committed
545
546
547
548
549
550
551
552
553
554
555
556
557
  "**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.
")
558

David Byers's avatar
David Byers committed
559

560
(def-kom-var kom-keyboard-menu-immediate-selection nil
David Byers's avatar
David Byers committed
561
562
563
564
565
566
567
568
569
  "**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."
570
571
572
  server)


573
(def-kom-var kom-edit-hide-add-button nil
David Byers's avatar
David Byers committed
574
575
576
577
578
  "**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."
579
580
581
  server
)

David Byers's avatar
David Byers committed
582
(def-kom-var kom-max-overlays 120
David Byers's avatar
David Byers committed
583
584
585
586
587
588
589
590
591
592
593
594
595
596
  "**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
597
598
599
  server
)

600
(def-kom-var kom-highlight-text-body t
David Byers's avatar
David Byers committed
601
602
603
  "**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
604
605
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
606
607
608
609
other than `t' or `nil' are reserved for future use.

See `kom-max-overlays' for information on how to limit the number of
overlays."
610
611
612
  server
)

613
(def-kom-var kom-highlight-first-line t
David Byers's avatar
David Byers committed
614
615
616
617
618
619
620
621
622
  "**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."
623
624
625
626
  server
)

(def-kom-var kom-highlight-dashed-lines t
David Byers's avatar
David Byers committed
627
628
629
630
631
632
633
634
635
  "**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."
636
637
638
  server
)

639
(def-kom-var kom-async-highlight-text-body t
David Byers's avatar
David Byers committed
640
641
642
643
644
645
646
647
648
  "**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."
649
650
651
652
  server
)

(def-kom-var kom-async-highlight-dashed-lines t
David Byers's avatar
David Byers committed
653
654
655
656
657
658
659
660
661
  "**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."
662
663
664
  server
)

David Byers's avatar
David Byers committed
665
(def-kom-var kom-extended-status-information nil
David Byers's avatar
David Byers committed
666
667
668
  "**Controls display of extra information when displaying LysKOM objects.

If `t', extended status information is listed for all objects in
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
LysKOM. If set to an association list, each element is a pair of tag
and value. The tag specifies a type of extended information. If the
corresponding value is `t', the information is shown. If the
corresponding value is `nil', the information is not shown.

Valid tags are:

    Tag                 Meaning
    conf                Show all extended information for conferences
    pers                Show all extended information for persons
    server              Show all extended information for the server
    read-faq            Show read FAQs
    raw-server-stats    Show raw server statistics
    raw-boottime-info   Show raw boot-time server information
    t                   Any information not explicitly listed

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 (for letterboxes) and full
statistics and boot-time information (for the server).

Values other than those specified are reserved for future extensions."
David Byers's avatar
David Byers committed
693
server )
694

David Byers's avatar
David Byers committed
695
(def-kom-var kom-auto-list-faqs t
David Byers's avatar
David Byers committed
696
697
698
699
700
701
702
703
  "**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
704
705
706
  server
)

707
(def-kom-var kom-auto-review-faqs t
David Byers's avatar
David Byers committed
708
709
710
711
712
713
714
715
716
  "**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."

717
718
719
  server
)

David Byers's avatar
X    
David Byers committed
720
(def-kom-var kom-allow-incompleteness nil
David Byers's avatar
David Byers committed
721
722
723
724
725
726
727
728
729
730
  "**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
731
732
  server
)
733

David Byers's avatar
X    
David Byers committed
734
(def-kom-var kom-bury-buffers t
David Byers's avatar
David Byers committed
735
736
737
738
739
740
741
  "**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
742
  server)
743

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

David Byers's avatar
David Byers committed
747
748
749
750
751
752
753
754
755
756
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
757
  server)
758

David Byers's avatar
X    
David Byers committed
759
(def-kom-var kom-view-commented-in-window 'other
David Byers's avatar
David Byers committed
760
761
762
  "**Where to view commented texts. 

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

David Byers's avatar
X    
David Byers committed
765
(def-kom-var kom-edit-filters-in-window nil
David Byers's avatar
David Byers committed
766
767
768
  "**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
769
  server)
David Byers's avatar
David Byers committed
770

David Byers's avatar
X    
David Byers committed
771
(def-kom-var kom-list-membership-in-window 'other
David Byers's avatar
David Byers committed
772
773
774
  "**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
775
  server)
776

777
(def-kom-var kom-personal-messages-in-window 'other
David Byers's avatar
David Byers committed
778
779
780
  "**Where to display personal messages. 

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

David Byers's avatar
X    
David Byers committed
783
(def-kom-var kom-customize-format 'long
David Byers's avatar
David Byers committed
784
785
786
787
788
789
790
791
  "**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
792
  server)
793

David Byers's avatar
X    
David Byers committed
794
(def-kom-var kom-user-prompt-format "%[%c% %m%] - "
David Byers's avatar
David Byers committed
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
  "**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
822
  server)
David Byers's avatar
David Byers committed
823

Per Cederqvist's avatar
.    
Per Cederqvist committed
824

David Byers's avatar
X    
David Byers committed
825
(def-kom-var kom-user-prompt-format-executing "%[%c% %m%]."
David Byers's avatar
David Byers committed
826
827
828
829
  "**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
830
  server)
David Byers's avatar
David Byers committed
831
832


David Byers's avatar
X    
David Byers committed
833
(def-kom-var kom-enabled-prompt-format "%[%c% %m%] # "
David Byers's avatar
David Byers committed
834
835
836
837
  "**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
838
  server)
David Byers's avatar
David Byers committed
839

840

David Byers's avatar
X    
David Byers committed
841
(def-kom-var kom-enabled-prompt-format-executing "%[%c% %m%]."
David Byers's avatar
David Byers committed
842
  "**Format of LysKOM prompt when executing a default command when
David Byers's avatar
David Byers committed
843
844
845
846
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
847
  server)
David Byers's avatar
David Byers committed
848

David Byers's avatar
David Byers committed
849
(def-kom-var kom-anonymous-prompt-format "%[%c% %m%] (%a) - "
David Byers's avatar
David Byers committed
850
851
852
853
854
855
  "**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
856
857
858
  server)

(def-kom-var kom-anonymous-prompt-format-executing "%[%c% %m%] (%a)."
David Byers's avatar
David Byers committed
859
860
861
862
863
  "**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
864
865
  server)

866
(def-kom-var kom-show-week-number t
David Byers's avatar
David Byers committed
867
868
869
870
871
872
873
  "**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."
874
875
  server)

David Byers's avatar
David Byers committed
876

David Byers's avatar
X    
David Byers committed
877
(def-kom-var kom-cite-string ">"
David Byers's avatar
David Byers committed
878
879
880
881
882
  "**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
883
  server)
884

885
(def-kom-var kom-created-texts-are-saved nil
David Byers's avatar
David Byers committed
886
887
888
889
890
891
  "**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."
892
893
894
  server
  inherited)

895
(def-kom-var kom-created-texts-are-read nil
David Byers's avatar
David Byers committed
896
897
898
899
900
901
902
  "**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."
903
  common created-texts-are-read boolean)
David Byers's avatar
David Byers committed
904

905
(def-kom-var kom-mark-read-texts-as-read-in-new-recipient t
David Byers's avatar
David Byers committed
906
907
908
909
910
911
912
913
914
  "**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."
915
916
  server)

David Byers's avatar
X    
David Byers committed
917
(def-kom-var kom-customize-in-window nil
David Byers's avatar
David Byers committed
918
919
920
  "**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
921
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
922

David Byers's avatar
X    
David Byers committed
923
(def-kom-var kom-prioritize-in-window nil
David Byers's avatar
David Byers committed
924
925
926
  "**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
927
  server)
David Byers's avatar
David Byers committed
928

929
(def-kom-var kom-default-mark nil
David Byers's avatar
David Byers committed
930
931
932
933
934
935
936
  "**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."
937
938
  common default-mark integer
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
939

940
(def-kom-var kom-symbolic-marks-alist '(("Standard" . 100))
David Byers's avatar
David Byers committed
941
942
943
944
945
946
947
  "**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."
948
949
  server)

David Byers's avatar
X    
David Byers committed
950
(def-kom-var kom-reading-puts-comments-in-pointers-last t
David Byers's avatar
David Byers committed
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
  "**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
"
976
  common reading-puts-comments-in-pointers-last boolean
David Byers's avatar
David Byers committed
977
  inherited)
David Byers's avatar
David Byers committed
978

979
(def-kom-var kom-review-uses-cache t
David Byers's avatar
David Byers committed
980
981
982
983
984
985
986
987
  "**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."
988
989
990
  server
  inherited)

991
(def-kom-var kom-review-marks-texts-as-read nil
David Byers's avatar
David Byers committed
992
993
994
995
996
997
998
999
1000
1001
1002
1003
  "**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."
1004
1005
1006
  server
  inherited)

David Byers's avatar
David Byers committed
1007
(def-kom-var kom-postpone-default 17
David Byers's avatar
David Byers committed
1008
1009
1010
1011
  "**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
1012
1013
1014
  server)


David Byers's avatar
X    
David Byers committed
1015
(def-kom-var kom-dashed-lines t
David Byers's avatar
David Byers committed
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
  "**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."
1044
  common dashed-lines boolean
David Byers's avatar
David Byers committed
1045
  inherited)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1046

1047
(def-kom-var kom-long-lines nil
David Byers's avatar
David Byers committed
1048
1049
1050
1051
1052
1053
1054
  "**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."
1055
1056
1057
1058
  server
  inherited)

(def-kom-var kom-text-footer-dash-length 52
David Byers's avatar
David Byers committed
1059
1060
1061
1062
1063
1064
1065
  "**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.

1066
1067
1068
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
1069
This length is currently ignored when `kom-text-footer-format' is used."
1070
1071
1072
1073
  server
  inherited)

(def-kom-var kom-text-header-dash-length 60
David Byers's avatar
David Byers committed
1074
1075
1076
1077
1078
1079
1080
  "**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."
1081
1082
1083
1084
1085
  server
  inherited)



1086
(def-kom-var kom-text-footer-format nil
David Byers's avatar
David Byers committed
1087
  "**Defines the format of the text footer.
1088

David Byers's avatar
David Byers committed
1089
1090
1091
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:
1092

David Byers's avatar
David Byers committed
1093
1094
1095
1096
1097
1098
    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
1099

David Byers's avatar
David Byers committed
1100
1101
1102
1103
1104
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.
1105
1106

The field width of %- is special. It specifies the maximum number of
David Byers's avatar
David Byers committed
1107
1108
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.
1109

David Byers's avatar
David Byers committed
1110
1111
When set, this variable overrides `kom-dashed-lines' and
`kom-show-author-at-end'.
1112
1113
1114
1115

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
1116
1117
1118
1119
1120
`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\"
1121
1122
1123
1124
1125
1126
"
  server
  inherited)



1127
(def-kom-var kom-show-creating-software nil
David Byers's avatar
David Byers committed
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
  "**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."
1139
1140
1141
  server
  inherited)

David Byers's avatar
David Byers committed
1142
(def-kom-var kom-show-author-at-end t
David Byers's avatar
David Byers committed
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
  "**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
1168
1169
  server
  inherited)
David Byers's avatar
David Byers committed
1170

1171
(def-kom-var kom-truncate-threshold nil
David Byers's avatar
David Byers committed
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
  "**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."
1183
1184
  server)

1185
(def-kom-var kom-truncate-show-lines 10
David Byers's avatar
David Byers committed
1186
1187
1188
1189
1190
1191
1192
  "**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."
1193
1194
1195
  server)


David Byers's avatar
X    
David Byers committed
1196
(def-kom-var kom-print-number-of-unread-on-entrance t
David Byers's avatar
David Byers committed
1197
1198
1199
1200
1201
1202
1203
1204
1205
  "**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."
1206
  common print-number-of-unread-on-entrance boolean)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1207

1208
(def-kom-var kom-show-unread-in-frame-title t
David Byers's avatar
David Byers committed
1209
1210
1211
1212
1213
1214
1215
  "**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."
1216
1217
  server)

David Byers's avatar
David Byers committed
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
;; 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
1229
(def-kom-var kom-presence-messages t
David Byers's avatar
David Byers committed
1230
1231
1232
1233
1234
1235
  "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."
1236
  common presence-messages boolean)
David Byers's avatar
David Byers committed
1237
1238

(def-kom-var kom-presence-messages-in-echo-area t
David Byers's avatar
David Byers committed
1239
1240
1241
1242
1243
  "**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
1244

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

David Byers's avatar
David Byers committed
1247
1248
1249
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
1250

David Byers's avatar
David Byers committed
1251
1252
The value `friends-and-morons' means show messages for the users in 
`kom-friends' and `kom-morons'.
1253

David Byers's avatar
David Byers committed
1254
1255
If you want the messages in the buffer, set the variable 
`kom-presence-messages-in-buffer'.
1256

David Byers's avatar
David Byers committed
1257
Values other than those listed are reserved for future use."
David Byers's avatar
X    
David Byers committed
1258
  server)
David Byers's avatar
David Byers committed
1259

David Byers's avatar
David Byers committed
1260
1261


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

David Byers's avatar
David Byers committed
1265
1266
1267
1268
1269
1270
1271
1272
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
1273
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1274

David Byers's avatar
X    
David Byers committed
1275
(def-kom-var kom-show-where-and-what t
David Byers's avatar
David Byers committed
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
  "**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
1302
  server)
David Byers's avatar
David Byers committed
1303

1304
(def-kom-var kom-show-since-and-when nil
David Byers's avatar
David Byers committed
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
  "**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."
1332
  server)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1333

David Byers's avatar
X    
David Byers committed
1334
(def-kom-var kom-idle-hide 30
David Byers's avatar
David Byers committed
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
  "**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
1345
  server)
1346

David Byers's avatar
X    
David Byers committed
1347
(def-kom-var kom-show-footnotes-immediately t
David Byers's avatar
David Byers committed
1348
1349
1350
1351
1352
1353
1354
  "**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
1355
  server)
1356

David Byers's avatar
X    
David Byers committed
1357
(def-kom-var kom-follow-comments-outside-membership nil
David Byers's avatar
David Byers committed
1358
1359
1360
1361
1362
1363
1364
  "**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.
1365

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

David Byers's avatar
David Byers committed
1369
(def-kom-var kom-follow-attachments t
David Byers's avatar
David Byers committed
1370
1371
1372
1373
1374
  "**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
1375

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

David Byers's avatar
X    
David Byers committed
1379
(def-kom-var kom-read-depth-first t
David Byers's avatar
David Byers committed
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
  "**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."
1391
  common read-depth-first boolean)
David Byers's avatar
David Byers committed
1392

David Byers's avatar
X    
David Byers committed
1393
(def-kom-var kom-continuous-scrolling t
David Byers's avatar
David Byers committed
1394
  "**Controls frequency of scrolling.
1395

David Byers's avatar
David Byers committed
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
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)
1406

David Byers's avatar
X    
David Byers committed
1407
(def-kom-var kom-deferred-printing t
David Byers's avatar
David Byers committed
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
  "**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."
1420
  server)
1421

David Byers's avatar
David Byers committed
1422
1423
1424
1425
(def-kom-var lyskom-overlay-pool nil  
  "Pool of overlays"
  local)

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

1429
(def-kom-var kom-review-priority nil
David Byers's avatar
David Byers committed
1430
  "**Priority to use when reviewing texts.
1431

David Byers's avatar
David Byers committed
1432
1433
1434
1435
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.
1436

David Byers's avatar
David Byers committed
1437
1438
1439
1440
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').
1441

David Byers's avatar
David Byers committed
1442
1443
1444
Values other than positive integers and `nil' are reserved for future
use."
  server)
1445

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

David Byers's avatar
David Byers committed
1449
1450
1451
1452
1453
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.
1454

David Byers's avatar
David Byers committed
1455
1456
1457
Values other than `express', `t' and `nil' are reserved for future
use."
  server)
1458

David Byers's avatar
David Byers committed
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
(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