home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / head.lzh / headpnt.doc < prev    next >
Text File  |  1994-04-19  |  19KB  |  418 lines
  1. Preliminary documentation:
  2. -------------------------
  3.  
  4.  
  5.               HeadEdit Point
  6.               copyright (c) 1994 by Mark Kimes and Mike Berry
  7.               All rights reserved
  8.  
  9.  
  10. Overview:
  11. ========
  12.  
  13. HeadEdit Point is an OS/2 2.x PM 32-bit Fidonet Technology Network (FTN)
  14. point package.  The HeadEdit Point (HP) system is standalone, not an
  15. adjunct to an existing BBS; no other software is required to be an FTN
  16. point.
  17.  
  18. HP's objective is to make FTN pointing as simple as possible so that you
  19. can spend your time reading and writing mail instead of wrangling with
  20. integrating complicated software packages just to get to your mail.
  21.  
  22. NOTE:  HPFS is required.
  23.  
  24.  
  25. Installation:
  26. ============
  27.  
  28. Move HEADEDIT.EXE to a directory of its own on an HPFS partition (HPFS
  29. is _required_; don't bother trying on a FAT drive).  There should be
  30. plenty of room available; everything HP needs it will create here,
  31. including message bases, which can grow rather large.
  32.  
  33. Run HEADEDIT.EXE to unpack the files contained therein (HEADEDIT.EXE is
  34. a self-extracting LZH archive).  You can then erase HEADEDIT.EXE.
  35.  
  36. While HP should be simple enough for you to just start up and use
  37. intuitively, people's intuitions vary and this document may serve as a
  38. preliminary look at the program without the bother of setting it up, so
  39. we'll continue in some detail to get you comfortable with the concepts
  40. behind using HP.
  41.  
  42.  
  43. Starting:
  44. ========
  45.  
  46. To start HP, type HEAD4 at a command line or set up a program object for
  47. HEAD4.EXE and double-click it.  You should assure that the directory
  48. into which you unpacked the HEADEDIT.EXE archive is the default
  49. directory.  Here's what the first page of a Settings notebook for an
  50. HP program object might look like:
  51.  
  52.    ╔══╤══════════════════════════════════════════════════════╤══╤══╗
  53.    ║--│ HEAD4.EXE - Settings                                 │  │  ║
  54.    ╟──┴──────────────────────────────────────────────────────┴──┴──╢
  55.    ║┌────────────────────────────────────────────────┐             ║
  56.    ║│                                                ├┐            ║
  57.    ║│                                                │├┐           ║
  58.    ║│                                                │Program      ║
  59.    ║│                                                ││││          ║
  60.    ║│                                                ││Session     ║
  61.    ║│ Required                                       ││││          ║
  62.    ║│   Path and file name:                          │││Assocation ║
  63.    ║│   ┌───────────────────────┐   ┌───────╖        ││││          ║
  64.    ║│   │C:\HEADEDIT\HEAD4.EXE  │   │Find...║        ││││General   ║
  65.    ║│   └───────────────────────┘   ╘═══════╝        ││││          ║
  66.    ║│                                                ││││          ║
  67.    ║│ Optional                                       ││││          ║
  68.    ║│   Parameters:                                  ││││          ║
  69.    ║│   ┌───────────────────────────────────┐        ││││          ║
  70.    ║│   │                                   │        ││││          ║
  71.    ║│   └───────────────────────────────────┘        ││││          ║
  72.    ║│   Working directory:                           ││││          ║
  73.    ║│   ┌───────────────────────────────────┐        ││││          ║
  74.    ║│   │                                   │        ││││          ║
  75.    ║│   └───────────────────────────────────┘        ││││          ║
  76.    ║│                                                ││││          ║
  77.    ║│ ┌───────╖   ┌───────╖                          ││││          ║
  78.    ║│ │ Undo  ║   │ Help  ║                          ││││          ║
  79.    ║│ ╘═══════╝   ╘═══════╝                          ││││          ║
  80.    ║│                                             < >││││          ║
  81.    ║└┬───────────────────────────────────────────────┘│││          ║
  82.    ║ └┬───────────────────────────────────────────────┘││          ║
  83.    ║  └┬───────────────────────────────────────────────┘│          ║
  84.    ║   └────────────────────────────────────────────────┘          ║
  85.    ╚═══════════════════════════════════════════════════════════════╝
  86.  
  87. The first time:
  88. --------------
  89.  
  90. (Note:  Setting up a point address with a Boss should be done _before_
  91.  deluging the poor fellow with requests for files and echos.  Call his
  92.  or her BBS and ask for an address, session and "Areafix" passwords.)
  93.  
  94. The first time you run HP you'll get a setup dialog asking for
  95. information on your address and your Boss.  Fill in the fields
  96. completely, then click the Add button (repeat as required for additional
  97. addresses).  Then select an address and click the Okay button.  You'll
  98. then be presented with a dialog asking for your name.  Enter it and
  99. click the Add button (repeat as desired for additional names).  Then
  100. select a name and click the Okay button.
  101.  
  102. Next you'll want to get some messages.  Select Area->Pick Area from the
  103. pulldown menu, or click the button on the main window that reads
  104. NETMAIL.  Add the areas you'd like to receive.  HP generates special
  105. messages to your Boss to add the areas.  Select Msgs->Export Msgs from
  106. the pulldown menu, then select Mailer->Call Boss.  You'll get a mailer
  107. setup dialog.  Fill in the fields completely, then click Okay.  The
  108. mailer screen will appear, and HP will call your Boss to deliver your
  109. requests.
  110.  
  111. Now the hard part -- wait several hours so your Boss can get some new
  112. mail.
  113.  
  114. The next time you run HP you'll notice the setup dialogs don't appear;
  115. HP starts assuming the first address and first name you entered into the
  116. original setup dialogs (assuming you entered more than one, of course).
  117.  
  118. Call your Boss and pick up your mail.  Then select Msgs->Import Msgs to
  119. import the new mail into a form you can read (this may take a couple of
  120. minutes).  When HP is finished importing, you're ready to roll.
  121.  
  122. There's more information on the various steps below, if you're a novice
  123. and need more help.
  124.  
  125. Before you shut HP down, use the Font and Color Palette objects to
  126. customize its appearance to taste.  HP will remember your changes.
  127.  
  128.  
  129. Using:
  130. =====
  131.  
  132. Reading messages:
  133. ----------------
  134.  
  135. To read mail, simply use the <-Msg and Msg-> buttons to step through the
  136. messages in an area.  Use the Area-> and <-Area to change areas.  You
  137. can also pick messages directly using the Msgs->Pick Msg dialog, or by
  138. clicking the "# of #" button on the main window, and pick areas directly
  139. by selecting Areas->Pick Area or by clicking the "Areaname" button on
  140. the main window (say, that dialog looks familiar!).  Also look for
  141. context menus on many fields (accessed by clicking mouse button two on
  142. the field).
  143.  
  144. To read only personal mail, use the Filter option -- HP builds a custom
  145. filter for you called Personal for this purpose.  The Filter option can
  146. be very powerful, allowing you to pick interesting messages out of large
  147. conferences without manually scanning each message.
  148.  
  149. HP keeps track of what are (or might be) replies to the message you're
  150. reading.  The Msgs->Pick Msg window lists them in its lower container so
  151. that you can follow a message thread in any order you like.  "Bookmarks"
  152. are provided so that you can save your current position for instant
  153. return before you wander off exploring.
  154.  
  155. HP also provides the usual amenities (in spades), like Twit filter,
  156. global new message scanning, spell checker link and
  157. tagging/exporting/archiving messages. Everything is maintained from the
  158. program itself; there's never a need to load a text editor and edit
  159. cryptic control files.
  160.  
  161. Writing messages:
  162. ----------------
  163.  
  164. Of course, reading is probably only half of what you want to do with a
  165. point system; you may have something to say yourself.  To reply to a
  166. message, select Msgs->Reply or hold down the CTRL key and press "r"
  167. (written "^r" -- this is known as an "accelerator key;" you'll see them
  168. listed beside their menu items where available). To post a new message,
  169. select Msgs->New Msg or type ^w.  To abandon (abort) a message you're
  170. writing, just move to another message or area and answer "Y"es to the
  171. confirmation popup.  You'll notice that when you're entering a message a
  172. couple of buttons at the bottom of the window change to let you easily
  173. save or abort the message.
  174.  
  175. One thing that's not obvious is how to forward a message.  Select
  176. Msgs->Save on a message that you're _not_ in the process of editting;
  177. HP will ask you if you want to forward it, and present the Areas dialog
  178. if so.  Select the area to which you want to forward the message and
  179. it's done.  You can also reply to a message but have the message you
  180. write go into a different area (usually used to write a netmail reply
  181. to an echomail message) by selecting Msgs->Reply to diff. area and
  182. selecting the area from the Areas dialog.
  183.  
  184. Hint:  Although HP contains its own text editor, optimized for use in
  185. writing messages, you can call an external editor if you prefer by
  186. hooking the Edit->Spell Check command (set with Edit->Set Spell Checker)
  187. to the external editor of your choice.  To enter a message, you'd start
  188. the message as above, then press ^c to invoke your editor.  When you end
  189. your editor, the message is reimported into HP.
  190.                       
  191. Tear/Origin lines (taglines):
  192. ----------------------------
  193.  
  194. HP allows you to set a default tear and origin line and use those
  195. defaults for all messages (Misc->Origins/Tearlines->Set Default... and
  196. Use Default...).  HP also allows "rotating" tear and/or origin lines, on
  197. an address-wide or per-area basis (Misc->Origins/Tearlines->Origin/Tear
  198. Dialog).  Lastly, HP allows you to pick a particular origin and/or tear
  199. line for the next message only (Misc->Origins/Tearlines->Pick
  200. Origin/Tearline).  That should be enough options to cover all users and
  201. circumstances.
  202.  
  203. "Stealing" a tagline is as simple as highlighting it in a message (use
  204. the MLE viewer) and selecting Edit->Copy to Clip, then calling up the
  205. Origin/Tear Dialog and pressing CTRL-INS to place it into one of the
  206. multiline edit (MLE) fields.
  207.  
  208. Importing messages:
  209. ------------------
  210.  
  211. Messages must be in the appropriate "inbound" directory to be imported;
  212. HP puts them there automagically as they are received.  When you look
  213. at the Addresses dialog, you're told which areas have importable mail
  214. as you highlight the addresses.
  215.  
  216. To import, choose Msgs->Import Msgs from the pulldown menu.  A dialog
  217. appears that allows you to tailor the import process.  You can strip
  218. some control information to decrease the amount of data stored in the
  219. message base.  You can Compress message text as it's imported.  You can
  220. choose to Append new messages to the existing message base (otherwise
  221. the old message base is wiped prior to importing new messages).  You
  222. can elect to export mail (see below) before importing.  Finally, you
  223. can request a bell to sound to notify you when the import process is
  224. complete (it doesn't take long, but why stare at the screen?).  Click
  225. Okay to begin importing, or Cancel to abort.
  226.  
  227. When the import process completes, your new mail is ready to be read.
  228.  
  229. Exporting messages:
  230. ------------------
  231.  
  232. Exporting messages is usually pretty much automagic; when you shut down
  233. HP, you'll be asked if you want to export new messages that you may have
  234. entered (if you did).  You can also select Msgs->Export Msgs from the
  235. pulldown menu.  The export process is _very_ fast so there's no option
  236. to have a bell ring when completed.
  237.  
  238. Maintaining the message base:
  239. ----------------------------
  240.  
  241. If you choose to append new messages to the existing message base when
  242. you import mail (see above), you'll need to perform periodic message
  243. base maintenance.  Select Misc->Maintenance from the pulldown menu.
  244. There are two options:
  245.  
  246.     Quick-pack Area:  Removes references to deleted messages.  The
  247.                       message text is not removed, only the index
  248.                       records, so this is eye-blink fast.
  249.  
  250.     Full Maintenance: Performs full maintenance, including completely
  251.                       packing out deleted messages and trimming message
  252.                       areas to the maximum quantity specified in each
  253.                       area's setup (you access the Area Setup dialog by
  254.                       selecting Areas->Pick Area from the pulldown
  255.                       menu).
  256.  
  257. Twits:
  258. -----
  259.  
  260. It never fails; there are people in any message area that irritate you.
  261. Don't be irritated.  Twit them so you don't see their messages.
  262. Misc->Twits calls up the Twit Maintenance dialog.  You can specify,
  263. along with the twit's name, an area (the user name is only considered a
  264. twit in that area if given), a number of days to keep the user name
  265. twitted (0 means forever, though you can remove them manually) and "No
  266. import" which prevents the twit's messages from ever entering the
  267. message base.
  268.  
  269. To add a twit, fill in the Name: entry field (and other optional fields
  270. as desired) and click Add.  To change a twit, select the user name in
  271. the listbox (which causes all fields to be filled with the current
  272. information for that name), edit the fields, then click Change.  To
  273. delete a user name, select it and click Delete.  When you're done,
  274. click Exit.
  275.  
  276. Calling a bossnode:
  277. ------------------
  278.  
  279. Click on the Mailer option on HP's menu bar. Click on "Call Boss" entry
  280. of dropdown menu. The mailer will attempt to call the boss system that
  281. was entered during HP setup. Call progress will be provided in the
  282. "Mailer - Status" window and also in HP's status area.
  283.  
  284. Calling other nodes:
  285. -------------------
  286.  
  287. To call someone besides a bossnode, click Mailer->Call Others. The
  288. resultant dialog contains a listbox that displays addresses for which
  289. files exist in your outbound directory for convenience.  Fill in the
  290. address to call, together with the phone number and password to use.
  291.  
  292. If you've called the address before, or if you have a version 7 nodelist
  293. available, HP will fill in the phone number and password fields for you
  294. if you leave them blank.  If not, you must do so manually.  If you
  295. forget, HP will remind you by placing the cursor in the phone number
  296. field and refusing to call.
  297.  
  298. Although not required, a version 7 nodelist will be used if found in
  299. a directory named NODELIST off of HP's main directory.
  300.  
  301. Toolbar:
  302. -------
  303.  
  304. The toolbar gives you mouse shortcuts to some of HP's commands.  To
  305. get help on what a particular toolbar button does, click mouse button
  306. 2 while the pointer is over the button of interest.  The toolbar can
  307. be turned off (Misc->Toggle toolbar) to conserve window space.
  308.  
  309.  
  310. HeadUtil.EXE:
  311. ============
  312.  
  313. HeadUtil is provided to allow experienced users to automate some HP
  314. functions in a command (batch) file.  Run it without arguments for
  315. command line syntax.  Note that you don't _have_ to run this; it's only
  316. for automation purposes.  Everything that HeadUtil does, HP will do.
  317.  
  318.  
  319. Import samples:
  320. ==============
  321.  
  322. This section is just to let you know something about the import
  323. capabilities of the HeadEdit Point system.  No one likes to wait
  324. a long time for their mail to be made "readable," and HP won't
  325. make you wait long, as you'll see.
  326.  
  327. Timings were made using 20 real mail bundles (archived with PKZIP 1.x
  328. and ARC 5.12) totalling 615725 bytes compressed, 1567015 bytes
  329. uncompressed, containing a total of 26 packets.  Decompression is
  330. included in these timings.  Normal (for my system) background activity
  331. was present (BBS running, mail activities).  Garden-variety 486/33 ISA
  332. clone with a 14ms IDE drive (16-bit controller) running OS/2 2.1GA.
  333.  
  334. 1389 messages in 0 min 56 sec with no compression (command line
  335. "headutil <addr> -l") for an average of 24.8 messages/sec.
  336.  
  337. Resultant message area files:
  338.  
  339.  7-08-93   6:11p       116           0  380_ADULT.PDX
  340.  7-08-93   6:11p        78           0  380_CHAT.PDX
  341.  7-08-93   6:12p      6956           0  C_ECHO.PDX
  342.  7-08-93   6:12p      2358           0  DR_DEBUG.PDX
  343.  7-08-93   6:12p       116           0  FEMALE_SYSOP.PDX
  344.  7-08-93   6:12p      5702           0  HOLYSMOKE.PDX
  345.  7-08-93   6:12p   1396450           0  MASTER.MSG
  346.  7-08-93   6:11p       230           0  NETMAIL.PDX
  347.  7-08-93   6:11p       344           0  NET_DEV.PDX
  348.  7-08-93   6:12p     30858           0  OS2.PDX
  349.  7-08-93   6:12p       496           0  OS2BBS_DEV.PDX
  350.  7-08-93   6:12p      4714           0  OS2PROG.PDX
  351.  7-08-93   6:11p       116           0  R19COORD.PDX
  352.  7-08-93   6:11p      1180           0  R19SYSOP.PDX
  353.  7-08-93   6:11p        78           0  WANT-ADS.PDX
  354.         15 file(s)    1449792 bytes used
  355.  
  356. Messages average about 1043 bytes each (pretty much average for Fidonet
  357. traffic).
  358.  
  359. 1389 messages in 4 min 29 sec with compression (command line "headutil
  360. <addr> -l -c") for an average of 5.1 messages/sec.
  361.  
  362. Resultant message area files:
  363.  
  364.  3-21-93   2:09a     <DIR>           0  .
  365.  3-21-93   2:09a     <DIR>           0  ..
  366.  7-08-93   6:02p       116           0  380_ADULT.PDX
  367.  7-08-93   6:03p        78           0  380_CHAT.PDX
  368.  7-08-93   6:07p      6956           0  C_ECHO.PDX
  369.  7-08-93   6:07p      2358           0  DR_DEBUG.PDX
  370.  7-08-93   6:07p       116           0  FEMALE_SYSOP.PDX
  371.  7-08-93   6:07p      5702           0  HOLYSMOKE.PDX
  372.  7-08-93   6:07p    935072           0  MASTER.MSG
  373.  7-08-93   6:05p       230           0  NETMAIL.PDX
  374.  7-08-93   6:06p       344           0  NET_DEV.PDX
  375.  7-08-93   6:07p     30858           0  OS2.PDX
  376.  7-08-93   6:07p       496           0  OS2BBS_DEV.PDX
  377.  7-08-93   6:07p      4714           0  OS2PROG.PDX
  378.  7-08-93   6:05p       116           0  R19COORD.PDX
  379.  7-08-93   6:05p      1180           0  R19SYSOP.PDX
  380.  7-08-93   6:03p        78           0  WANT-ADS.PDX
  381.         15 file(s)     988414 bytes used
  382.  
  383. Messages average about 711 bytes each.
  384.  
  385. From this we see that compression saved 461378 bytes of disk space (apx.
  386. 32% less disk space) but required 3 min 27 sec longer to import (apx.
  387. 77% longer).  Which method you choose will depend on the speed of your
  388. machine, quantity of messages normally received, amount of storage
  389. available, whether disk compression is used and, of course, personal
  390. preference.  Hopefully this section will help you reach a decision with
  391. a minimal amount of trial-and-error.
  392.  
  393.  
  394. Registering HeadEdit Point:
  395. ==========================
  396.  
  397. This beta version of HeadEdit Point may be registered by sending $25.00
  398. US to the mailing address below.  Future (release) versions will cost
  399. somewhat more (about $35-$50).  Registrations are good for new versions
  400. for at least one year at no additional charge.  You are granted a 30-day
  401. evaluation period in which to try out HP.  If you don't register (buy)
  402. HP after that period, you should stop using it.
  403.  
  404. Contacting the authors:
  405. ----------------------
  406.  
  407. Mark Kimes
  408. 542 Merrick
  409. Shreveport, LA  71104  USA
  410. (318)222-3455 data
  411. Fidonet#1:380/16.0
  412. (Messaging)
  413.  
  414. Mike Berry
  415. (318)688-7078 data
  416. Fidonet#1:380/100.0
  417. (Mailer/comms)
  418.