Protocol-A.texi 298 KB
 David Byers committed Jan 13, 1996 1 \input texinfo @c -*-texinfo-*-  David Byers committed Jan 07, 1999 2 3 @c @c FIXME: Explain how the garb works with nice and keep-commented  Per Cederqvist committed Apr 19, 2001 4 @c FIXME: Make all types clickable in HTML (and info?)  Per Cederqvist committed May 01, 2001 5 6 7 @c FIXME: Move predefined aux-items to separate chapter @c FIXME: Move misc-infos to chapter? @c FIXME: Check for too much text before @menu.  Per Cederqvist committed May 01, 2001 8 @c FIXME: error-reply defined twice (conflicting).  Per Cederqvist committed May 01, 2001 9 10 @c FIXME: add link to Name Expansion from relevant reqs. @c FIXME: Name Expansion collate table info is outdated.  Per Cederqvist committed May 01, 2001 11 12 @c FIXME: Overview -> Preface @c FIXME: Move syntax from overview to somewhere else  Per Cederqvist committed May 01, 2001 13 @c FIXME: sentence-end-double-space!  Per Cederqvist committed May 01, 2001 14 @c FIXME: "Foo bar (bar baz.)" or "Foo bar (bar baz)."?  David Byers committed Jan 07, 1999 15 @c  Per Cederqvist committed May 01, 2001 16 @c $Id: Protocol-A.texi,v 1.134 2001/05/01 18:51:38 ceder Exp$  David Byers committed Jan 13, 1996 17 18 19 20 @c %**start of header @setfilename protocol-a.info @settitle LysKOM Protocol A @setchapternewpage odd  Per Cederqvist committed Apr 16, 2001 21 22 23 24 25 @c @afourpaper @set PROTOEDITION 10.4 @set PROTOVER 10 @set VERSION 1.0.4  David Byers committed Jan 13, 1996 26   Per Cederqvist committed May 01, 2001 27 28 29  @c  Per Cederqvist committed May 01, 2001 30 @c Define a few strings that contains characters from ISO Latin-1.  Per Cederqvist committed May 01, 2001 31 @c  Per Cederqvist committed May 01, 2001 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49  @iftex @set IAM Inl@"a{}gg @}t mig @set Pell P@"ar Emanuelsson @set Kent Kent Eng@-str@"om@penalty-10000 @set presconf 27HPresentation (av nya) m@"oten @end iftex @ifnottex @set IAM Inlägg @}t mig @set Pell Pär Emanuelsson @set Kent Kent Engström @set presconf 27HPresentation (av nya) möten @end ifnottex  Per Cederqvist committed May 01, 2001 50 51 52 53 54 55  @c @c Index setup @c  Per Cederqvist committed Apr 30, 2001 56 57 58 59 60 61 62 @c Index for asynchronous messages. @defcodeindex am @c Merge all indices. @syncodeindex am fn @syncodeindex tp fn  Per Cederqvist committed May 01, 2001 63 64 65 66 67 68  @c @c Special markup for Protocol-A.texi @c  Per Cederqvist committed Apr 16, 2001 69 @c @req{login} is used for protocol requests.  Per Cederqvist committed Apr 28, 2001 70   Per Cederqvist committed Apr 16, 2001 71 72 73 74 @macro req {n} @code{\n\} @end macro  Per Cederqvist committed Apr 28, 2001 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 @c @reqlink{login} is used for protocol requests, that shuld be linked. @ifhtml @macro reqlink {n} @code{@ref{\n\}} @end macro @end ifhtml @ifnothtml @macro reqlink {n} @code{\n\} (@pxref{\n\}) @end macro @end ifnothtml @c @reqdlink{login}...@linkhere{} is used for protocol requests, that @c shuld be linked, where the link should occur a few words after the @c request itself. @ifhtml @c HTML version: make the word a link. @macro reqdlink {n} @code{@ref{\n\}}@c @unmacro linkhere @macro linkhere @end macro @end macro @end ifhtml @ifnothtml @ifnottex @c Info version: create linkhere as a macro that contains a reference. @macro reqdlink {n} @code{\n\}@c @unmacro linkhere @macro linkhere (@pxref{\n\}) @end macro @end macro @end ifnottex  Per Cederqvist committed Apr 29, 2001 118   Per Cederqvist committed Apr 28, 2001 119 120 @iftex  Per Cederqvist committed Apr 29, 2001 121 @c TeX version: this produces output similar to the Info version.  Per Cederqvist committed Apr 28, 2001 122   Per Cederqvist committed Apr 29, 2001 123 124 125 126 127 128 @tex \gdef\reqdlink#1{% \code{#1}% \gdef\linkhere{ (\pxref{#1})}% } @end tex  Per Cederqvist committed Apr 28, 2001 129 130 131 @end iftex @end ifnothtml  Per Cederqvist committed Apr 16, 2001 132 133 134 135 136 137 138 139 140 141 @c @aux{mx-allow-filter} is used for aux-item names. @macro aux {n} @code{\n\} @end macro @c @async{async-login} is used for async names. @macro async {n} @code{\n\} @end macro  Per Cederqvist committed Apr 30, 2001 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 @c @asynclink{async-login} is used for async names, that shuld be linked. @ifhtml @macro asynclink {n} @code{@ref{\n\}} @end macro @end ifhtml @ifnothtml @macro asynclink {n} @code{\n\} (@pxref{\n\}) @end macro @end ifnothtml @c @asyncdlink{async-login}...@linkhere{} is used for async messages, @c that shuld be linked, where the link should occur a few words after @c the async name itself. @ifhtml @c HTML version: make the word a link. @macro asyncdlink {n} @code{@ref{\n\}}@c @unmacro linkhere @macro linkhere @end macro @end macro @end ifhtml @ifnothtml @ifnottex @c Info version: create linkhere as a macro that contains a reference. @macro asyncdlink {n} @code{\n\}@c @unmacro linkhere @macro linkhere (@pxref{\n\}) @end macro @end macro @end ifnottex @iftex @c TeX version: this produces output similar to the Info version. @tex \gdef\asyncdlink#1{% \code{#1}% \gdef\linkhere{ (\pxref{#1})}% } @end tex @end iftex @end ifnothtml  Per Cederqvist committed Apr 16, 2001 199 200 201 202 203 @c @type{Conference} is used for LysKOM types. @macro type {n} @code{\n\} @end macro  Per Cederqvist committed May 01, 2001 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 @c @lt{Conference} is used for linked types. The link is only present @c when it is unobtrusive. It should only be used inside @c @example...@end example. @ifhtml @macro lt {n} @ref{\n\}@c @end macro @end ifhtml @ifnothtml @macro lt {n} \n\@c @end macro @end ifnothtml  Per Cederqvist committed Apr 16, 2001 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 @c @priv{wheel} is used for privilege bits. @macro priv {n} @code{\n\} @end macro @c @conftype{rd-prot} is used for conference type bits. @macro conftype {n} @code{\n\} @end macro @c @misc{bcc-recpt} is used for misc-info names. @macro misc {n} @code{\n\} @end macro @c @rarg{passwd} is used to reference arguments of requests. This is @c *only* used in the nodes that defines the requests. @macro rarg {n} @code{\n\} @end macro @c @aarg{text-no} is used to reference arguments of asynchronous @c messages. This is *only* used in the nodes that defines the @c relevant asynchronous message. @macro aarg {n} @code{\n\} @end macro @c @errorcode{no-such-text} is used to mark error codes. @macro errorcode {n} @code{\n\} @end macro @c @field{ident-user} is used to mark fields of struct types. @macro field {n} @code{\n\} @end macro  Per Cederqvist committed Apr 30, 2001 258 259 260 261 262 263 264 @c @reqexample is used immediately before Protocol-A example @c fragments. @macro reqexample @need 2000 @i{Example:} @end macro  Per Cederqvist committed May 01, 2001 265 266 @c %**end of header  David Byers committed Jan 13, 1996 267 @ifinfo  Per Cederqvist committed Apr 16, 2001 268 269 270 This is the LysKOM Protocol A specification, edition @value{PROTOEDITION}. It specifies version @value{PROTOVER} of the protocol. It corresponds to version @value{VERSION} of lyskomd.  David Byers committed Jan 13, 1996 271   Per Cederqvist committed Sep 05, 2000 272 Copyright @copyright{} 1995-2000 Lysator ACS.  David Byers committed Jan 13, 1996 273 274 275 276  Permission is granted to make and distribute verbatim copies of this specification provided the copyright notice and this permission notice are preserved on all copies.  Per Cederqvist committed Apr 16, 2001 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292  @ignore Permission is granted to process this file through TeX and print the results, provided the printed document carries a copying permission notice identical to this one except for the removal of this paragraph (this paragraph not being relevant to the printed manual). @end ignore Modified versions of this document may be redistributed with the added condition that all modifications not cleared with the LysKOM development group are clearly marked and that the entire modified work be redistributed under the same conditions as the original. Permission is granted to copy and distribute translations of this manual into another language under the same conditions as for modified versions.  David Byers committed Jan 13, 1996 293 294 @end ifinfo  Per Cederqvist committed Apr 16, 2001 295 296 297 298 @c FIXME: What does this do? @iftex @parindent 0pt @font@tensltt=cmsltt10  Per Cederqvist committed Apr 29, 2001 299 @tex  Per Cederqvist committed Apr 16, 2001 300 301 302 303 304 \global\def\rett#1{{\let\t\sltt\tt #1}} \global\def\sltt#1{{\fam\ttfam\tensltt\let\t\rett #1}} \global\let\t\sltt @end tex @end iftex  Per Cederqvist committed Aug 02, 1998 305   David Byers committed Jan 13, 1996 306 307 @titlepage @title{LysKOM Protocol A}  Per Cederqvist committed Apr 16, 2001 308 309 310 @subtitle{Protocol version @value{PROTOVER}} @subtitle{Edition @value{PROTOEDITION}} @subtitle{(lyskomd @value{VERSION})}  David Byers committed Jan 13, 1996 311 312 313 314 @author by the LysKOM Developers @page @vskip 0pt plus 1filll  Per Cederqvist committed Sep 05, 2000 315 Copyright @copyright{} 1995-2000 Lysator ACS  David Byers committed Jan 13, 1996 316 317 318 319 320 321 322 323 324 325 326 327 328 329  Permission is granted to make and distribute verbatim copies of this document provided the copyright notice and this permission notice are preserved on all copies. Modified versions of this document may be redistributed with the added condition that all modifications not cleared with the LysKOM development group are clearly marked and that the entire modified work be redistributed under the same conditions as the original. Permission is granted to copy and distribute translations of this manual into another language under the same conditions as for modified versions. @end titlepage  Per Cederqvist committed Apr 16, 2001 330 331 332 @ifnothtml @contents @end ifnothtml  David Byers committed Jan 13, 1996 333   Per Cederqvist committed Apr 16, 2001 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 @dircategory LysKOM @direntry * Protocol A: (protocol-a). The LysKOM Protocol A specification. @end direntry @ifhtml @html
