home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / cars16.zip / CARS.DOC < prev    next >
Text File  |  1990-12-29  |  17KB  |  486 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                       C.A.R.S. USER MANUAL
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.                                         BY Joel Kurasch
  42.  
  43.  
  44.                         Table of Contents
  45.  
  46.  
  47. Welcome to C.A.R.S.. . . . . . . . . . . . . . . . . . . . . .  1
  48.      Registration. . . . . . . . . . . . . . . . . . . . . . .  1
  49.      Correspondence. . . . . . . . . . . . . . . . . . . . . .  1
  50.  
  51. Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  2
  52.      The Package . . . . . . . . . . . . . . . . . . . . . . .  2
  53.      The System Components . . . . . . . . . . . . . . . . . .  2
  54.  
  55. Starting C.A.R.S.. . . . . . . . . . . . . . . . . . . . . . .  4
  56.  
  57. The Main Menu. . . . . . . . . . . . . . . . . . . . . . . . .  5
  58.  
  59. Category Maintenance . . . . . . . . . . . . . . . . . . . . .  7
  60.  
  61. Opening a Car File . . . . . . . . . . . . . . . . . . . . . .  8
  62.  
  63. Add Car Data . . . . . . . . . . . . . . . . . . . . . . . .   10
  64.  
  65. Edit Car Data. . . . . . . . . . . . . . . . . . . . . . . .   12
  66.  
  67. List Car Detail & Summary. . . . . . . . . . . . . . . . . .   13
  68.  
  69. Sort Car File. . . . . . . . . . . . . . . . . . . . . . . .   13
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.                        Welcome to C.A.R.S.
  79.  
  80. Welcome to C.A.R.S., the Complete Automobile Reporting System.
  81. With this package, you can track your auto expenses in any of up to
  82. 26 user defined categories, and watch your milage and costs.
  83.  
  84.                           Registration
  85.  
  86. This program is provided on a shareware basis.  You are free to use
  87. the program, as is.  You are encouraged to share it, provided it is
  88. done free of charge and with all files intact.  Please remember
  89. that this program is copyrighted.
  90.  
  91. Those who find this program useful are encouraged to register.  For
  92. the $40 (US) registration fee, you will receive:
  93.  
  94.      1.   An up-to-date version of the complete program.
  95.  
  96.      2.   A printed and bound copy of the User Manual.
  97.  
  98.      3.   An 800 number for customer support.
  99.  
  100.      4.   Notification of improvements and enhancements.
  101.  
  102.      5.   One future update at a time of your choice.
  103.  
  104.      6.   Further updates at the cost of $4.
  105.  
  106.                          Correspondence
  107.  
  108. Please!!!  Write with your comments, questions, criticisms,
  109. (hopefully constructive,) and, (also hopefully,) registrations to:
  110.  
  111.      Cybernetic Software
  112.      P. O. Box 3594
  113.      Skokie, IL   60076  (USA)
  114.  
  115. Thank You.
  116.                          Introduction
  117.  
  118. The program is, I hope, self-explanatory.  As I receive feed-back
  119. from users, both registered and otherwise, I will enhance these
  120. instructions as needed.
  121.  
  122.                            The Package
  123.  
  124. Included on this disk are the following files:
  125.  
  126.         CARAVAN.CAR     A sample data file. Use it to become familiar
  127.                         with the system.  List it.  Modify it.  Make
  128.                         additions to it.
  129.  
  130.         CARS.CTL        A sample control file.  It contains the
  131.                         default categories into which your automobile
  132.                         expenses are placed.  It can be modified by
  133.                         selecting "Category maintenance" from the main
  134.                         menu.
  135.  
  136.         CARS.DOC         The file that you are now reading.
  137.  
  138.         CARS.EXE        The actual program that you will run. See
  139.                         start-up instructions, below.
  140.  
  141.         CARS.REG        The registration and comments form.
  142.  
  143.         EXPCHART        A sample form for logging expenses.
  144.  
  145.  
  146.                       The System Components
  147.  
  148.  
  149. Now for a brief explanation of the workings of the two main
  150. components of this system.
  151.                            Categories
  152.  
  153. There can be up to 26 categories, labeled A through Z.  These are
  154. kept in a file, CARS.CTL, and can be updated from the category
  155. maintenance selection of the main menu.  There are seven predefined
  156. categories that are supplied with the system: Accessories, Fees,
  157. Gas, Insurance, Maintenance, Purchase, and Repairs.  These have
  158. purposely been given the same letter designation as their initial.
  159. This is not mandatory, but you may find it is easier to remember
  160. that way.  You may add, change or delete from this group as you
  161. choose.  The one that refers to fuel, be it Gas, Diesel, Petrol,
  162. Fuel, Motion-lotion, or Zoom-stuff, must be defined when you create
  163. a car file.  (More on this subject later.)
  164.                             Car Files
  165.  
  166. Information on each vehicle is kept in a separate file.  It is
  167. called by a name of from 1 to 8 characters.  When operating on a
  168. specific car, the file must first be opened, or selected.  Each
  169. file has a descriptor record which contains (1), a 25 character
  170. description of the car, (2), the category it will use for fuel,
  171. (3), whether the odometer reading is in miles or kilometers, and
  172. (4), whether the fuel is to be measured in gallons, imperial
  173. gallons, or liters.  All of these items can be changed in the data
  174. edit routines.
  175.                         Starting C.A.R.S.
  176.  
  177. To start the program, CARS.EXE must be in the current directory,
  178. any directory defined within the PATH variable, or the drive and
  179. directory may be explicitly stated.  Type in:
  180.  
  181.                     [d:][path]CARS [car_name]
  182.  
  183. The [car_name] portion of the command is optional.  If used, it
  184. tells the system which car file to open first, instead of the
  185. default (if any).
  186.  
  187. Two words of warning before we proceed.
  188.  
  189. First, there is a data processing principle, "garbage in, garbage
  190. out."  The numbers that this program will report to you will only
  191. be as good as the data you supply to it.  If you forget to make
  192. entries, estimate figures, or enter erroneous data, the accuracy of
  193. the report will suffer.
  194.  
  195. Warning number two: nothing is as fleeting as data on a disk.  Back
  196. up your data files often.  If possible, keep a copy of the files at
  197. a different location.  In addition, keep a printout of the latest
  198. detail listing in a safe location, if all else fails, it can be
  199. re-entered.
  200.  
  201. When the program first begins, it looks for the CARS.CTL control
  202. file.  If it cannot be found, it allows you to either change the
  203. drive and/or directory that you are in, or to create a new control
  204. file.
  205.  
  206. The program will next go to open a car file.  If you typed in the
  207. name of one on the CARS command line, or if there is a default car,
  208. it will open this file, then go to the main menu.  If you did not
  209. enter a file name and there is no default, or the file typed in is
  210. not present, the program will proceed to the open car file menu
  211. (described below.)
  212.  
  213.                           The Main Menu
  214.  
  215. The main menu gives you a choice of several actions.  An action can
  216. be selected by typing it's number, or by entering the letter within
  217. parenthesis.  It also shows, at the bottom of the menu, which file
  218. is currently open, or <none> if one has not yet been opened.
  219.  
  220.                         Item Description
  221.  
  222. 1.(A)dd car data: Choose this selection to add new
  223. information to an existing, open car file. It will take
  224. you to a screen where you will be prompted for all the
  225. pertinent data needed to create a new transaction record.
  226.  
  227. 2.(C)ategory maintenance: This selection will display a
  228. chart of all posible categories, and allow you to add new
  229. ones, change the definition of those already established,
  230. or delete unwanted categories.  This is also where you
  231. specify a default car file for program startup.  The
  232. control file is always open, separate and apart from the
  233. car file.
  234.  
  235. 3.(E)dit car data: Use this selection to correct any
  236. information in the car file, either on the description
  237. record or on the transaction records.
  238.  
  239. 4.(L)ist car detail and summary: This selection will list
  240. the transaction records and/or produce a summary of all
  241. that has transpired.  The output can go to the screen,
  242. printer, both, or neither.
  243.  
  244. 5.(O)pen a car file: With this choice, a list of all car
  245. files, if any, that reside in the current directory, is
  246. displayed.  You are given the option of changing the
  247. drive and/or the directory, creating a new file, opening
  248. an existing file, or returning to the main menu.  You
  249. will be able to tell the open was successful by the open
  250. file indicator below the main menu. Choosing this
  251. selection will close the current car file.
  252.  
  253. 6.(S)ort car file: In order to produce detail and summary
  254. lists or the reports correctly, it is necessary to have
  255. the data sorted by odometer reading.  In most cases you
  256. will be adding data as it occurs, and the sort will be
  257. unnecessary.  Occasionally, when you forget to make an
  258. entry for your car payment, insurance, or whatever, you
  259. will have to sort the file after adding the tardy data.
  260.  
  261. 7.e(X)it program: You've had your fun, now you want to go
  262. on to other things.                       Category Maintenance
  263.  
  264. When you choose this selection, the program will display the name
  265. of the default car and the categories as they currently exist.
  266. Your four choices are:
  267.  
  268. 1.(A)lter entry: This will allow you to change the name of
  269. a category.  When you select this action, the system asks
  270. which category you wish to change (A-Z).  If you have
  271. changed your mind and don't really wish to alter any of
  272. them, simply press the escape key.
  273.  
  274. After selecting a category, enter the new category name,
  275. up to 20 characters.  If you wish to erase, or blank out,
  276. a category, enter an asterisk (*), or you may decide that
  277. things are just fine the way they are and just press the
  278. enter key.
  279.  
  280. 2.(C)hange default car file: This will allow you to enter
  281. or change the car file that will be opened at start-up,
  282. if you do not type a name on the command line.
  283.  
  284. 3.(S)ave setup: When the chart of categories looks the way
  285. you want it to be, this option will save it to disk.
  286.  
  287. 4.(R)eturn to main menu: This option returns you to the
  288. main menu.  If you have made changes, but forgot to save
  289. them, it will ask if you want to do it at this time.
  290. Even if you don't save it now, you can come back to
  291. category maintenance and save it later, the new
  292. categories will be safe in memory until you exit the
  293. program.
  294.  
  295.                       Opening a Car File
  296.  
  297. This option will first tell you what your default drive and
  298. directory are, and what .CAR files exist there.  It is possible to
  299. move around your drive and directory structures without exiting the
  300. program.  Your selections are:
  301.  
  302. 1.(C)hange drive and/or directory.
  303.  
  304. A.  First you are asked if you wish to change the default
  305. drive.  A yes response requires that you enter the letter
  306. (A through Z) that designates the desired drive.  If the
  307. drive you enter does not exist on your system, you will
  308. remain on your current drive.
  309.  
  310. B.  You will then be shown the current default directory.
  311. If you wish to change the default, you must enter the
  312. directory name, either fully qualified, or relative to
  313. the path of the current directory.  If that directory
  314. does not exist, or is misspelled, you will be returned to
  315. the open file menu.
  316.  
  317. 2.(M)ake a New Car File: This selection will create a new
  318. file in the current directory.
  319.  
  320. A.  Enter a car 1 to 8 character file name which, with an
  321. extension of .CAR, will be the name of the file that will
  322. hold the data for the new car that you are creating.  The
  323. program will check that you enter only valid file name
  324. characters.  Examples of valid names are: MUSTANG,
  325. 88CHEVY, GO_CART, etc.
  326.  
  327. B.  Next enter a 1 to 25 character description of the
  328. vehicle.  You are free to be as creative as you wish.
  329.  
  330. C.  Then enter the default method of measuring gasoline.
  331. The choices are (US) gallons, imperial gallons, or
  332. liters.
  333.  
  334. D.  Indicate whether the odometer reading is in miles or
  335. kilometers.
  336.  
  337. E.  Finally, you will be asked which category, A-Z, will
  338. denote a gasoline purchase.
  339.  
  340. All of these items, except for the file name, can be
  341. changed from the edit data menu. (The file name can be
  342. changed with the DOS rename command.)
  343.  
  344. 3.(O)pen an existing file: If one or more existing files
  345. have been found, they will be displayed across the top of
  346. this menu, and this item will be your third selection.
  347. You will be asked to type in the file name (less the .CAR
  348. extension.)
  349.  
  350. 4.(R)eturn to main menu:  This will be the third selection
  351. if there were no car files found in the current
  352. directory, otherwise it is the fourth.
  353.  
  354.                          Add Car Data
  355.  
  356. This is the selection for adding transaction information to the car
  357. file.  Examples of transactions include; payment on the car, an oil
  358. change, a gas purchase, or payment for state registration.
  359.  
  360. If you make a mistake while entering an item, and have already
  361. pressed the enter key, press the up-arrow to go back to the
  362. previous entry. Enter the following items.
  363.  
  364. A.The odometer reading for the transaction.
  365.  
  366. B.The month, day, and year of the transaction.  The year
  367. will default to the current year, and can be accepted by
  368. just pressing the ENTER key, or type over it with the
  369. correct entry.
  370.  
  371. C.The category (A-Z) of the transaction. The category you
  372. selected as fuel will come up as the default. You may
  373. accept it by pressing ENTER, or type over it with the
  374. correct entry.  You must have already given a definition
  375. for a category before you can add a transaction for it.
  376.  
  377. D.The cost of the transaction.
  378.  
  379. If the transaction is not a fuel purchase, the next two
  380. items will not be required.
  381.  
  382.  
  383. E.The unit of measure for the fuel purchase.  If it was the
  384. default, all you need do is press enter. Otherwise, press
  385. a key corresponding to the type of measurement.  I.e., if
  386. you usually measure your gas in gallons, but happened to
  387. stop at a station that pumped gas by the liter, press the
  388. '3', 'L', or 'l'.  In this case the price per unit and
  389. the number of units will be adjusted for the default
  390. method, after you have entered them, and the new numbers
  391. stored.
  392.  
  393. F.You are now asked if you wish to enter the number of
  394. units purchased, or the price per unit. Whichever you
  395. choose, the program will then request you to enter it.
  396. You might enter 10.439 gallons, or $1.039 per gallon
  397. (without the dollar sign). I recommend that unless you
  398. have the amount you purchased down to three decimal
  399. places, which most of the new digital gas pumps provide,
  400. that you enter the price of the unit, up to, and
  401. including the customary 9/10 of a cent.
  402.  
  403. G.Enter a 1 to 20 character description of the transaction.
  404.  
  405. You will then be asked if all of your response are
  406. correct.  If you respond yes, the data is saved to disk,
  407. otherwise, you are returned to the main menu.
  408. Again, the up arrow will take you back through the items. Edit Car Data
  409.  
  410. This option will allow you to edit information on the
  411. descriptor record or on any of the transaction records.
  412.  
  413. 1.Descriptor: The descriptor record contains four pieces of
  414. information: (1) a 25 character description of the
  415. vehicle, (2) the unit of measure for the fuel, (3) the
  416. unit of measure for the odometer, and (4) the category
  417. for fuel.  If you choose to change the unit of measure
  418. for the fuel, the program will offer to alter all fuel
  419. purchase transactions so that the price per unit reflects
  420. the new unit, it is strongly advised that you let the
  421. program do so.  If you change the category for fuel
  422. purchases, the program will offer to change all records
  423. with the old category to the new one, again, it is
  424. strongly advised that you do so.
  425.  
  426. 2-6.These selections will allow you to choose the transaction
  427. record to be updated in a variety of ways.  Number 2 will
  428. get you the next record on the file, number 3 will get a
  429. record by odometer reading, number 4 the previous
  430. transaction record, and number 5 will get a record by
  431. it's position in the file.  However you get to the
  432. record, you will be shown it's data elements. You may
  433. choose to update any one of them.  WARNING! If you change
  434. the odometer reading of a record, it is most likely that
  435. you will have to sort the file.
  436.  
  437. 7.This will return you to the main menu.
  438.  
  439. There is currently no way to delete a record.  If you have a record
  440. that you wish to eliminate, then use the edit function to place
  441. legitimate information in the record the next time you have data to
  442. add.  (Don't forget to sort afterwards.)
  443.                    List Car Detail & Summary
  444.  
  445. When you select this option you will be asked if you want the
  446. information on the screen, on a printer, both, or neither.  The
  447. detail can be listed at any time.  HOWEVER, there must be at least
  448. two (2) fuel purchases to get the summary data.
  449.  
  450.                           Sort Car File
  451.  
  452. Occasionally data will not be entered in odometer order, or the
  453. sequence may be lost due to an edit on a record.  For whatever
  454. reason, when the file is out of sequence, it must be sorted.
  455.  
  456. The program will attempt to do an in-memory sort, for speed and to
  457. save wear and tear on your disk drive.  If there is not enough room
  458. for a memory sort, then a disk sort is done.  (If you know that a
  459. disk sort will be required, place the file on a ram disk, and sort
  460. it there.  You wont believe how fast it will go!)
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.                              Page ii
  486.