home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / OFFLINE / VALEN130.ZIP / VALENCE.DOC < prev    next >
Text File  |  1993-08-17  |  42KB  |  854 lines

  1. \WHValence QWK Door v. 1.3 by William McBrine
  2. Copyright (c) 1993 Iconoclast Software
  3.  
  4.  
  5.                      \BL:\RD*\BL:\RD*\BL:\RD*\BL: USER DOCUMENTATION :\RD*\BL:\RD*\BL:\RD*\BL:
  6.  
  7.  
  8. \LB:::: \WHINTRODUCTION\LB ::::\NO
  9.  
  10. Welcome to Valence, the powerful QWK door for Searchlight. This program will
  11. allow you to read and reply to messages offline, with all the convenience
  12. and power of Searchlight, and more. It's packed with features. Writing them
  13. is more fun than writing about them, and I'm pressed for time, so I'll try
  14. to make this summary brief. To find out more about the door, explore it.
  15. I've tried to make it fairly simple to use.
  16.  
  17. I hope you enjoy using it as much as I enjoyed writing it.
  18.  
  19.  
  20. \LB:::: \WHQUICK START\LB ::::\NO
  21.  
  22. (No pun intended.) Just run the door, Download, answer "Y" when prompted,
  23. and enjoy! There is no mandatory setup. There are slews of options, but they
  24. all have default values. You can start QWKing right away, then go back and
  25. explore the options when you're more comfortable with it.
  26.  
  27. Ask your sysop or someone who you know uses offline mail for help on setting
  28. up a "Reader" program. They're all different, but pretty simple really. If
  29. you're game, just download one and try it. There should be at least one
  30. available for download on \%s.
  31.  
  32. If you don't want to fool with a reader program yet, you can try Valence in
  33. Text mode. (I actually programmed this part first.) This is mainly intended
  34. as a preview, or for use with systems that don't have QWK Readers, but it's
  35. pretty nice as is. In fact, I honestly would rather read Text packets from
  36. Valence than QWK packets from some other doors I've been inflicted with.
  37.  
  38. Note that the file MESSAGES.TXT will actually be an ANSI file, unless you
  39. turn off color codes in the Options section.
  40.  
  41.  
  42. \LB:::: \WHDOWNLOAD\LB ::::\NO
  43.  
  44. You can download in either Text or QWK packet mode (this file, whether
  45. you're reading it as a Bulletin or a help screen, is an example of what the
  46. text mode looks like). Downloaded packets include - at your option - new
  47. mail and messages, new bulletins, a system news file (if the sysop has
  48. provided for one), a list of new files, a SESSION.TXT file, and three
  49. pointer files.
  50.  
  51. The first time you download, you'll see the prompt:
  52.  
  53. The subboard list has been changed since your last download.
  54. Please upload any existing .REP files before proceeding.
  55.  
  56. Proceed? (Y/N)
  57.  
  58. If you have any packets from other/previous QWK doors that you want to
  59. upload to Valence, answer "N" to this prompt, and go back and upload them
  60. first. Otherwise, go ahead... later, you may see this prompt again, when the
  61. sysop has added or deleted subboards, or your access has changed. When you
  62. do, it's important that you upload the older replies first, or they may go
  63. to the wrong subboards. This is the one negative side effect of Valence's
  64. handling of conference numbers (see below for more info). On the up side,
  65. you'll always know when subboards are added to the board. :-)
  66.  
  67. Next you'll see
  68.  
  69. Copying WELCOME
  70.  
  71. (which may or may not appear, and may be followed by NEWS and/or GOODBYE)
  72.  
  73. and then scans for new bulletins, messages, and files. Any new bulletins
  74. found are listed by number. For the new message display and new files
  75. display, you have a choice of several display modes. By default, you get the
  76. area descriptions while scanning both messages and files. Other options are
  77. described later in this document.
  78.  
  79. If you reach the maximum number of messages per packet, or the maximum
  80. number of messages in any subboard (these are user-selectable; see below),
  81. and you still have more new messages, you'll see this:
  82.  
  83. *** Your packet is full, but you have more new messages ***
  84.  
  85. Then, unless there were no new messages, the packet will be archived, and
  86. you'll be prompted:
  87.  
  88. Download this packet? (Y/N/G)
  89.  
  90. "Y" and "N" are self-explanatory; "G" stands for "Goodbye after download".
  91. This option will hang up on you after the transfer is completed, with a
  92. ten-second delay in which you can abort the hangup, much like a download
  93. from Searchlight. Unlike some other doors I've seen, this WORKS in Valence,
  94. and I recommend always using the "G" option, unless you have a very small
  95. packet or are on at high speed (so it won't take long).
  96.  
  97. After the above prompt, you'll be asked to choose a protocol if you don't
  98. have one set in the BBS. If you do, you don't have to set it in Valence; it
  99. will use the BBS protocol automatically. However, if you WANT to use a
  100. different protocol for Valence, you have that option, too.
  101.  
  102. If you're using a bidirectional protocol, and you have some .REPs to upload,
  103. you can upload them while downloading, and Valence should process them when
  104. the download is complete.
  105.  
  106. You also have the option to download multiple packets at once; see below for
  107. details.
  108.  
  109.  
  110. \LB:::: \WHUPLOAD\LB ::::\NO
  111.  
  112. When you select this option, Valence will jump right into the upload -
  113. unless you don't have a protocol selected, in which case it will prompt you
  114. for one, as above. There is no option to hang up after upload, for the
  115. simple reason that I personally have rarely encountered a .REP file much
  116. over 10k, 5k being a more usual size. The file transfer should be over in a
  117. snap, and when your terminal program returns from its protocol display, you
  118. may find your new messages already posted. :-) It's pretty fast. It also is
  119. not very prone to lockups.
  120.  
  121. If you're using a batch protocol, you can upload multiple .REP files in one
  122. transfer. The name can be anything, but the extension must be .REP. (If you
  123. attempt to upload .REPs from another BBS, they will still be rejected; the
  124. filename of the .REP isn't the indicator.) After the transfer, Valence will
  125. AUTODETECT the compression method of each .REP file, instantly, and extract
  126. it with the appropriate program. When processing uploaded .REPs, Valence
  127. doesn't care what you've set for your archiver choice and pays no attention
  128. to it whatsoever. You can download with ZIP and upload with ARJ, for all it
  129. cares.
  130.  
  131. Uploaded messages are threaded automatically. "Low-bit" characters, which
  132. cause problems with Searchlight, are converted. (ESC codes, in particular,
  133. are converted to the character <`>, which is recognized by many offline
  134. reader programs as an ESC replacement in ANSI sequences. Thus uploaded ANSI
  135. will be preserved for other QWKers, though not for online reading in
  136. Searchlight.) In echomail subboards, "high-bit" characters are converted,
  137. and "Fido-style" taglines are enforced automatically. You have the option to
  138. switch this on and off for each subboard (echo and non-) individually.
  139.  
  140. ADD, DROP, RESET, and CONFIG control messages are supported. (See below for
  141. details.) Valence will recognize messages addressed to "VALENCE", "QMAIL",
  142. or "SLQWIK" as control messages. These messages are not counted in your
  143. "total uploaded messages".
  144.  
  145. When your user record is first created, your subboard list is initialized in
  146. "yucky" mode (q.v.), although the yucky mode flag is set to false. This
  147. allows you to upload packets from older/other QWK doors before doing
  148. anything else - handy if the sysop has installed Valence as a replacement
  149. and deleted the other door.
  150.  
  151. \LB*** Long subject lines and "Fwd From" lines ***\NO
  152.  
  153. The subject field of a QWK message is only 25 characters, but a Searchlight
  154. message's subject can extend to 40 characters. As mentioned elsewhere,
  155. Valence automatically includes subject lines that go over the 25-character
  156. limit in the body of the message; beginning with version 1.2, Valence will
  157. also let you post messages with long subject lines. To do so, include a line
  158. of the form
  159.  
  160. Subject: This subject is too long for QWK packets
  161.  
  162. as the first line in the text of the message.
  163.  
  164. Immediately following this line, or by itself as the first line of the
  165. message, you can also include a "Fwd From" message up to 40 characters long
  166. using the form
  167.  
  168. Forward: Nowhere in particular
  169.  
  170. When a long subject and/or "Fwd From" line is used, these lines are removed
  171. from the text, along with the next line if the next line is blank.
  172.  
  173. \LB*** Netmail ***\NO
  174.  
  175. Beginning with version 1.1 of Valence, under Searchlight 3.0+ you can send
  176. netmail messages from Valence. Netmail is not really part of the QWK
  177. standard, so it has to be kludged in. To send a netmail message, it must
  178. either be in the MAIL conference or marked as private. The first line in the
  179. text of the message, or the first line after a "Subject:" line (see above)
  180. should be either of the form
  181.  
  182. Netmail: 1:379/301
  183.  
  184. or the form
  185.  
  186. @1:379/301
  187.  
  188. The second form is a little more flexible, in that it will also work with
  189. quote-marking characters in front of it; e.g.:
  190.  
  191. WM>@1:379/301
  192.  
  193. The first form mirrors what Valence does to indicate a received netmail
  194. message, so you can reply to a netmail message simply by removing the
  195. quote-marking characters from the first line of the quoted text.
  196.  
  197. Valence's netmail capability is still a little limited. You can't send
  198. Crashmail (a "Yes" to the "Send Immediately?" question that sometimes pops
  199. up in Searchlight's internal netmail function), and the nodelist is not
  200. read, so you need to have the attributes for "originate" and "unlisted" to
  201. send netmail with Valence. Ask your sysop about netmail access.
  202.  
  203. When a netmail message is posted, the address line is removed from the text,
  204. along with the next line if the next line is blank.
  205.  
  206. If using both "Subject:" and "Netmail:", "Subject:" must come first.
  207. "Netmail:" overrides "Forward:" (they use the same area in Searchlight's
  208. message header), so they cannot be used together.
  209.  
  210.  
  211. \LB:::: \WHOPTIONS\LB ::::\NO
  212.  
  213. There are altogether too many options in the Options section, but that's
  214. better than too few. Valence allows you substantial control over the size
  215. and shape of your packet.
  216.  
  217. There are three screens of options. On the first screen, you can set your
  218. choice of Archiver, Protocol (here you can set new protocols for both
  219. Searchlight and Valence, together or separately), packet size in number of
  220. messages, and ten yes/no options. These options will be explained in more
  221. detail at the end of this file.
  222.  
  223. At each numeric prompt, you'll see a range of numbers in parentheses, along
  224. with another number in brackets. These are the maximum, minimum, and default
  225. values. If you just press <RETURN>, the default will be used.
  226.  
  227. Note that most changes in options can be discarded when you leave the
  228. Options section by answering "N" at the "Save changes?" prompt, BUT, the BBS
  229. protocol selection and Alias name are written to Searchlight's user file at
  230. the time you edit them and are not affected by this prompt.
  231.  
  232. \LB*** ANSI/Translation ***\NO
  233.  
  234. The ANSI/Translation screen allows you to set the default mode Valence uses
  235. in translating messages. By default, all translation is ON. When I first
  236. wrote it, I thought the translation might slow message exporting down a bit,
  237. but there proved to be no detectable difference. Thus you can run with full
  238. Searchlight translation, without overhead. Color codes may be translated to
  239. ANSI, stripped, or simply passed through. Note that translating to ANSI
  240. takes precedence over stripping if both are set to "YES". Metacharacters
  241. (like your name, \%k) may be translated or passed through. The use of
  242. underline characters to join lines may be turned on or off, and this is one
  243. case where I might recommend setting it to "NO", because this feature of
  244. Searchlight is rarely used, and in my own experience I get much more
  245. unintentional wrapping than deliberate, from people using underline chars
  246. for other reasons (as, for instance, to indicate the title of a book).
  247.  
  248. Just as in Searchlight, all translation is also applied to included files,
  249. except - as in Searchlight - for underline joining and including files
  250. (which could lead to infinite recursion). Thus with the default settings,
  251. you should get in your QWK packet just what you would see if you were
  252. reading online in Searchlight.
  253.  
  254. The ANSI wrap is a little feature I had to add when I saw what SLMR did to
  255. the included files that had lines which went over 80 characters. My wrap
  256. will split the lines nicely, and join them with <ESC>[s and <ESC>[u
  257. sequences. This works great for most ANSI pictures, but will mess up ones
  258. that scroll the screen. If your reader will handle long lines, you may want
  259. to reset the wrap length to 255, so they'll all come through correctly. The
  260. wrapping is only applied to included files, not regular text, and only in
  261. QWK mode.
  262.  
  263. There's a special option here to strip flashing codes, for people like me
  264. who find it annoying. Other color codes will be unaffected. Only Searchlight
  265. flashing codes will be removed, not actual ANSI sequences from included
  266. files.
  267.  
  268. The "Color the filelist" option puts NEWFILES.DAT in color. I feel it's a
  269. distinct improvement over plain text, but you might want to leave this off
  270. if your reader doesn't like it (the majority, it seems, don't; SLMR and OLX
  271. do), or to save space, or because you just don't like the color scheme. This
  272. option is ignored in Text packet mode, where the regular ANSI conversion
  273. attributes are checked instead.
  274.  
  275. All translation options are global defaults, and can be reset for each
  276. subboard. You can have some subboards with colors, and some without; some
  277. with metacharacters, and some without. Mix and match any way you like!
  278.  
  279. \LB*** Advanced options ***\NO
  280.  
  281. The first option on this menu is "Alias name". There is a field defined in
  282. the Searchlight user file for this; it's been there for some time, but
  283. Searchlight doesn't use it. Well, now Valence uses it. (I've heard there's
  284. another program out now which uses it, too, but I haven't seen it.) When you
  285. set your alias, Valence will scan the user file to make sure no one else is
  286. using it for either their name or alias. To delete your alias name, just hit
  287. <ENTER> when Valence prompts you for a new name.
  288.  
  289. Valence uses the alias name in two ways: when scanning for new personal
  290. messages, and when posting to an "Anonymous"-allowed subboard, where you can
  291. post with your alias, real name, or "ANONYMOUS". This is a bit of a kludge;
  292. let me know if you have any better ideas on how to implement alias support.
  293.  
  294. The rest of the Advanced options will be explained at the end of the
  295. document.
  296.  
  297.  
  298. \LB:::: \WHSUBLIST\LB ::::\NO
  299.  
  300. The subboard list editor allows you to join, unjoin, mass join/unjoin, set
  301. new high message markers, and set the special options for each subboard that
  302. you have access to. You can page through it easily with the + and - keys.
  303. Most of these options are, I hope, fairly self-explanatory.
  304.  
  305. Note that you are not allowed to unjoin or edit the MAIL subboard, even
  306. though it's displayed. The attributes used for the MAIL subboard are
  307. controlled by the global variables only.
  308.  
  309. Each line of the display in the subboard list shows the number, the name,
  310. the long description, the high message (i.e., your last read message), the
  311. number of the last message in the subboard, and the special attribute list.
  312. This last one looks a little cryptic; the header says "PAHFSCM". These
  313. letters each stand for a flag; there are seven flags packed into a byte for
  314. each subboard. The flags are:
  315.  
  316. \WHP = Personal Only
  317. A = Personal + All ;This takes precedence over P\NO
  318. H = High Bits Allowed
  319. F = Enforce Fido Taglines
  320. S = Strip Color Codes
  321. C = Convert Color Codes
  322. M = Convert Metacharacters
  323.  
  324. The last three, we've already seen under Options. Here you can reset them
  325. for each subboard. Note that these three options are not really active,
  326. UNLESS you explicitly set them with the <C>hange attributes command.
  327. Otherwise, the global values are active. There is a hidden eighth bit, the
  328. master bit, which controls whether these three options are checked.
  329.  
  330. \LB*** High bits allowed, Enforce Fido taglines ***\NO
  331.  
  332. These two options are also subject to the master bit. By default, "high-bit"
  333. characters - those in the range 128-255 - are excluded from echomail areas,
  334. and Fido-style taglines are required there. (This is a rule in most Fidonet
  335. echos. Violating it will get you reprimanded by the moderator.) This is
  336. reversed for local subboards.
  337.  
  338. When Valence is asked to translate the high-bit characters in incoming
  339. messages, it does a rapid translation with a lookup table that turns the
  340. high-bits into similar-looking low-bit ones. (This translation is performed
  341. when high bits are allowed, too, to take care of some other problem
  342. characters; Valence just uses a different table then.) To make "Fido-style"
  343. taglines, "tearlines" are converted from "---" to "-=-".
  344.  
  345. What this boils down to is, you don't have to worry about setting Fido-style
  346. taglines in your reader, or using high-bit characters in messages. You can
  347. do as you like, and Valence will take care of it for you. If, however, you
  348. have an echo conference on which high-bit characters ARE allowed, or you
  349. want to change either of these options for a subboard for whatever reason,
  350. the options are here.
  351.  
  352. \LB*** Personal only and Personal/All ***\NO
  353.  
  354. These two options are the most useful. They are not subject to the master
  355. bit; which is to say, you can set either of these without it affecting the
  356. non-preservation of the other attributes.
  357.  
  358. Instead of having to download all the messages on a subboard, you can set
  359. that subboard to scan for just messages addressed to you (and your alias
  360. name, if one is set), or just messages to you and "ALL". There are two
  361. mass-join features on the main SubList menu to facilitate this; unlike the
  362. <X> toggle option, which only applies to the subboards on the screen before
  363. you, the <P> and <A> options will join ALL unjoined subboards which you have
  364. access to, in either personal or personal/all mode.
  365.  
  366. When Valence is looking for messages to all, it also counts those where the
  367. first four characters of the To: field are "ALL ", OR, the first five
  368. characters of the field are "EVERY". This means it will include messages
  369. addressed to "Everybody", "Everyone", and "All You Zombies" (to quote The
  370. Hooters).
  371.  
  372. Note that when you join a subboard in personal or personal/all mode, you are
  373. genuinely Joined to that subboard, as far as Searchlight is concerned, and
  374. if you then do a New/Joined scan from Searchlight, you'll hit that subboard
  375. (without the benefit of personal/all filtering).
  376.  
  377. All edited attributes will follow the subboards they're attached to if their
  378. conference numbers change.
  379.  
  380. For an amusing display, try the subboard list in "yucky" mode. The numbers
  381. can end up in any order. This is what your CONTROL.DAT file will look like
  382. in yucky mode, too.
  383.  
  384.  
  385. \LB:::: \WHPOINTERS\LB ::::\NO
  386.  
  387. Most other QWK doors only give you one pointer file, but with Valence you
  388. get three for the price of one.
  389.  
  390. A pointer file is a record of the "high message markers" in each conference.
  391. Valence only records the ones it updates. The one with the .PTO extension
  392. contains the old pointers, from before your download; the .PTN file is what
  393. Valence sets them to after a successful download. (The .PTN file is the
  394. actual file read by Valence at the end of a download when it says "Updating
  395. pointers".) The .PTX file is not really a pointer file, but a copy of your
  396. record in Valence's user file.
  397.  
  398. You'll rarely have to use any of these files, or this feature of the menu,
  399. but they're there if you need them. The pointer files are placed first in
  400. the packet, so that if you have a failed transfer, they'll be most likely to
  401. get through.
  402.  
  403. If your packet was corrupted in downloading, but you can still extract the
  404. .PTO file, and Valence thought your transfer went ok and updated your
  405. pointers, (ARGH!) you can upload the .PTO file to put things back the way
  406. they were before the transfer and redownload the messages.
  407.  
  408. If there's a crash on the BBS, and it's restored from yesterday's backup,
  409. and all your message pointers are set back to what they were the day before,
  410. you can upload the .PTN file to avoid rereading.
  411.  
  412. If you get a "The subboard list has been changed since your last download"
  413. message, and you really want to go on and download, but you haven't finished
  414. replying to your last packet yet, go ahead and download. Then go back and
  415. finish replying to the first packet, and upload the .PTX file from it, THEN
  416. the .REP. Then, before you upload your .REP to the new packet, upload the
  417. .PTX file from it. Make sure you keep the .REPs SEPARATE!
  418.  
  419.  
  420. \LB:::: \WHCONTROL MESSAGES\LB ::::\NO
  421.  
  422. These are messages you send to Valence in a .REP to configure it in the same
  423. way as you would online. All the options of online configuration are
  424. available here, with the exception of subboard attributes other than
  425. personal and personal/all. The form of a control message is a message
  426. addressed to "VALENCE", with the subject either "ADD", "DROP", "RESET", or
  427. "CONFIG".
  428.  
  429. "ADD", "DROP", and "RESET" are standard messages which can be generated by
  430. some readers automatically. If you're doing it manually: The message should
  431. be sent in the conference (subboard) to be added, dropped, or reset.
  432. Following the command in the subject for "ADD" and "RESET" may be a number;
  433. this number is the new high message to set for that subboard. If it's
  434. positive, it's an absolute message number; if it's negative, it's an offset
  435. from the last message on the subboard. If no number is given, ADD sets the
  436. high message to 0, and RESET sets it to last message on the subboard. The
  437. ADD command may further be followed by a "Y" to indicate join in personal-
  438. only mode, or a "YA" for join in personal/all.
  439.  
  440. "CONFIG" messages are a little more complicated. These allow you to set all
  441. the options you can set in Valence online, as well as joining and dropping
  442. multiple conferences from within a single message. "CONFIG" is the subject,
  443. and the message may be sent in any conference. Each line of the message
  444. consists of a command keyword, followed by optional parameters. You can use
  445. these keywords in any order, and case is irrelevant. Comments may be added
  446. to the message with semicolons, and blank lines will be ignored. The
  447. commands are as follows... "#" represents a number, brackets indicate an
  448. optional parameter:
  449.  
  450. \YEADD   <conference> [#] [Y] [YA]
  451. DROP  <conference>
  452. RESET <conference> [#]\NO
  453.  
  454. As when used in the subject field, with the addition of the conference
  455. number.
  456.  
  457. \YEMAXSUB   #  ; Maximum number of messages per subboard
  458. MAXTOTAL #  ; Maximum number of messages per packet
  459.  
  460. These values are not absolute. Starting in Valence version 1.2, if you hit
  461. the limit on a given subboard, but you have five or fewer messages to go,
  462. they'll be included too.
  463.  
  464. VPROTO   #  ; Set Valence's protocol to this number
  465. SLPROTO  #  ; Set Searchlight's protocol to this number
  466.  
  467. ARCHIVER  name\NO
  468.  
  469. Set your archiver choice to the one named, if the name is found.
  470.  
  471. \YEALIAS     name  ; Set/reset your alias
  472.  
  473. ANSIWRAP  #     ; Set ANSI wrap length to this number\NO
  474.  
  475. The remainder of the options are "boolean-type". Put a "Y" or "Yes" after
  476. each keyword to set it to "Yes" (true), or a "N" or "No" to set it to "No"
  477. (false).
  478.  
  479. \YEUNDERJOIN   ; Join lines with underline      Default: \WHYes\NO
  480. \YEMETACHARS   ; Replace metacharacters         Default: \WHYes\NO
  481. \YESTRIPCOL    ; Strip color codes              Default: \WHYes\NO
  482. \YEANSICOL     ; Translate color codes to ANSI  Default: \WHYes\NO
  483. \YEFLASHOFF    ; Ignore flashing codes          Default: \LRNo\NO
  484. \YEFILECOLOR   ; Color the filelist             Default: \LRNo\NO
  485. \YEINCLUDE     ; Expand included files          Default: \WHYes\NO
  486.  
  487.  
  488. \LB:::: \WHMORE YES/NO OPTIONS\LB ::::\NO
  489.  
  490. As promised, an explanation of all the unexplained options. These will be
  491. listed both as they appear on the Options screens and with their
  492. CONFIG-message keywords.
  493.  
  494. \YEMARK        ; Mark new messages as read    Default: \WHYes\NO
  495.  
  496. If set to YES, Valence will update the high message pointers in all scanned
  497. subboards, and increment the number of times read of, or delete, each
  498. private MAIL message, after a successful packet download. About the only
  499. reason you'd want to set this to NO is for testing purposes.
  500.  
  501. \YETEXT        ; Text packets instead of QWK  Default: \LRNo\NO
  502.  
  503. Text packets (mentioned above) combine the new bulletins, new messages, and
  504. new files into a single large text (or ANSI) file, and archive it together
  505. with the pointer files and WELCOME/NEWS/GOODBYE/SESSION.TXT files, if those
  506. are selected. Where QWK packets use the extension .QWK, Text packets use the
  507. default extension of the archiver (.ZIP, .ARJ, .LZH, etc.). You won't be
  508. able to reply offline to messages downloaded in Text format. Other than
  509. that, this mode is identical to QWK mode.
  510.  
  511. \YEFILES       ; Include new files listing    Default: \WHYes\NO
  512.  
  513. Valence will scan all directories you have access to, sorted by MAIN.DIR,
  514. for new files, and list any it finds in the file NEWFILES.DAT (or
  515. MESSAGES.TXT in Text mode).
  516.  
  517. \YEBULLETINS   ; Include new bulletins        Default: \WHYes\NO
  518.  
  519. You can leave them out if you want. The only time I'd do that is if the
  520. board I was on was updating ten a day or so, and they were all game high
  521. score files. (I've been in that situation, in fact, but not on a Searchlight
  522. board (so far).) Note these are scanned for by date, and you may have
  523. bulletins being updated without the date being changed. If so, encourage
  524. your sysop to use BUPDATE.EXE, provided with the Valence package.
  525.  
  526. \YENEWONLY     ; DL only new private mail     Default: \LRNo\NO
  527.  
  528. By default, Valence will download all the old junk you've kept online in
  529. your mailbox, as well as the new mail...
  530.  
  531. \YEKILLMAIL    ; Kill private mail after DL   Default: \WHYes\NO
  532.  
  533. ...and then, delete it. You can save it from your reader, which should be
  534. more convenient, and certainly will be more convenient to your sysop. Just
  535. please BE AWARE that this is being done, and don't just discard a packet,
  536. thinking that your old mail is still saved on the BBS.
  537.  
  538. The defaults here are partly to keep the MAIL subboard clean of old
  539. messages, and partly a personal preference, because I too am guilty of
  540. letting huge numbers of messages collect in my Searchlight mailboxes. Or
  541. rather, I used to be; now Valence keeps 'em empty for me. And it works a lot
  542. better than what I used to do: wait until I had a couple dozen accumulated,
  543. then jump to DOS, read them with SLMAIL, archive them, move them to the
  544. uploads directory, return to the BBS, download the archive, kill it, and
  545. purge my mail. Valence does the same thing (and much more) automatically
  546. (and it runs faster than SLMAIL, and purges faster than Searchlight).
  547.  
  548. \YEOWN         ; DL messages FROM yourself    Default: \LRNo\NO
  549.  
  550. The default saves a little space by keeping you from downloading what you
  551. just uploaded.
  552.  
  553. \YEYUCKY       ; Yucky conference numbers     Default: \LRNo\NO
  554.  
  555. OK, this is a BIG one.
  556.  
  557. \LB*** Conference numbers in Valence ***\NO
  558.  
  559. One of the biggest features of Valence is the way it handles conference
  560. numbers. This has been alluded to earlier in this document; here are the
  561. details:
  562.  
  563. Searchlight uses 8-character names (which are DOS filenames) to identify its
  564. subboards. The QWK format uses "conference numbers" to identify each area.
  565. These are matched to names with the CONTROL.DAT text file, but it's the
  566. conference numbers which are used to tell what area a message came from, and
  567. the conference numbers which are used to tell the door what area a reply is
  568. going to. So far, so good; it isn't hard to generate a list of numbers to
  569. match a list of names. But there IS a MAJOR problem here, in that with
  570. Searchlight, a new subboard can be inserted in between two existing ones, or
  571. an old subboard can be deleted, moving the subboards that follow it on the
  572. list up one place. If the subboards are numbered sequentially, then, and
  573. subboards are added or subtracted in between the time you download a packet
  574. and the time you upload a reply, the conference numbers stamped on your
  575. reply messages may no longer be valid. That means the messages you upload
  576. will be posted to the wrong subboards.
  577.  
  578. So, you can't use sequential numbering of the subboards in Searchlight - at
  579. least, not without some trickery. So what DO you do? How do you make a
  580. sensible translation from Searchlight's named subboards to the QWK format's
  581. numbered conferences? ...A translation that will hold up when subboards are
  582. added or deleted?
  583.  
  584. The first solution attempted in a QWK door for Searchlight was SLQWiK's use
  585. of the absolute record number of a subboard in the SUBBOARD.SL2 file (the
  586. master list of subboards). This number won't change, as long as the subboard
  587. exists. If the subboard is removed, it's marked as a deleted record, and the
  588. record numbers don't change. If a new subboard is added, it will be added to
  589. the end or inserted in a previously deleted record.
  590.  
  591. As far as I know, Jack Ridgway hacked this method out himself, which was
  592. pretty clever. It was successful enough that Frank LaRosa then adopted it as
  593. the "official" way of making unchangeable reference numbers, by adding an
  594. "absolute record number" field to the subboard information returned by the
  595. subboard list intializer in the Searchlight Programmer's Library.
  596.  
  597. But this method leaves something to be desired. The numbers you end up with
  598. in CONTROL.DAT are in a random order. This is very ugly, to say the least,
  599. and can mess up many readers. (SLMR, for one, can't make a correct ".MRB"
  600. bookmark file for packets like this. If you come back to reread such a
  601. packet after exiting SLMR, the "Read" markers will be all over the place.)
  602. When I set out to write my own QWK door, this was one of the first things I
  603. wanted to fix. The way I saw it, the subboard list in your reader should
  604. look just like the one you see in Searchlight - sorted by MAIN.SUB, etc. -
  605. with nice sequential numbers in the CONTROL.DAT, and no gaps. And that's
  606. what Valence gives you.
  607.  
  608. Internally, Valence keeps a table of sequential numbers -> absolute record
  609. numbers - one for each user. This list is recalculated every time you select
  610. the "Download" or "SubList" function, and is compared to the stored list. If
  611. it's different, you get the "Subboard list has been changed" warning
  612. message.
  613.  
  614. When you upload a .REP file, the conference numbers in the .REP are
  615. translated back to absolute record numbers, using the stored table from your
  616. last download or edit, and thence to subboard names. Thus the messages will
  617. go the right subboards as surely as if I used absolute record numbers. The
  618. difference here is, you have more opportunity to mess it up, by ignoring the
  619. "Subboard list has been changed" prompt, and then uploading .REPs to
  620. previous packets. I see this as an unlikely scenario (but see above under
  621. POINTERS), although my personal message-reading habits make it more likely
  622. for me than average. :-)
  623.  
  624. When you first enter Valence, it intializes your list to an absolute record
  625. number list, so that you can upload .REPs from other QWK doors as the first
  626. thing you do. After your first download, however, you'll have to set Valence
  627. to "Yucky mode" (ah, finally we come to that) if you want to interchange
  628. .REP files between it and another QWK door.
  629.  
  630. \LB*** Yucky mode ***\NO
  631.  
  632. Yucky mode discards the usual Valence method of generating conference
  633. numbers, and uses absolute record numbers for conference numbers. I call it
  634. that because it's yucky. I DON'T RECOMMEND ITS USE, EVER, EXCEPT IF YOU
  635. *HAVE* TO UPLOAD A .REP FROM ANOTHER QWK DOOR. You might also use it if
  636. you're paranoid about the possibility of uploading a message into the wrong
  637. subboard. That can't happen in yucky mode (unless you upload replies to a
  638. packet downloaded in NON-yucky mode). It will RARELY happen in Valence ever,
  639. and will NEVER happen if you follow the prompts, but yucky mode offers a
  640. very tiny extra margin of security.
  641.  
  642. \YENUMBERED    ; Numbered packet names        Default: \WHYes\NO
  643.  
  644. This option appends a two-digit number to the name of each of your packets.
  645. The number used is the number of the packet mod 100. My own opinion of
  646. numbered packets is that they're unaesthetic, but useful. I first saw this
  647. feature in SLQWiK, and it's the one point (aside from devising the use of
  648. absolute record numbers) on which I give Jack Ridgway a lot of credit. Note
  649. that unlike SLQWiK, Valence pads numbers below ten out with a zero, so the
  650. packets will sort correctly.
  651.  
  652. If you're doing a non-stop multiple-packet download, and you DON'T have
  653. numbered packets selected, Valence will rename files after the first one in
  654. the form: <BBBSID>.QW0, .QW1... .Q96, .Q97. Valence will in no case allow
  655. you to download more than 99 packets at a time. :-)
  656.  
  657. \YEEMPTY       ; DL packets with no messages  Default: \LRNo\NO
  658.  
  659. Valence will terminate with an error and return to the BBS if this is set to
  660. NO and it finds no new messages. Please note that if you DO have new
  661. *bulletins* or new *files*, Valence will still abort (it won't even scan the
  662. files), so you might want to set this to YES.
  663.  
  664. \YEWELCOME     ; Include Welcome and Goodbye  Default: \WHYes\NO
  665.  
  666. If YES, and these files exist, they will be included in the packet. These
  667. are normally ANSI screens, and default to Searchlight's LOGIN.ANS and
  668. LOGOFF.ANS.
  669.  
  670. \YENEWS        ; Include News file            Default: \WHYes\NO
  671.  
  672. Optional system News file, which the sysop may or may not have implemented.
  673.  
  674. \YEBBDATE      ; New bulletins from BBS date  Default: \LRNo\NO
  675. \YEBFDATE      ; New files from BBS date      Default: \LRNo\NO
  676.  
  677. By default, Valence scans for new files and bulletins, separately, from the
  678. date it last found any, rather than the date you were last on. If you've
  679. ever called a board after a while's absence, logged off or been cut off, and
  680. then realized you didn't see the new files list, but can't remember what
  681. date it was you last called, and now if you call back and do a "New" in
  682. "Files" Searchlight will only scan today's files... you'll appreciate this.
  683.  
  684. But if, on the other hand, you've been calling every day and checking new
  685. files and reading new bulletins, but not always using Valence, you may want
  686. to set these to YES to avoid rereading.
  687.  
  688. The internal dates are intialized with your last on date the first time you
  689. use Valence, so your first download should be the same either way.
  690.  
  691. \YEALLBULLET   ; Download ALL bulletins       Default: \LRNo\NO
  692. \YEALLNEWS     ; ALWAYS include News file     Default: \LRNo\NO
  693.  
  694. If set to YES, it forces these files to be included in your packet whether
  695. they've been updated or not. This may be useful once in a while, especially
  696. for the bulletins.
  697.  
  698. \YESESSION     ; Include SESSION.TXT          Default: \WHYes\NO
  699.  
  700. SESSION.TXT is a simple text file identical to what you see on your screen
  701. while scanning, from the "Copying WELCOME" message on down through the new
  702. files, but without the colors. It may be useful for you to see what messages
  703. you scanned sometimes, but for the most part, this is just a frill (though
  704. part of the QWK standard). It's just a little file, usually, but turning it
  705. off will save you an open file handle while scanning, which can be a help
  706. sometimes. (At the max, Valence can have more than nine files open at once.)
  707.  
  708. \YEINCREAD     ; Add to number of times read  Default: \LRNo\NO
  709.  
  710. This increments the "number of times read" counter in each message you
  711. download. Perhaps this should be on by default, but it may slow Valence down
  712. slightly, and since that field isn't even used in QWK packets (unless you
  713. turn on "MOREINFO", below), and since another QWK door I tried didn't bother
  714. incrementing them, I've left it off.
  715.  
  716. \YEMULTIPLE    ; Download multiple packets    Default: \LRNo\NO
  717.  
  718. This is a powerful option. When set to YES, whenever you get a "*** Your
  719. packet is full, but you have more new messages ***" message, Valence will
  720. automatically start scanning and packing the next packet after it
  721. successfully sends the first, and will repeat until all new messages are
  722. sent. On scans after the first one, the download prompt is turned off, as
  723. are the bulletins, welcome/goodbye, and new files (since these have already
  724. been scanned), and hangup after download (i.e., after transfer of ALL
  725. packets) is automatically selected. If you only have one packet's worth of
  726. messages, hangup is not automatically selected, and Valence operates just as
  727. it would with this option set to NO.
  728.  
  729. \YEDLPROMPT    ; Prompt for download          Default: \WHYes\NO
  730.  
  731. If this is turned off, the "Download this packet? (Y/N/G)" prompt does not
  732. appear, Valence goes straight to the download, and hangup mode is
  733. automatically selected. It also replaces the "The subboard list...Proceed?
  734. (Y/N)" prompt with a message: "Warning: The subboard list has been changed.
  735. Old .REPs may be invalid", and goes right on with the download, so I really
  736. advise against using this option.
  737.  
  738. \YEBLANKLIST   ; Show empty areas in scan     Default: \LRNo\NO
  739.  
  740. Shows all areas scanned, even if there's nothing new in them.
  741.  
  742. \YEMANYNUM     ; A lot of numbers in scan     Default: \LRNo\NO
  743.  
  744. In scanning for new messages, Valence will list First Msg, Last Msg, Last
  745. Read, New Last, Extracted, and Personal. This takes precedence over "wordy"
  746. mode. It has no effect in scanning files. This is my personal preference,
  747. but it seems to be Too Many Numbers for some people. :-)
  748.  
  749. \YEWORDY       ; Area descriptions in scan    Default: \WHYes\NO
  750.  
  751. This prints the area descriptions when scanning new messages (if not
  752. overridden by manynum) and new files. If off, only the area name and number
  753. extracted (and personal) will be shown.
  754.  
  755. \YEWRAPFILES   ; Wrap filelist into 40 cols   Default: \WHYes\NO
  756.  
  757. Instead of having one short file description line of 40 characters followed
  758. by two lines of 60 characters, you can have 4 lines (approximately) of 40
  759. characters each, all neatly aligned. Try it, I think you'll like it. But it
  760. does make for a larger NEWFILES.DAT than the non-wrapping mode.
  761.  
  762. \YEEXTRALN1    ; Blank line after long descs  Default: \WHYes\NO
  763.  
  764. This, the default mode, is like Searchlight's internal file listing:
  765. single-line descriptions run together, while multi-line descriptions have a
  766. blank line between them.
  767.  
  768. \YEEXTRALN2    ; Blank line after each file   Default: \LRNo\NO
  769.  
  770. A different way to do it.
  771.  
  772. \YEFULLSUBJ    ; Full subject in text         Default: \WHYes\NO
  773.  
  774. Searchlight's subject lines are up to 40 characters long; the QWK format is
  775. limited to 25. If, and only if, a message's subject is over 25 characters
  776. long, Valence will by default include it in the first line of the message
  777. with the word "Subject: ", and a blank line afterwards. Valence will also do
  778. this ALWAYS for "Fwd Fm:" and received netmail (which Searchlight prints as
  779. "Origin:" but Valence prints as "Netmail:").
  780.  
  781. Also, if a subject line starts with a "Re: ", "RE: ", or "(R) ", Valence
  782. will automatically strip it out, both to save space in the subject field and
  783. fit more of the original subject in, and to allow better sorting of messages
  784. by subject. (SLMR does this automatically, and it works distinctly better
  785. since I added "Re: " stripping.) There is no option to turn this off
  786. (sorry). The "Re: " will not be stripped out of the long subject line in the
  787. body of the text, nor in Text mode.
  788.  
  789. \YEMOREINFO    ; Even more info in text       Default: \LRNo\NO
  790.  
  791. This adds a line, like the ones just mentioned, into the body of the QWK
  792. message, listing number of times read, number of replies, and whether the
  793. message has been imported or exported.
  794.  
  795. Together, these two keywords cover all the "extra" information in the
  796. Searchlight message header. Neither has any affect in Text packet mode.
  797. Headers in Text packets are identical to Searchlight's display, apart from
  798. the colors.
  799.  
  800. \YEDISORDER    ; Ignore subboard list file    Default: \LRNo\NO
  801. \YEFDISORDER   ; Ignore directory list file   Default: \LRNo\NO
  802.  
  803. Ordinarily, Valence, like Searchlight, reads the files MAIN.SUB and MAIN.DIR
  804. and sorts the subboard and file directory lists, respectively, according to
  805. these files. You can turn this off if you want.
  806.  
  807. \YEPERSINDEX   ; Include personal index file  Default: \WHYes\NO
  808.  
  809. You can turn off the PERSONAL.NDX file (saving another of those eleven open
  810. files), and you won't have a "Personal" conference in your reader (or you'll
  811. have an empty one). The only reason this option is here is because I
  812. remember seeing it in Qmail (? I think), and it was trivial to implement.
  813.  
  814. \YEBRANDNEW    ; You haven't DLed yet         Default: \BLSee below\NO
  815.  
  816. This is normally a one-shot option; it's set to YES when you enter Valence
  817. for the first time, to tell it to send you THIS FILE (and the intro message
  818. in MAIL), and then set the option to NO. If you ever want to receive this
  819. file over again, you can set the option to YES.
  820.  
  821. \YEJOINED      ; Only joined subs in sublist  Default: \LRNo\NO
  822.  
  823. This will shrink your CONTROL.DAT somewhat if you turn it on, and may make
  824. for a neater display in your reader (though it will make gaps between
  825. conference numbers appear), but it will prevent you from joining any
  826. unjoined subboards offline, except with the "CONFIG" message method.
  827.  
  828.  
  829. \LB:::: \WHSOMETHING NOT TO DO\BL ::::\NO
  830.  
  831. For all you masochists out there, to make Valence functionally equivalent to
  832. SLQWiK, set these options:
  833.  
  834. UNDERJOIN No
  835. METACHARS No
  836. STRIPCOL  No
  837. ANSICOL   No
  838. FILECOLOR No
  839. INCLUDE   No
  840. BULLETINS No
  841. NEWONLY   Yes
  842. KILLMAIL  No
  843. YUCKY     Yes
  844. WELCOME   No
  845. NEWS      No
  846. SESSION   No
  847. WRAPFILES No
  848. FULLSUBJ  No
  849. DISORDER  Yes
  850. FDISORDER Yes
  851.  
  852. Sorry, there's no way I know to make Valence slow down and lock up
  853. frequently. :-)
  854.