home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 6 / The_Pier_Shareware_Number_6_(The_Pier_Exchange)_(1995).iso / thepier.doc < prev   
Text File  |  1995-01-10  |  16KB  |  365 lines
  1.  
  2.  
  3.                       The Pier Shareware CD-ROM
  4.                  Copyright (c) 1995 The Pier Exchange
  5.                          All rights reserved.
  6.  
  7.              ThePier(tm) - High Performance CD-ROM Access
  8.  
  9.  
  10.  
  11.  
  12.                           Retrieval Engine
  13.                  Copyright (c) 1995 RoboSoft Systems.
  14.                          All rights reserved.
  15.  
  16.  
  17.  
  18.  
  19.                          Table of Contents
  20.  
  21.     1 ........................................ Introduction
  22.     2 ........................................ Installation
  23.     3 ..................................... Basic Operation
  24.     4 .................................... The Subject List
  25.     4.1 ............................. The Subject List Menu
  26.     4.1.1 ................................. The System Menu
  27.     4.1.2 ................................. The Search Menu
  28.     4.1.3 .............................. The Configure Menu
  29.     4.1.3.1 ............................. Configure Display
  30.     4.1.3.2 ............................ Configure Database
  31.     4.1.3.3 ......................... Configure Directories
  32.     4.1.3.4 ............................. Configure Viewers
  33.     4.1.3.4.1 .............................. Default Viewer
  34.     4.1.3.4.2 ................................ Custom Shell
  35.     4.1.3.4.3 ............................... Smart Viewers
  36.     5 ...................................... The Files List
  37.     5.1 ............................... The Files List Menu
  38.     6 .............................. The File Detail Screen
  39.     6.1 .................................. The Content List
  40.     6.2 .............................. The File Detail Menu
  41.     7 ..................... Technical Questions and Support
  42.  
  43.  
  44.  
  45.  
  46.  
  47. 1. Introduction
  48.  
  49.  
  50. Congratulations on your purchase of one of The Pier Shareware 
  51. CD-ROMs, the finest shareware CD-ROMs available.  ThePier CD-ROM 
  52. Access program will assist you in finding files on your CD-ROM 
  53. and performing common operations on those files.  It will allow 
  54. you to view the filenames and descriptions of the files, search
  55. the CD-ROM files for filenames, keywords, and archive content 
  56. filenames, and view many of the content files.
  57.  
  58.  
  59. 2. Installation
  60.  
  61.  
  62. To install ThePier CD-ROM Access program, change to the root 
  63. directory of The Pier Shareware CD-ROM and type INSTALL.  The 
  64. install program will ask where on your hard drive you want 
  65. ThePier CD-ROM Access program to reside and will copy all 
  66. necessary files to that directory.  (For performance reasons, 
  67. ThePier must be installed to a hard disk.  It can not be run 
  68. directly from the CD-ROM.)  ThePier requires approximately 1MB
  69. of disk space for the program and associated data files.  
  70. Additional disk space will be used for the comments you enter
  71. in the comment database.
  72.  
  73.  
  74. 3. Basic Operation
  75.  
  76.  
  77. You should find ThePier very easy and intuitive to operate.  To 
  78. start ThePier, change to the directory where ThePier was 
  79. installed (for example, CD \THEPIER) and type THEPIER.  
  80.  
  81. ThePier is designed to use the best available video mode your 
  82. computer will support.  By default, it will try to use graphics 
  83. mode (EGA or VGA required) and resort to text mode if graphics 
  84. mode is unavailable.  If you have problems viewing the screens 
  85. in graphics mode, you can force the program into text mode by 
  86. using a /T parameter on the command line (i.e. THEPIER /T).  
  87. Graphics mode also requires the file EGAVGA.BGI to be present in 
  88. the directory where THEPIER.EXE resides.  (The install program 
  89. will put it there.)  If this file isn't present, ThePier will 
  90. use a text mode display.
  91.  
  92. Online help is available throughout ThePier.  Press F1 to view
  93. the context-sensitive help screens.
  94.  
  95.  
  96. 4. The Subject List
  97.  
  98.  
  99. The first screen you see when you start ThePier is a list of the 
  100. subjects available on The Pier Shareware CD-ROM.  If you have a 
  101. mouse on your system, a mouse pointer will be displayed.  You 
  102. can use the mouse to click on any of the subjects, the items on 
  103. the menu bar on the top of the screen, or on the scroll bar to 
  104. the right of the screen.  If you click on a subject, a list of 
  105. the files in that subject will appear.  
  106.  
  107. 4.1  The Subject List Menu
  108.  
  109. At the top of the subject screen you'll see a drop-down menu bar 
  110. containing System, Search, and Configure.  
  111.  
  112. 4.1.1  The System Menu
  113.  
  114. At this point there are three options on the System menu:
  115.  
  116.     1) Shell to DOS, keeping ThePier in memory and ready 
  117.        to go when you type EXIT at the DOS prompt.  
  118.     2) Execute a Custom Shell program.  (This will be        
  119.        covered in more detail under Configuration.)      
  120.     3) Exit ThePier.  
  121.  
  122. 4.1.2  The Search Menu
  123.  
  124. The Search menu will allow you to search ThePier database for 
  125. matching file names, keywords, or content file names.  In this 
  126. context, file names refers to the names of the files on The Pier 
  127. Shareware CD-ROM, many of them archive files; keywords refers to 
  128. significant words used in the file descriptions; and content 
  129. file names refers to the files that are contained within the 
  130. archive files.  At this point (on the Subjects List screen), 
  131. searches will included all subjects.  If you wanted to search for 
  132. all files that might have something to do with Windows, you would 
  133. select Keyword from the search menu and type WINDOWS in the 
  134. prompt box.  ThePier will then display a list of all the files
  135. containing the word "windows" somewhere in their description.
  136.  
  137. Wildcard characters are not recognized in search strings, but 
  138. partial strings are allowed if the Exact Match box is not 
  139. checked.  For instance, you could have entered WIN in the search 
  140. above and matched all occurrences of Windows (along with all 
  141. other keywords that begin with the letters WIN).
  142.  
  143. 4.1.3  The Configure Menu
  144.  
  145. The Configure menu allows you to change the operational 
  146. parameters used by ThePier.  You can force the display to text 
  147. mode (meaning you wouldn't need the /T on the command line), 
  148. change the active database (useful if you have more than one The 
  149. Pier Shareware CD-ROM), change the directories used by ThePier 
  150. for temporary files, and set up viewer programs to be called 
  151. automatically when certain files are selected. On all of the 
  152. configuration screens, if you press ESCape, any changes you 
  153. entered on that screen will be thrown away and the old data will 
  154. be restored.
  155.  
  156. 4.1.3.1  Configure Display
  157.  
  158. The Configure Display screen allows a simple choice between 
  159. forcing ThePier to use text mode displays or allowing it to use
  160. graphics mode displays.  (Graphics mode requires an EGA or VGA 
  161. display system.)  Graphics mode displays are slightly larger than 
  162. text mode, allowing more subjects and files to be displayed on a 
  163. single screen, but they are slightly slower than text mode 
  164. displays.  Other than these minor differences, the two modes are 
  165. functionally identical.
  166.  
  167. 4.1.3.2  Configure Database
  168.  
  169. The Configure Database screen can be used to select an alternate 
  170. ThePier database.  If you have more than one The Pier Shareware 
  171. CD-ROM you can use this screen to select the database associated 
  172. with one of the other CD-ROMs.  If you only have one The Pier 
  173. Shareware CD-ROM, do not change the settings on this screen.
  174.  
  175. You can select any of the directories shown in the lower right 
  176. section by clicking on them with your mouse.  If you don't have 
  177. a mouse, use the TAB key to switch to the directory section, 
  178. then use the arrow keys to highlight the desired directory.  
  179. Press the ENTER key to select the directory. 
  180.  
  181. If the desired directory is on another drive, position to the 
  182. Dir field and type the desired drive letter.
  183.  
  184. When you've selected the proper directory, position to the left 
  185. window and select the desired database file.  To finalize the 
  186. database selection, position to and select the OK button.
  187.  
  188. 4.1.3.3  Configure Directories
  189.  
  190. Directories Configuration allows you to specify the directories 
  191. used by ThePier.  The Work Directory is used by ThePier for 
  192. temporary files. A default value is set up by the installation 
  193. program, but you can change it if desired.  The Work Directory 
  194. should be on a drive that has free space at least as large as
  195. the largest file you intend to view.  (Five megabytes should be
  196. more than sufficient.)
  197.  
  198. The Default Copy/Extract Directory specifies the default 
  199. directory used when copying or extracting archive files.  This 
  200. is just a default and can be changed on the fly when copying or 
  201. extracting files.  
  202.  
  203. The Comment Database Directory specifies the location of the 
  204. comment database.  By default, this is the directory where 
  205. ThePier program resides.  It is recommended that you stay with 
  206. the default.
  207.  
  208. CD-ROM Drive specifies the drive letter of your CD-ROM drive.  
  209. The installation program initially sets this value to the drive 
  210. from which ThePier was installed.  If you have more than one 
  211. CD-ROM drive, you will need to change this value if you move The 
  212. Pier Shareware CD-ROM to a different CD-ROM drive.
  213.  
  214. 4.1.3.4  Configure Viewers
  215.  
  216. The viewers are one of the nicest features of ThePier.  They allow you 
  217. to associate programs with data files on the basis of the data file 
  218. extension.  The Viewer configuration screen is divided into several 
  219. areas.  
  220.  
  221. 4.1.3.4.1  Default Viewer
  222.  
  223. At the top of the screen is the default viewer.  This is the 
  224. viewer program that is called whenever the selected file does not 
  225. match one of the file extensions specified on this screen.  
  226. ThePier has a built-in viewer that is used as the default viewer 
  227. unless you specify something different.  Leave the Default Viewer 
  228. field blank if you want to use the built-in viewer.  (The 
  229. built-in viewer is designed to work only with plain ASCII text 
  230. files and will view only the first 32k bytes of any file.  If you 
  231. plan to view non-ASCII files or very large files, you will 
  232. probably want to specify a different program as the default 
  233. viewer.  Vern Buerg's LIST program is an excellent choice for the 
  234. default viewer.)
  235.  
  236. To specify a different default viewer, enter what you would 
  237. normally type at the DOS command line to start that program.  
  238. Where you would ordinarily type the name of the file to be 
  239. viewed, enter $F.  ThePier will replace the $F with the name of 
  240. the file you've selected for viewing.  If you wanted to use Vern 
  241. Buerg's LIST program as your default viewer, your default viewer 
  242. line might look like:
  243.  
  244.       Default Viewer: LIST $F
  245.  
  246. 4.1.3.4.2  Custom Shell
  247.  
  248. The next field allows you to specify a "shell" program. This is 
  249. intended for use with DOS "shell" programs such as PCTools Shell 
  250. and Norton Commander.  ThePier will allow you to jump directly 
  251. to the program specified in this field and return to ThePier 
  252. when you exit the shell program.  If your DOS shell can accept a 
  253. directory on the command line, you can use $D to designate the 
  254. current working directory.  If you use the Extract and Custom
  255. Shell option, $D will be the directory into which the file was 
  256. extracted.  If you wanted to use PCTools Shell as your shell 
  257. program, your shell program line might look like:
  258.  
  259.         Shell Program: PCSHELL $D
  260.  
  261. 4.1.3.4.3  Smart Viewers
  262.  
  263. The other viewers are all paired with a line of file extensions 
  264. associated with that viewer.  Anytime you select a file with an 
  265. extension from the viewer list, the viewer program associated 
  266. with that extension will be executed.  The viewer command lines 
  267. are just like the Default Viewer line as far as format goes.  
  268. Use $F in the command where you want the file name to go.
  269.  
  270.  
  271. 5.  The Files List
  272.  
  273.  
  274. When you select one of the subjects on the Subjects List, you'll
  275. see a list of the files in that subject along with as much of 
  276. the file description as will fit on a single line.  If you select 
  277. one of the files by clicking on it with your mouse or pressing 
  278. enter when the file is highlighted, you'll see detailed 
  279. information about that file. 
  280.  
  281. 5.1  The Files List Menu
  282.  
  283. At the top of the files list screen you'll notice the menu bar 
  284. has changed.  System is still there, though it now contains an 
  285. additional "Return to previous menu" item.  (You can also return 
  286. to the previous screen by pressing ESCape or clicking on the 
  287. little box in the upper left corner of the file list window.)  
  288. The Search menu is still there too, but its function has changed 
  289. a bit.  At this point searches will not scan the entire 
  290. database, but will be limited to the subject currently selected.
  291.  
  292.  
  293. 6.  The File Detail Screen
  294.  
  295.  
  296. The File Detail Screen contains detailed information about the 
  297. file you've selected.  In the upper left of the detail screen is 
  298. the file name, location, size, and date.  In the upper right is a 
  299. list of the contents of this file.  (If the file is not an 
  300. archive file, you'll just see the file name again.)  In the 
  301. middle of the screen is the full file description.  The scroll 
  302. bar at the right of the file description box can be used if the 
  303. full description doesn't fit in the available lines.
  304.  
  305. Toward the bottom of the screen is a box where you can enter 
  306. your own comments about this file.  These comments will be saved 
  307. in a database on your hard disk and redisplayed when you view 
  308. this file's detail information again.  
  309.  
  310. At the very bottom of the screen is a prompt bar.  Pressing any 
  311. of the specified keys will perform the indicated action.  You 
  312. can also click with your mouse on any of the words to take the 
  313. indicated action.
  314.  
  315. 6.1  The Content List
  316.  
  317. The content list in the upper right of the detail screen is where 
  318. the viewers come in.  If you select one of the files in the 
  319. content list, that file will be extracted from the archive (if 
  320. necessary) and passed to the appropriate viewer program.  If no 
  321. viewer is associated with the selected file extension, the 
  322. default viewer will be used.  (When ThePier executes a viewer, 
  323. it swaps all but about 10k of itself to EMS or to disk, so the 
  324. viewer program should have plenty of memory available.)
  325.  
  326. 6.2  The File Detail Menu
  327.  
  328. At the top of the file detail screen you'll see the familiar 
  329. System menu along with a File menu.  The File menu will allow 
  330. you to copy a complete file or to extract an archive file.  If 
  331. you select either of these options, you'll be prompted for a 
  332. destination directory for the copy or extract operation.  These 
  333. directories will default to the Copy and Work directories 
  334. specified in the configuration menu off the subjects screen.
  335. You can change them by selecting a different directory from the 
  336. displayed list.  If you want the files to go to a different 
  337. drive, you'll have to type the drive letter on the directory 
  338. line.
  339.  
  340. The File menu will also allow you to Extract and execute the 
  341. Custom Shell or Extract and Shell to DOS.  Both of these options 
  342. will allow you to select a directory for the extract operation 
  343. and will then either execute your Custom Shell or shell to DOS in 
  344. the extraction directory.
  345.  
  346.  
  347. 7.  Technical Questions and Support
  348.  
  349. If you have trouble installing ThePier(tm), contact The Pier
  350. Exchange at:
  351.               The Pier Exchange
  352.               50 Tulane Rd.
  353.               Kenmore, NY 14217
  354.  
  355.               Info (716) 875-4931
  356.               BBS (716) 875-3130
  357.  
  358. If you have detailed technical questions or comments about the
  359. access software, you can contact RoboSoft Systems, the authors of
  360. the retrieval engine, at:
  361.  
  362.                         RoboSoft Systems
  363.                         P.O. Box 2221
  364.                         Orange, CA  92669
  365.