@end html @end ifhtml @ifnottex  Per Cederqvist committed May 23, 1999 352 @node Top  Per Cederqvist committed Apr 05, 1999 353 @top LysKOM Protocol A  Per Cederqvist committed Apr 04, 1999 354   Per Cederqvist committed Apr 16, 2001 355 356 357 358 359 360 361 This document specifies version @value{PROTOVER} of LysKOM Protocol A. This is edition @value{PROTOEDITION} of the specification. It corresponds to version @value{VERSION} of lyskomd. The most up-to-date version if this document can always be found at @uref{http://www.lysator.liu.se/lyskom/protocol/}. @end ifnottex  David Byers committed Jan 13, 1996 362 363  @menu  Per Cederqvist committed May 01, 2001 364 * Preface::  Per Cederqvist committed Apr 04, 1999 365 * Introduction::  Per Cederqvist committed May 01, 2001 366 367 * Fundamentals:: * LysKOM Data Types::  Per Cederqvist committed Apr 04, 1999 368 369 370 * Protocol Requests:: * Asynchronous Messages:: * Error Codes::  Per Cederqvist committed May 01, 2001 371 * Name Expansion::  Per Cederqvist committed Apr 04, 1999 372 373 374 375 * LysKOM Content Types:: * The User Area:: * Writing Clients:: * Importing and Exporting E-Mail::  Per Cederqvist committed May 01, 2001 376 * Future changes::  Per Cederqvist committed May 01, 2001 377 378 * Protocol Version History:: * Document Edition History::  Per Cederqvist committed Apr 30, 2001 379 * Index::  David Byers committed Jan 13, 1996 380 381 @end menu  Per Cederqvist committed May 01, 2001 382 383 @node Preface @chapter Preface  David Byers committed Jan 13, 1996 384   Per Cederqvist committed Apr 16, 2001 385 386 387 388 389 @iftex This document specifies version @value{PROTOVER} of LysKOM Protocol A. This is edition @value{PROTOEDITION} of the specification. It corresponds to version @value{VERSION} of lyskomd.  Per Cederqvist committed Apr 16, 2001 390 391 The most up-to-date version if this document can always be found on the web at @uref{http://www.lysator.liu.se/lyskom/protocol/}.  Per Cederqvist committed Apr 16, 2001 392 393 @end iftex  David Byers committed Jan 13, 1996 394 LysKOM is a conferencing system@footnote{Or in modern terms, enabling  David Byers committed Sep 13, 1997 395 396 397 398 399 400 technology for Computer-Supported Cooperative Work (CSCW).}. Similar systems were QZ-KOM and PortaCOM@footnote{Also known as PottaKOM'' and BortaKOM.''}. The LysKOM system is copyrighted by Lysator Academic Computing Society and distributed under conditions of the GNU Public License. LysKOM and its documentation is provided as is'' without warranty of any kind.  David Byers committed Jan 13, 1996 401   Per Cederqvist committed Apr 16, 2001 402 403 Anything described here as unspecified'' is liable to change in future protocol versions.  David Byers committed Jan 13, 1996 404 405  This specification is the work of several people. The main contributors have  David Byers committed Sep 13, 1997 406 been  David Byers committed May 23, 1999 407 408 Per Cederqvist @email{ceder@@lysator.liu.se}, David Byers @email{byers@@lysator.liu.se},  Per Cederqvist committed May 01, 2001 409 @value{Pell} @email{pell@@lysator.liu.se},  David Byers committed May 23, 1999 410 411 412 Thomas Bellman @email{bellman@@lysator.liu.se}, Lars Aronsson @email{aronsson@@lysator.liu.se}, Linus Tolke @email{linus@@lysator.liu.se} and  Per Cederqvist committed May 01, 2001 413 @value{Kent} @email{kent@@lysator.liu.se}.  David Byers committed Jan 13, 1996 414   David Byers committed May 23, 1999 415 416 The LysKOM developers can be reached by email to @email{lyskom@@lysator.liu.se}.  David Byers committed Jan 13, 1996 417   Per Cederqvist committed May 23, 1999 418 @node Introduction  David Byers committed Jan 13, 1996 419 420 421 422 423 424 @chapter Introduction This chapter introduces the concepts used in LysKOM, such as articles, conferences and sessions. @menu  Per Cederqvist committed Apr 04, 1999 425 426 * Articles:: * Conferences::  Per Cederqvist committed May 01, 2001 427 * Persons and Sessions::  Per Cederqvist committed Apr 04, 1999 428 429 430 431 * The Misc-Info List:: * The Aux-Item List:: * Security:: * Membership and Reading::  David Byers committed Jan 13, 1996 432 433 434 @end menu  Per Cederqvist committed May 23, 1999 435 @node Articles  David Byers committed Jan 13, 1996 436 437 @section Articles  Per Cederqvist committed Apr 16, 2001 438 An article is represented as a value of the type @type{Text-Stat} and a  David Byers committed Jan 13, 1996 439 string containing the article contents. An article will usually have one  David Byers committed Sep 13, 1997 440 441 or more recipients and may be a comment or footnote to other articles. Each article is kept in the database until it is older than the  Per Cederqvist committed Apr 16, 2001 442 @field{nice} value of each of its recipients and it is not marked by any  David Byers committed Sep 13, 1997 443 user.  David Byers committed Jan 13, 1996 444   Per Cederqvist committed May 01, 2001 445 446 There is an array of @type{Misc-Info} included in the @type{Text-Stat}. This array contains information about recipients,  Per Cederqvist committed May 01, 2001 447 senders, comments and footnotes.  David Byers committed Jan 13, 1996 448   Per Cederqvist committed May 01, 2001 449 450 451 452 453 454 455 456 457 458 459 Each article is identified by a number, the global@footnote{The number is not truly global; it is local to a specific LysKOM server.} article number (the @type{Text-No}). Global numbers are assigned in ascending order to new articles, and are never reused. If an article has recipients it will also have a local number for each recipient (the @type{Local-Text-No}). Local numbers are used in some data structures to provide more compact storage and to provide an ordering of articles for a particular recipient. Local numbers are assigned in ascending order and are never reused for a particular recipient, though different recipients will have articles with the same local numbers.  David Byers committed Jan 13, 1996 460   David Byers committed Sep 13, 1997 461 Occasionally it is necessary to map between local and global numbers.  Per Cederqvist committed May 01, 2001 462 The server call @reqdlink{local-to-global} does this@linkhere{}.  David Byers committed Jan 13, 1996 463 464 465   Per Cederqvist committed May 23, 1999 466 @node Conferences  David Byers committed Jan 13, 1996 467 468 @section Conferences  David Byers committed Sep 13, 1997 469 Conferences hold articles. They are represented in the protocol as a  Per Cederqvist committed Apr 16, 2001 470 471 472 data type called @type{Conference}. Each conference has a @dfn{creator}, the person who created the conference, and a @dfn{supervisor}, a conference whose members can modify the conference.  David Byers committed Dec 26, 1998 473 If the supervisor is a person, the members of that person's mailbox  David Byers committed Sep 13, 1997 474 are supervisors, which in most cases is only that person. We have also  Per Cederqvist committed Apr 16, 2001 475 introduced a type called @type{UConference} (pronounced micro-conf-stat)  David Byers committed Sep 13, 1997 476 which holds a subset of the information contained in the full  Per Cederqvist committed Apr 16, 2001 477 @type{Conference} type. Use the @type{UConference} type whenever  David Byers committed Sep 13, 1997 478 possible since it places a much smaller load on the LysKOM server.  David Byers committed Jan 13, 1996 479   Per Cederqvist committed Apr 16, 2001 480 481 482 483 Each conference has a type, which is essentially a collection of boolean flags. Currently the flags @conftype{rd-prot}, @conftype{letterbox}, @conftype{secret}, @conftype{original}, @conftype{allow-anonymous} and @conftype{forbid-secret} are defined.  David Byers committed Jan 13, 1996 484   Per Cederqvist committed Apr 16, 2001 485 @table @conftype  David Byers committed Jan 13, 1996 486 487 488 489 490 @item rd-prot The conference is protected from reading by non-members. Persons become members by having one of the existing members or supervisors add him or her to the conference. This restriction is enforced by the server. @item original  David Byers committed Sep 13, 1997 491 492 493 494 Conferences of this type are intended for original articles only. Comments are to be redirected to the super-conference instead. This restriction is currently not enforced by the server; clients must implement this functionality.  David Byers committed Jan 13, 1996 495 @item letterbox  David Byers committed Sep 13, 1997 496 Conferences of this type are connected to persons. Letters to a person  David Byers committed Dec 26, 1998 497 are sent to the mailbox and the name of the mailbox is synchronized  David Byers committed Sep 13, 1997 498 499 with the person name. It is currently not possible to explicitly set or clear this flag on a conference.  David Byers committed Jan 13, 1996 500 501 @item secret Conferences of this type are secret. The server will not divulge any  Kent Engström committed Jul 07, 1999 502 information about the existence of the conference to persons who are not  David Byers committed Dec 26, 1998 503 members or supervisors of the conference. If a mailbox is made secret,  David Byers committed Jan 13, 1996 504 505 that person cannot log in using the person name, but must specify a person number instead.  David Byers committed Sep 13, 1997 506 507 508 @item allow-anonymous Conferences of this type accept anonymous articles. Other conferences will reject anonymous articles.  David Byers committed Dec 26, 1998 509 510 511 @item forbid-secret Conferences of this type do not allow secret members. If a conference is changed to this type, preexisting secret members remain secret.  David Byers committed Jan 13, 1996 512 513 514 515 @end table  Per Cederqvist committed May 23, 1999 516 @node Persons and Sessions  Per Cederqvist committed May 01, 2001 517 @section Persons and Sessions  David Byers committed Jan 13, 1996 518 519  Persons are represented in the protocol by values of the type  Per Cederqvist committed Apr 16, 2001 520 @type{Person}. Associated with persons are statistics, a set of personal  Per Cederqvist committed Apr 28, 2001 521 flags and a set of privileges (@pxref{Security}). Persons are also  David Byers committed Sep 13, 1997 522 associated with a conference that has the same number as the person and  Per Cederqvist committed Apr 16, 2001 523 the @conftype{letterbox} bit set.  David Byers committed Jan 13, 1996 524 525  Connections to the server are represented as values of the type  Per Cederqvist committed Apr 16, 2001 526 527 @type{Static-Session-Info}, @type{Session-Info-Ident} or @type{Session-Info}. Sessions have session number that are unique for  David Byers committed Sep 13, 1997 528 529 530 531 each session in the lifetime of the server execution. A single user can have several sessions running at once. The session is not released until the network connection is closed; a user can log in and out repeatedly in a single session.  David Byers committed Jan 13, 1996 532 533   Per Cederqvist committed May 23, 1999 534 @node The Misc-Info List  David Byers committed Jan 13, 1996 535 536 @section The Misc-Info List  Per Cederqvist committed Apr 16, 2001 537 The @type{Misc-Info} list contains tagged data. The fields are sent in  David Byers committed Sep 13, 1997 538 groups pertaining to a particular type of information: information about  Per Cederqvist committed Oct 06, 1998 539 540 recipient; carbon copy recipient; blank carbon copy recipient; comment to; footnote to; comment in  David Byers committed Sep 13, 1997 541 542 543 and footnote in. The information groups may be sent in any order and there may be any number of groups. Within each group the elements are always sent in the order listed below.  David Byers committed Jan 13, 1996 544   David Byers committed Jun 14, 1996 545 @subsection Recipient  David Byers committed Jan 13, 1996 546   Per Cederqvist committed Apr 16, 2001 547 @table @misc  David Byers committed Jan 13, 1996 548 @item recpt  David Byers committed Sep 13, 1997 549 550 Starts a recipient group. It contains the conference number of a recipient of the article.  David Byers committed Jan 13, 1996 551 @item loc-no  David Byers committed Sep 13, 1997 552 553 Always present within a recipient group. It contains the local text number of the article in the conference specified by the preceding  Per Cederqvist committed Apr 16, 2001 554 @misc{recpt} field.  David Byers committed Jan 13, 1996 555 @item rec-time  David Byers committed Sep 13, 1997 556 557 558 If the recipient is a person, this element is added by the server when the recipient marks the article as read. It contains the time when the text was read.  David Byers committed Jan 13, 1996 559 @item sent-by  David Byers committed Sep 13, 1997 560 561 562 Present when the recipient was added by a person other than the author (after the article was created.) It contains the person number of the person who added the recipient.  David Byers committed Jan 13, 1996 563 @item sent-at  David Byers committed Sep 13, 1997 564 565 Present when the recipient was added after the article was created. It contains the time when the recipient was added.  David Byers committed Jan 13, 1996 566 567 568 @end table  David Byers committed Jun 14, 1996 569 @subsection Carbon Copy (CC) Recipient  David Byers committed Jan 13, 1996 570   David Byers committed Sep 13, 1997 571 572 573 574 The carbon-copy recipient group is identical to the recipient group above. The difference is how new comments to an article with a recipient or carbon-copy recipient are treated. A comment to an article is sent to all recipients, but not to carbon-copy recipients of the original  Per Cederqvist committed Jul 07, 1998 575 article. This difference is enforced by the clients.  David Byers committed Jan 13, 1996 576   Per Cederqvist committed Apr 16, 2001 577 @table @misc  David Byers committed Jan 13, 1996 578 @item cc-recpt  David Byers committed Sep 13, 1997 579 580 Starts a carbon-copy recipient group. It contains the conference number of a carbon-copy recipient of the article.  David Byers committed Jan 13, 1996 581 @item loc-no  David Byers committed Sep 13, 1997 582 583 Always present in a CC recipient group. It contains the local text number of the article in the conference specified by the most recent  Per Cederqvist committed Apr 16, 2001 584 @misc{cc-recpt} field.  David Byers committed Jan 13, 1996 585 @item rec-time  David Byers committed Sep 13, 1997 586 Present after the CC recipient has read the article. It contains the  Per Cederqvist committed Oct 06, 1998 587 588 time when the article was read. Since only persons can read articles this will only be seen if the CC recipient is a person.  David Byers committed Jan 13, 1996 589 590 591 @item sent-by Present when a CC recipient was added by a person other than the author after the article had been created. It contains the person number of the  Per Cederqvist committed Oct 06, 1998 592 person who added the CC recipient.  David Byers committed Jan 13, 1996 593 594 595 596 597 598 @item sent-at Present when a CC recipient was added after the article had been created. It is the time when the CC recipient was added. @end table  Per Cederqvist committed Oct 06, 1998 599 600 601 602 603 @subsection Blank Carbon Copy (BCC) Recipient The blank carbon-copy recipient group is identical to the carbon-copy recipient group above. The difference is the visibility of the information. A carbon-copy recipient group is visible to anyone that is  Kent Engström committed Jul 07, 1999 604 allowed to fetch both the text status of the involved text and the  Per Cederqvist committed Oct 06, 1998 605 conference status of the involved conference. (That is, as long as the  Kent Engström committed Jul 07, 1999 606 conference isn't secret everybody is allowed to see the carbon-copy  Per Cederqvist committed Oct 06, 1998 607 608 recipient group.)  Per Cederqvist committed Sep 06, 2000 609 610 611 612 613 A BCC recipient group is basically only visible to members and supervisors of the recipient. Persons that have the right to become a member of the recipient can also see it, as can the author of the text (unless the recipient is secret to him). This is enforced by the server.  Per Cederqvist committed Oct 06, 1998 614 615  This type of group was introduced in protocol version 10. When  Per Cederqvist committed Apr 28, 2001 616 old-style calls such as @reqlink{get-text-stat-old}  Kent Engström committed Jul 07, 1999 617 are used this will be converted to a CC recipient group by the server  Per Cederqvist committed May 01, 2001 618 619 620 for the benefit of clients that don't understand this group. (This conversion will of course only be performed when the user is allowed to se the blank carbon copy.)  Per Cederqvist committed Oct 06, 1998 621   Per Cederqvist committed Apr 16, 2001 622 @table @misc  Per Cederqvist committed Oct 06, 1998 623 624 625 626 627 628 @item bcc-recpt Starts a blank carbon-copy recipient group. It contains the conference number of a blank carbon-copy recipient of the article. @item loc-no Always present in a BCC recipient group. It contains the local text number of the article in the conference specified by the most recent  Per Cederqvist committed Apr 16, 2001 629 @misc{bcc-recpt} field.  Per Cederqvist committed Oct 06, 1998 630 631 632 633 634 635 636 637 638 639 640 641 642 643 @item rec-time Present after the BCC recipient has read the article. It contains the time when the article was read. Since only persons can read articles this will only be seen if the BCC recipient is a person. @item sent-by Present when a BCC recipient was added by a person other than the author after the article had been created. It contains the person number of the person who added the BCC recipient. @item sent-at Present when a BCC recipient was added after the article had been created. It is the time when the BCC recipient was added. @end table  David Byers committed Jun 14, 1996 644 @subsection Comment To  David Byers committed Jan 13, 1996 645   Per Cederqvist committed Apr 16, 2001 646 @table @misc  David Byers committed Jan 13, 1996 647 648 649 650 651 652 653 654 @item comm-to Always present when the article is a comment to another article. @item sent-by Present when the article was added as a comment by a person other than the author, after the article had been created. It contains the person number of the person who added the article as a comment. @item sent-at Present when the article was added as a comment after the article had  Kent Engström committed Jul 07, 1999 655 been created. It contains the time when it was added as a comment.  David Byers committed Jan 13, 1996 656 657 658 @end table  David Byers committed Jun 14, 1996 659 @subsection Footnote To  David Byers committed Jan 13, 1996 660   Per Cederqvist committed Apr 16, 2001 661 @table @misc  David Byers committed Sep 13, 1997 662 @item footn-to  David Byers committed Jan 13, 1996 663 664 665 Always present when the article is a footnote to another article. @item sent-at Present when the article was added as a footnote after the article had  Kent Engström committed Jul 07, 1999 666 been created. It contains the time when it was added as a footnote.  David Byers committed Jan 13, 1996 667 668 669 @end table  David Byers committed Jun 14, 1996 670 @subsection Comment in  David Byers committed Jan 13, 1996 671   Per Cederqvist committed Apr 16, 2001 672 @table @misc  David Byers committed Jan 13, 1996 673 674 675 676 677 678 @item comm-in Present when there are comments to this article. It contains the article number which is a comment to this article. @end table  David Byers committed Jun 14, 1996 679 @subsection Footnote in  David Byers committed Jan 13, 1996 680   Per Cederqvist committed Apr 16, 2001 681 @table @misc  David Byers committed Sep 13, 1997 682 @item footn-in  David Byers committed Jan 13, 1996 683 684 685 686 687 Present when there are footnotes to this article. It contains the article number which is a footnote to this article. @end table  Per Cederqvist committed May 23, 1999 688 @node The Aux-Item List  Per Cederqvist committed Apr 04, 1999 689 @section The Aux-Item List  David Byers committed Sep 13, 1997 690 691 692 693 694  The aux-item list is used as a generic extension mechanism in the LysKOM server and in protocol A. @menu  Per Cederqvist committed Apr 04, 1999 695 696 697 698 699 * About Aux-Items:: * Predefined Aux-Item Types:: * Client-Specific Aux-Item Types:: * Experimental Aux-Item Types:: * Defining New Aux-Item Types::  David Byers committed Sep 13, 1997 700 701 @end menu  Per Cederqvist committed May 23, 1999 702 @node About Aux-Items  Per Cederqvist committed Apr 04, 1999 703 @subsection About Aux-Items  David Byers committed Sep 13, 1997 704 705 706 707  Aux-items were introduced in protocol version 10 as a mechanism for extending the conference, text and server information structures without changing the protocol. Persons were excluded since nobody could figure  David Byers committed Dec 26, 1998 708 out a case where setting an aux-item on the mailbox wasn't as good as  David Byers committed Sep 13, 1997 709 710 711 setting it on the person (another reason was that I was fed up writing aux-item code by the time they were working on texts and conferences.)  Per Cederqvist committed Apr 28, 2001 712 713 714 The exact structure of an aux item is specified elsewhere (@pxref{LysKOM Data Types}). The important fields here are the @field{aux-no}, @field{tag} and @field{data} fields.  David Byers committed Sep 13, 1997 715   Per Cederqvist committed Apr 28, 2001 716 717 718 719 720 721 The @field{aux-no} field is used to identify an item. The @field{aux-no} together with a text or conference number uniquely identifies a particular aux item. Items are numbered from one and up within each item list. Once assigned, the @field{aux-no} for an item is never changed. New items are guaranteed to be assigned numbers that have never been used before within a particular list.  David Byers committed Sep 13, 1997 722   Per Cederqvist committed Apr 28, 2001 723 724 725 726 The @field{tag} field identifies the type of aux item. It is used by the server and by clients to figure out how to interpret the data field, and by the server to decide if the item needs special treatment.  David Byers committed Sep 13, 1997 727   Per Cederqvist committed Apr 28, 2001 728 729 730 731 The @field{data} field is a simple string. The meaning of the string is determined by the @field{tag} field, but since it is a string, clients that have no understanding of the contents can successfully parse the item anyway (in contrast to items in the misc-info list.)  David Byers committed Sep 13, 1997 732 733 734   Per Cederqvist committed May 23, 1999 735 @node Predefined Aux-Item Types  Per Cederqvist committed Apr 04, 1999 736 @subsection Predefined Aux-Item Types  David Byers committed Sep 13, 1997 737   David Byers committed May 12, 1999 738 739 740 Predefined Aux-Item types are part of Protocol A, and clients should support all of them. As with other parts of the protocol, changes to these definitions will be made backwards-compatible, if possible.  David Byers committed Sep 13, 1997 741   David Byers committed May 12, 1999 742 743 744 Creation and deletion of items with a predefined type can cause arbitrarily complex and wonderous behavior in the server. Furthermore, the server may place constraints on the items with regard to content,  Kent Engström committed Jul 07, 1999 745 flags, who can create them, to what objects they can be attached and  David Byers committed May 12, 1999 746 747 so forth. The server may also silently enforce specific values for any field of an item, regardless of what the client requests.  David Byers committed Sep 13, 1997 748   Per Cederqvist committed Aug 08, 1998 749 All items with tags in the range 1-9999 and 30000 and up are considered  David Byers committed Sep 13, 1997 750 751 predefined. If a client attempts to create an item with a tag in this range, but the server has no idea what that tag means, the server will  David Byers committed May 12, 1999 752 return an error (illegal-aux-item.)  David Byers committed Sep 13, 1997 753   Kent Engström committed Oct 20, 1999 754 755 Some of the aux-items below (mostly the ones that begin with "mx-") are used by mail importers. For information about supplementary aux-items  Per Cederqvist committed Apr 16, 2001 756 introduced by @command{komimportmail}, see @ref{komimportmail Aux-Item Types}.  David Byers committed Sep 13, 1997 757 758 759  @table @samp @item content-type [1] (text)  David Byers committed Oct 09, 1999 760 Specifies the content type of a text. Data is a valid MIME type or one  Per Cederqvist committed Apr 28, 2001 761 of the special LysKOM types (@pxref{LysKOM Content Types}).  David Byers committed Sep 13, 1997 762 763 764 765 766 767 768 769 770 771  This item may only be set by the author of a text. The inherit, secret and hide-owner bits are cleared. Only one content-type item can be created per creator. @item fast-reply [2] (text) Data is a string that constitutes a brief comment to the text. This comment should be displayed immediately after the text body.  David Byers committed Dec 26, 1998 772 773 An item of this type will never be inherited, can always be deleted, is never anonymous and is never secret.  David Byers committed Sep 13, 1997 774 775   776 @item cross-reference [3] (text, conference, letterbox)  David Byers committed Dec 26, 1998 777 Data is a cross-reference to something else. The contents consist of a  Per Cederqvist committed Aug 18, 1999 778 779 letter, a number, and optionally a space and a descriptive text. The letter must be one  David Byers committed Dec 26, 1998 780 781 782 783 784 of T, C or P. T specifies that the cross-reference points to a text; C that it points to a conference; and P that it points to a person. The number is the id of the target of the cross reference. The descriptive text is simly that, a text that describes the cross-reference. For example, "T15 Check this out!" is a cross reference to text 15 with a  Per Cederqvist committed Aug 18, 1999 785 786 description that reads "Check this out!", and "T17" is a cross reference without a description.  David Byers committed Sep 13, 1997 787   David Byers committed Dec 26, 1998 788 789 The inherit bit is automatically cleared and the item can always be deleted.  David Byers committed Sep 13, 1997 790 791 792 793 794 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 822  @item no-comments [4] (text) When this item is set, the author requests that nobody comments the text. This is advisory only; it is still possible to write comments, but clients should advise the user that this is contrary to the author's wishes. Data should be empty. This item may only be set by the author. The secret, hide-creator and inherit bits are automatically cleared. @item personal-comment [5] (text) When this item is set, the author requests only personal comments. This is advisory only; it is still possible to create regular comments, but clients should advise the user that the author prefers a personal comment. Data should be empty. This item may only be set by the author. The secret, hide-creator and inherit bits are automatically cleared. @item request-confirmation [6] (text) The author requests that everyone who reads the text confirms having done so by creating read-confirmation items on the text. Clients should ask users if they wish to confirm having read the text when it is displayed. Data should be empty. The hide-creator, secret and inherit bits are automatically cleared. @item read-confirm [7] (text) This item can be taken as confirmation that the item creator has read  Per Cederqvist committed Aug 08, 1998 823 824 825 the text to which the item is attached. Clients should never ever create this item without an explicit confirmation from the user that the text has indeed been read.  David Byers committed Sep 13, 1997 826 827  The hide-creator, secret and inherit bits are automatically cleared.  David Byers committed Dec 26, 1998 828 Once created an item of this type cannot be deleted.  David Byers committed Sep 13, 1997 829 830   831 @item redirect [8] (conference, letterbox)  David Byers committed Dec 29, 1998 832   David Byers committed Dec 26, 1998 833 834 835 836 837 838 839 840 841 842 843 This item indicates that texts should not be sent to the conference, but be directed to some other target instead. Clients should notify users that attempt to send texts to the conference of the redirect and offer to send the text to the target of the redirect instead. A typical use of this item would be a user that does not read LysKOM very often and would like to advise other users to send e-mail instead. Data is PROTOCOL:ADDRESS where PROTOCOL is either "E-mail" or "LysKOM", and ADDRESS is either an e-mail address or a LysKOM conference. Hopefully we'll be able to replace this with a forwarding mechanism later.  David Byers committed Sep 13, 1997 844 845  This item can only be set by the conference supervisor or in the case of  David Byers committed Dec 26, 1998 846 a mailbox, the person attached to the mailbox. The hide-creator and  David Byers committed Sep 13, 1997 847 848 849 secret bits are cleared automatically. Only one redirect can be specified.  David Byers committed Dec 29, 1998 850   851 @item x-face [9] (conference, letterbox, server)  David Byers committed Sep 13, 1997 852 853 854 855  Data is the face of the person in compface format. Cool, innit? This item can only be set by the conference supervisor or in the case of  David Byers committed Dec 26, 1998 856 a mailbox, the person attached to the mailbox. The hide-creator and  David Byers committed Sep 13, 1997 857 858 859 secret bits are cleared automatically.  860 @item alternate-name [10] (text, conference, letterbox)  David Byers committed Sep 13, 1997 861 862  Data is a string that the client may use as an alternate to the name of  David Byers committed Dec 26, 1998 863 864 865 a conference or the subject of a text. Note that the server does not match against this name when performing name lookups. Clients should only display alternate names created by the user currently logged on.  David Byers committed Sep 13, 1997 866 867 868 869 870 871 872  The inherit flag is automatically cleared. @item pgp-signature [11] (text) Data is a PGP signature of the text. The signature should be the  David Byers committed Dec 26, 1998 873 equivalent of what "pgp -sba" in PGP 2.6.2 generates.  David Byers committed Sep 13, 1997 874 875 876 877 878 879 880 881  The secret, hide-creator and inherit bits are automatically cleared. Signatures cannot be deleted once they have been created. @item pgp-public-key [12] (letterbox) Data is the public key of the person. It is desirable that the public  David Byers committed May 23, 1999 882 883 884 key contains a userid of the format "LysKOM +", where @var{n} is the number of the person in the LysKOM server specified in @var{server}. This rule is currently not enforced.  David Byers committed Sep 13, 1997 885 886 887 888  This item can only be set by the person himself. The hide-creator, secret and inherit bits are automatically cleared.  David Byers committed Dec 26, 1998 889   Per Cederqvist committed Aug 16, 1998 890 891 @item e-mail-address [13] (conference, letterbox, server)  David Byers committed Dec 26, 1998 892 893 Data is an RFC 822-style email address. When set on a mailbox, it should be the email address of the person. If the person has multiple  Per Cederqvist committed Aug 16, 1998 894 895 896 email addresses he may set serveral e-mail-address aux-items. The meaning of this aux-item when set on a conference that isn't a  David Byers committed Dec 26, 1998 897 898 899 mailbox is vague. For a conference that is used as to import a mailing list this should be the email address of the list. For other conferences we haven't really defined a sensible use.  Per Cederqvist committed Aug 16, 1998 900 901  When this aux-item is set on the server it shold contain the email  David Byers committed Jan 18, 1999 902 address of the administrator (or administrators.)  Per Cederqvist committed Aug 16, 1998 903   David Byers committed Dec 26, 1998 904 905 906 This aux-item can only be set by the supervisor of a conference or the server administrator. The creator cannot be hidden.  Per Cederqvist committed Aug 16, 1998 907 908 909 910  @item faq-text [14] (conference, server) Data is a decimal text number, which is a FAQ for the conference (or  David Byers committed May 12, 1999 911 912 server). Creating an item of this type automatically causes creation of a faq-for-conf item.  David Byers committed Dec 26, 1998 913 914 915 916  This item can only be set by the supervisor or server administrator. The hide-creator, secret, and inherit bits are automatically cleared.  Per Cederqvist committed Aug 16, 1998 917 918 919 920 921 922 923 924 925 926  @item creating-software [15] (text) Data is the name and version number of the client that created the text. This aux-item can only be set by the author of the text. Once set, it cannot be removed or changed. A typical value would be @samp{elisp-client 0.47.3}. Setting the creating-software aux-item is optional. The data should be the client name, a space, and the client version used  Per Cederqvist committed Apr 28, 2001 927 in the @reqlink{set-client-version} call. The server may enforce this  Per Cederqvist committed Aug 16, 1998 928 restriction.  David Byers committed Sep 13, 1997 929   David Byers committed Jan 14, 1999 930 @item mx-author [16] (text)  Jonas S Karlsson committed Oct 11, 1998 931   David Byers committed Jan 14, 1999 932 Data is a string containing the name of the author of an imported  Kent Engström committed Oct 20, 1999 933 934 935 936 937 938 e-mail, extracted from the @code{From} header. This aux-item may be missing, if the mail address in the @code{From} header consists of just the @code{addr-spec} (see the next aux-item). Clients should display this instead of the actual author of the text (which will be an importer ID) even if an mx-from aux-item is not present.  Jonas S Karlsson committed Oct 11, 1998 939   Kent Engström committed Jul 25, 1999 940 941 Sample contents: @code{Joe Q. Public} which may come from a @code{From} header containing @code{"Joe Q. Public" }.  Jonas S Karlsson committed Oct 11, 1998 942   David Byers committed Jan 14, 1999 943 @item mx-from [17] (text)  Jonas S Karlsson committed Oct 11, 1998 944   Kent Engström committed Jul 25, 1999 945 946 Data is the proper e-mail address (called @code{addr-spec} in the mail standards) extracted from the @code{From} header of an imported  Kent Engström committed Oct 20, 1999 947 948 e-mail.  Per Cederqvist committed Apr 16, 2001 949 950 Clients should display this address together with the @aux{mx-author}, preferably inside angles. If @aux{mx-author} is not present, this address  Kent Engström committed Oct 20, 1999 951 952 should be shown anyway. It can also be used by clients to construct an address for personal (e-mail) replies to an imported message.  Jonas S Karlsson committed Oct 11, 1998 953   Kent Engström committed Jul 25, 1999 954 955 956 Sample contents: @code{john.q.public@@example.com} which may come from a @code{From} header containing @code{john.q.public@@example.com} or something like @code{"Joe Q. Public" }.  Jonas S Karlsson committed Oct 11, 1998 957   David Byers committed Jan 14, 1999 958 @item mx-reply-to [18] (text)  Jonas S Karlsson committed Oct 11, 1998 959   Kent Engström committed Jul 25, 1999 960 961 962 963 Data is the proper e-mail address (called @code{addr-spec} in the mail standards) extracted from the @code{Reply-To} header of an imported e-mail. Clients should use this for constructing replies to imported messages.  Jonas S Karlsson committed Oct 11, 1998 964   David Byers committed Jan 14, 1999 965 @item mx-to [19] (text)  Jonas S Karlsson committed Oct 11, 1998 966   Kent Engström committed Oct 20, 1999 967 Data is a single e-mail address from an email @code{To} header.  Per Cederqvist committed Apr 16, 2001 968 Multiple @aux{mx-to} items may be present when multiple recipients are  Kent Engström committed Oct 20, 1999 969 970 specified in the header. Clients should display these items along with the normal LysKOM recipient headers.  Jonas S Karlsson committed Oct 11, 1998 971   Per Cederqvist committed Apr 16, 2001 972 973 Sample contents: Both @code{john.q.public@@example.com} and @code{"Joe Q. Public" } are valid.  Kent Engström committed Jul 25, 1999 974   David Byers committed Jan 14, 1999 975 @item mx-cc [20] (text)  David Byers committed Sep 13, 1997 976   Per Cederqvist committed Apr 16, 2001 977 Same as @aux{mx-to}, but applies to the @code{CC} header rather than  David Byers committed Jan 14, 1999 978 the @code{To} header.  Jonas S Karlsson committed Oct 11, 1998 979   David Byers committed Jan 14, 1999 980 @item mx-date [21] (text)  981   Kent Engström committed Oct 20, 1999 982 983 984 985 986 987 988 989 990 991 992 993 994 995 Data is the date and time from the @code{Date} header of an imported email. Its format is "YYYY-MM-DD hh:mm:ss TZ". YYYY is the year the message was sent, MM is the month, DD is the day, hh is the hour, mm is the minute and ss is the second. This date and time are given in the timezone where the message was sent. TZ is the timezone the date is valid for. It must be of the form "+hhmm" or "-hhmm", where hh is the number of hours offset from UTC and mm is the number of minutes offset. Symbolic timezones are not permitted. The timezone specification is recommended but optional, since it is not always available. Clients should display this information as the date and time a text was written, since the imported text will have been created at a later time. The date and time when the mesage was imported would then be displayed elsewhere or not at all.  996   David Byers committed Jan 14, 1999 997 998 @item mx-message-id [22] (text)  Kent Engström committed Oct 20, 1999 999 1000 1001 Data is the @code{Message-ID} header of an imported e-mail, with whitespace and comments removed. The Message-ID should contain the surrounding angles.  David Byers committed Jan 14, 1999 1002 1003 1004  @item mx-in-reply-to [23] (text)  Kent Engström committed Oct 20, 1999 1005 1006 1007 Data is a string containing one item of the same form as the mx-message-id item described above. This is the Message-ID of another mail the current text is a comment to.  David Byers committed Jan 14, 1999 1008   Kent Engström committed Oct 20, 1999 1009 1010 1011 1012 1013 Hopefully, this information comes from the @code{In-Reply-To} header of the imported e-mail, but it could also have been picked from the end of the @code{References} header line. If the text really comments more than one other text directly,  Per Cederqvist committed Apr 16, 2001 1014 it is allowed to attach more than one @aux{mx-in-reply-to} items to  Kent Engström committed Oct 20, 1999 1015 it.  David Byers committed Jan 14, 1999 1016 1017 1018  @item mx-misc [24] (text)  Kent Engström committed Oct 20, 1999 1019 1020 1021 1022 1023 Data is a string that contains all of the headers of an imported email, including @code{Subject}, and including those that are redundantly stored in other aux-items. The headers are concatenated with "\n". In other words, this item contains all headers of an imported e-mail as they appear in the message.  David Byers committed Jan 14, 1999 1024   Kent Engström committed Oct 20, 1999 1025 Clients are encouraged to provide a command to display this information.  Jonas S Karlsson committed Oct 11, 1998 1026   1027 @item mx-allow-filter [25] (conference, letterbox)  Jonas S Karlsson committed Oct 11, 1998 1028   Kent Engström committed Oct 20, 1999 1029 1030 1031 This aux-item has been declared obsolete. It was intended to supply the importer with information on how to filter incoming messages based on regular expressions matching header lines.  Jonas S Karlsson committed Oct 11, 1998 1032   1033 @item mx-reject-forward [26] (conference, letterbox)  Jonas S Karlsson committed Oct 11, 1998 1034   Kent Engström committed Oct 20, 1999 1035 1036 1037 This aux-item has been declared obsolete. It was intended to supplement mx-allow-filter by telling where rejected mails should be sent.  Jonas S Karlsson committed Oct 11, 1998 1038   David Byers committed Dec 26, 1998 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 @item notify-comments [27] (letterbox) Data is a decimal text number that the user is interested in. Clients should monitor this text for unread comments and present these to the user in some convenient manner. This is typically used by users that want to read comments to some text of theirs as soon as they arrive, rather than in the normal reading order. This item can only be set by the owner of the letterbox. No flags are forced or cleared.  David Byers committed Sep 13, 1997 1049   David Byers committed May 12, 1999 1050 1051 1052 1053 1054 1055 1056 1057 @item faq-for-conf [28] (text) Data is a decimal number specifying the conference a certain text is a FAQ for. The special number zero denotes that the text is a FAQ for the entire system. Items of this kind can only be created by the LysKOM server itself. Texts with this item are protected from garbage collection.  Per Cederqvist committed Aug 18, 1999 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 @item recommended-conf [29] (server) Data is a decimal number specifying a conference that new members should automatically be added to, optionally followed by a space and a recommended priority, optionally followed by a space and a membership type. In the future, additional data may be defined; clients should be prepared to accept and ignore a space and any trailing data that may follow the membership type. A few examples might clarify what the data may look like: @table @code @item 1 Conference number 1. @item 2 32 Conference number 2, with priority 32. @item 3 250 11100000 Conference number 3, with priority 250. The membership should be secret, passive and have the invitation bit set. @item 4 253 01000000 garbage Conference number 4, with priority 253. The membership should be passive. The client should ignore the trailing garbage. Note that  Kent Engström committed Oct 20, 1999 1079 clients are not allowed to create aux-items of this format, but the  Per Cederqvist committed Aug 18, 1999 1080 1081 1082 1083 1084 should be prepared to hande them correctly. @end table This is a recommendation only; it is up to the client that creates a new person to also add him to the conferences that are specified via  Per Cederqvist committed Apr 16, 2001 1085 @aux{recommended-conf}.  David Byers committed Sep 13, 1997 1086   1087 @item allowed-content-type [30] (conference, letterbox, server)  Per Cederqvist committed Aug 04, 2000 1088 1089 1090 1091  Data is a non-negative decimal priority number, followed by a space, followed by a LysKOM content type glob pattern. Clients should send texts to a conference only if the content-type matches any of the  Per Cederqvist committed Apr 16, 2001 1092 @aux{allowed-content-type} glob patterns of that conference.  1093   Per Cederqvist committed Apr 16, 2001 1094 1095 1096 1097 If the conference doesn't have any @aux{allowed-content-type}, the @aux{allowed-content-type} items of the server should be used. If the server also has no @aux{allowed-content-type} aux-items, it should be interpreted as if a single @aux{allowed-content-type} aux-item with the  1098 value @samp{1 text/plain} exists.  Per Cederqvist committed Aug 04, 2000 1099   Per Cederqvist committed Apr 16, 2001 1100 If there are @aux{allowed-content-type} aux-items with different  1101 1102 priority numbers, it is a hint to the client about which content-type is most desirable. Content-types that matches a lower priority number are  Per Cederqvist committed Aug 04, 2000 1103 1104 1105 preferred. As an example, consider a conference with the following four  Per Cederqvist committed Apr 16, 2001 1106 @aux{allowed-content-type} aux-items:  Per Cederqvist committed Aug 04, 2000 1107 1108 1109 1110 1111 1112 1113 1114  @example 1 text/plain 2 x-kom/basic 2 text/enriched 3 text/* @end example  Per Cederqvist committed Apr 16, 2001 1115 1116 1117 1118 1119 These aux-items taken together means that @samp{text/plain} is preferred, that @samp{x-kom/basic} and @samp{text/enriched} can be used if there is a reason why @samp{text/plain} is inadequate, and that any text type (such as @samp{text/html}) is acceptable. Other content types, such as @samp{x-kom/user-area}, should not be used.  Per Cederqvist committed Aug 04, 2000 1120 1121 1122 1123 1124 1125 1126  The server does not currently enforce the above restriction on the content type of new texts. This mechanism is currently a hint to the client (or to the author of a new text). This may change in the future, if experience shows that it is desirable to have the server enforce the content type.  David Byers committed Dec 26, 1998 1127 1128 @end table  Per Cederqvist committed May 23, 1999 1129 @node Client-Specific Aux-Item Types  Per Cederqvist committed Apr 04, 1999 1130 @subsection Client-Specific Aux-Item Types  David Byers committed Sep 13, 1997 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144  Client-specific items do not cause the server to perform any magic. All the flags (except the delete flag) are left untouched, the data is not validated in any way, and anyone can create any item. If you need more server support than this, your item should be on the predefined list. All tags in the range 10000-19999 are reserved for clients. Blocks of 100 numbers at a time can be assigned to specific clients. A client should never create items with tags in a range assigned to another client or in an unassigned range. Assigned ranges will never change. Currently, the following ranges are assigned to clients: @itemize @bullet @item 10000-10099: The Elisp Client  David Byers committed Oct 09, 1999 1145 @item 10100-10199: komimportmail  David Byers committed Sep 13, 1997 1146 1147 1148 1149 1150 @end itemize If you want a range of numbers, send e-mail to the LysKOM development group.  Kent Engström committed Oct 20, 1999 1151 @menu  Per Cederqvist committed Apr 30, 2001 1152 * komimportmail Aux-Item Types::  Kent Engström committed Oct 20, 1999 1153 1154 1155 1156 1157 @end menu @node komimportmail Aux-Item Types @subsubsection komimportmail Aux-Item Types  Per Cederqvist committed Apr 16, 2001 1158 During the design and implementation of the @command{komimportmail} mail  Kent Engström committed Oct 20, 1999 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187