home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 2: Collection B / 17Bit_Collection_B.iso / files / 1867.dms / in.adf / Docs / SID2.docs < prev   
Encoding:
Text File  |  1997-10-30  |  18.9 KB  |  553 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                                  SID v2.00
  21.  
  22.                        The Ultimate Amiga Power Tool
  23.  
  24.  
  25.  
  26.                                   3/05/92
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.                   © Copyright 1988-92 by Timm Martin
  56.                     
  57.  
  58.  
  59. Legal Stuff
  60. ~~~~~~~~~~~
  61.  
  62. THE PROGRAM SID2, ALL SUPPORTING PROGRAMS, ON-LINE HELP FILES, AND RELATED
  63.  
  64. THE SID2 SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF
  65. ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO THE
  66. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  67. YOU ARE ADVISED TO TEST THE SOFTWARE THOROUGHLY BEFORE RELYING ON IT.  YOU
  68. AGREE TO ACCEPT THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
  69. SOFTWARE AND DOCUMENTATION.  IN NO EVENT WILL TIMM MARTIN BE LIABLE FOR
  70. DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES RESULTING FROM ANY
  71. DEFECT IN THE PROGRAM.
  72.  
  73. Timm Martin reserves the right to make improvements to the product and
  74. documentation at any time and without notice.
  75.  
  76. ----------------------------- BOTTOM LINE -----------------------------------
  77. Companies
  78. ~~~~~~~~~
  79.  
  80. Companies which wish to use SID2 for more than one employee should purchase a
  81. separate license for each employee.  Enterprise licenses are available for
  82. large companies.  Please contact the author for details.
  83.  
  84.  
  85. User Groups
  86. ~~~~~~~~~~~
  87.  
  88. Because SID2 is now registered to each individual, User Group discounts are
  89. no longer feasible.
  90.  
  91.  
  92. A Programmer's Plea -- if you haven't registered
  93. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94.  
  95. SID is shareware.  If you find this program useful, please send $25 to:
  96.  
  97.     Timm Martin
  98.     P.O. Box 3205
  99.     Cincinnati, OH 45201-3205
  100.     U.S.A.
  101.  
  102. Please send payment in one of the following forms:
  103.  
  104.     U.S. cash (be careful!)
  105.     U.S. check in U.S. dollars
  106.     U.S. money order in U.S. dollars
  107.     U.S. Postal money order
  108.     Canadian Postal money order in U.S. dollars
  109.  
  110.  
  111.  
  112. A (Somewhat) Brief History
  113. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  114.  
  115. SID began in October 1988 when a friend of mine wanted me to collect some
  116. public domain software for a friend of his who just purchased an Amiga.
  117. Specifically, he wanted some type of program that would make file
  118. manipulation easier.  As a die-hard hacker, I had always used the CLI and had
  119. never even seen a directory utility before, but in my search for this
  120. collection of PD software, I came across DirUtilIII.  Now this was a very
  121. ambitious program for the Amiga in its infancy, but after using it for five
  122. minutes, the arrogant programmer in me told me that I could do better.
  123.  
  124. My best friend Jeff Hoag was also using this program to maintain files on his
  125. BBS, so when he heard of my interest in writing a new DU, he immediately
  126. handed me a wish list.  The most important things were an improved user
  127. interface and no limits (he had thousands of files in each directory, but
  128. DUIII could only handle 300 at a time).
  129.  
  130. I released SID v0.49 in early 1989 to Jeff and some friends in the local user
  131. group.  The general consensus was that SID had great potential but could
  132. use some improvement.  So I gathered suggestions and rewrote SID from
  133. scratch.  It took me hundreds of hours, but I released SID v1.03 locally
  134. as shareware in the summer of '89 and used it for my senior project in
  135. college.  After a few more revisions, I released SID v1.06 to the world in
  136. December 1989.
  137.  
  138. What was the beginning of a wonderful period in my programming life was also
  139. the beginning of a disastrous part of my personal life, affectionately known
  140. as "The Dark Ages."  I moved in early 1990, and in the hustle and bustle lost
  141. most of the source code to SID v1.06.  (This is when I began a system of
  142. seven rotating backups including two offsite).
  143.  
  144. Unfortunately, as certain deficiencies were uncovered in 1.06, I was helpless
  145. to fix them.  These included the "SeparateDirs" bug that blackened screens, a
  146. cryptic config file, problems with Kickstart v2.0, and only a single
  147. configurable button.  In the spring of 1990 I decided to write a completely
  148. configurable SID with interactive editing--the way it was meant to be on the
  149. Amiga.  After three months of design, I started writing SID that summer.
  150.  
  151. For the next year I spent over a thousand hours writing SID before compiling
  152. a single byte of code!  I was receiving enough shareware fees to keep up my
  153. interest in SID2, but unfortunately not enough to forsake my day job and
  154. program full-time for the Amiga--a dream I've always had.  Thus, while
  155. spending nights on SID, I spent days working and finishing my last year in
  156. college.
  157.  
  158. Spring 1991 was a particularily enjoyable time in my life.  I graduated from
  159. the "seven-year plan" at the University of South Florida with honors, I
  160. accepted a job at Procter & Gamble in Cincinnati, and I released a beta
  161. version of SID2.  I fully expected to have SID ready for general release in
  162. the summer, but look out!  My new job and life consumed most of my free time,
  163. and suddenly SID fell behind.
  164.  
  165. Then in October I contracted a mysterious virus (my second in three months)
  166. that landed me in the hospital.  I spent the entire month of October in bed,
  167. then the entire month of November in bed as soon as I got home from work.  I
  168. became especially frustrated when a commercial developer released a directory
  169. utility that looked strikingly similar to SID2-beta, so much so that some
  170. people wondered if this was the commercial version of SID2.  (I guess that's
  171. the ultimate form of flattery).
  172.  
  173. History, cont'd
  174. ~~~~~~~~~~~~~~~
  175.  
  176. I began to doubt if there was still a future and interest in SID2.  But
  177. having invested so much time and effort, I decided to keep on plugging.  From
  178. December through February I averaged just over five hours programming seven
  179. days a week--on top of the 9-11 hours per day at P&G.  The result, after 2300
  180. hours work and 2.9 million bytes of code, is SID2.
  181.  
  182.  
  183. Tools of my Madness
  184. ~~~~~~~~~~~~~~~~~~~
  185.  
  186. SID2 was created with the following tools:
  187.  
  188.     Commodore Amiga 3000
  189.         25MHz 68030, 200MB hard drive, 6MB RAM.
  190.  
  191.     UEdit by Rick Stiles
  192.         Without a doubt, the world's best text editor on any machine--period.
  193.         I've always wanted to write my own, and UEdit gave me the tools to do
  194.         just that in less than two days.  It's not just configurable; it's
  195.         fully programmable.  If you like things "your way," be sure to check
  196.         out UEdit.
  197.  
  198.     Manx C
  199.         For years, Lattice (now SAS) and Manx have leap-frogged over each
  200.         other in features and performance.  SAS now seems to have an edge,
  201.         but I'm hoping that Manx will soon again take the lead.
  202.  
  203.  
  204. Three Faces of SID2
  205. ~~~~~~~~~~~~~~~~~~~
  206.  
  207. There are three different versions of SID2:
  208.  
  209.     Personal
  210.         SID2-Personal is a more compact version that contains all the basic
  211.         features of SID, but does not edit or save preferences.  After you
  212.         have configured SID to your system, use this version if you are tight
  213.         on memory.
  214.  
  215.     Professional
  216.         In addition to all the basic features, SID2-Professional edits and
  217.         saves all SID preferences.  This version is personalized with the
  218.         full name and address of the registered user and should not be given
  219.         to others.
  220.  
  221.     Trial
  222.         The Trial version is similar to SID2-Professional except that it does
  223.         not save preferences and is not registered to individuals.  You are
  224.         encouraged to distribute this version to all interested parties
  225.         within the restrictions listed in its documentation.  Due to disk
  226.         space limitations, the Trial version is NOT included on the diskette
  227.         sent to registered users.  You can download this from my BBS.
  228.  
  229. There is also a separate program called QuickPrefs which reads your SID v1.06
  230. configuration file, if any; asks you some quick questions; configures SID to
  231. your system; and copies the help files, documentation, and programs to your
  232. system if desired.
  233.  
  234.  
  235. Running SID
  236. ~~~~~~~~~~~
  237.  
  238. You must run QuickPrefs first to create the seven preferences files that SID
  239. needs to run.  Double-click on the QuickPrefs icon from the Workbench and
  240. answer the questions.  You can display help at any time by pressing the HELP
  241. key or clicking on the HELP button.
  242.  
  243. You can run SID from the command line or from an icon.  Unfortunately, this
  244. version of SID will not detach from the CLI by itself, meaning you cannot
  245. close a CLI window after running SID (this will most likely affect users who
  246. run SID from their startup-sequence).  As a temporary fix, two "runback"
  247. programs are included which will detach SID from the CLI, one that runs under
  248. Workbench v1.3 and requires the NULL: device, and one that runs under WB 2.x
  249. and doesn't require any external device.  Both are stored in the "programs"
  250. directory and are copied to your system (where you specify) by QuickPrefs.
  251. In the following examples, assume you copied all SID programs to a directory
  252. named "WORK:SID2".
  253.  
  254. To run and detach SID from the CLI under Workbench v2.0
  255. -------------------------------------------------------
  256.  
  257.     Add the following line to your s:workbench-startup file (or if you do not
  258.     follow the WB 2.x conventions, add it to your s:startup-sequence file
  259.     AFTER the "LoadWB" command but before the "endcli >nil:" command):
  260.  
  261.         WORK:SID2/runback_wb2.x WORK:SID2/SID2
  262.  
  263. To run and detach SID from the CLI under Workbench v1.3
  264. -------------------------------------------------------
  265.  
  266.     If you do not already have the NULL: device mounted on your system:
  267.  
  268.         Add the supplied NULL-MountList entry to your devs:MountList file.
  269.         You can do this with a text editor, or enter from the CLI:
  270.  
  271.             WORK:SID2/NULL-install
  272.  
  273.         Add a command to mount the NULL: device from your s:startup-sequence
  274.         file.  Using a text editor, add the following line BEFORE the
  275.         "LoadWB" line:
  276.  
  277.             mount NULL:
  278.  
  279.         To mount the NULL: device now without rebooting, enter the above line
  280.         at the CLI.
  281.  
  282.     Add the following line to your s:startup-sequence file AFTER the "LoadWB"
  283.     command but before the "endcli >nil:" command:
  284.  
  285.         WORK:SID2/runback_wb1.3 WORK:SID2/SID2
  286.  
  287. Running SID, cont'd
  288. ~~~~~~~~~~~~~~~~~~~
  289.  
  290. Command-Line Arguments
  291. ----------------------
  292.  
  293. You can specify additional options when running SID from the command line by
  294. adding the following arguments after the program name:
  295.  
  296.   -b ... if SID2 normally opens on a custom screen, it will open behind
  297.          all other screens
  298.   -s ... opens the SID window in the shrink mode (as a small window on
  299.          the Workbench screen)
  300.   -p ... following by a path name will force SID to look in the specified
  301.          directory for the SID preferences files
  302.  
  303. For example:
  304.  
  305.   SID2 -s -pdf0:prefs
  306.  
  307. runs SID2 in shrink mode, loading the preferences files from the "prefs"
  308. directory on DF0:.
  309.  
  310. You can also tell SID to load one or two directories upon startup just by
  311. listing the directory name(s) after the program.  The -c argument will load
  312. the current directory.  For example:
  313.  
  314.   SID2 -b WB:tools -c
  315.  
  316. will open the SID screen behind all other screens and will load the WB:tools
  317. directory and the current directory upon startup.
  318.  
  319. Note that the arguments can be in upper or lower case and can appear in any
  320. order.
  321.  
  322. To run SID from an icon:
  323. ------------------------
  324.  
  325. When running SID from an icon, it is best to use IconX to open a CLI window,
  326. and use the appropriate runback program as described above to launch SID.
  327. Two icons are provided (appropriately labelled SID_WB2.x and SID_WB1.3) which
  328. do this.  They were copied with the other SID programs to your system where
  329. you specified in the QuickPrefs program.
  330.  
  331.  
  332. Troubleshooting SID
  333. ~~~~~~~~~~~~~~~~~~~
  334.  
  335. SID2 should be compatible with all Amiga models and Kickstart v1.3 and v2.x.
  336. Check this troubleshooting flowchart if you are having difficulties starting
  337. SID.  If you are having difficulties with one of the features once SID is up
  338. and running, use the on-line help system.
  339.  
  340. If you still cannot resolve the problem, call the SID support bulletin board
  341. system (BBS) at 606-344-1647.  The BBS operates 24 hours a day and handles
  342. 1200 and 2400 baud.  First time callers are granted the ability to read and
  343. leave messages to and from me.  If you are a registered user, you will be
  344. granted full access to the rest of the bulletin board usually within 24 hours.
  345.  
  346.  
  347. Does SID end with a requester saying "SID Failed:"?
  348.  
  349.   What does the second line in the requester say?
  350.  
  351.     button file
  352.  
  353.       SID requires seven preferences files to run, and the first file it
  354.       looks for is the button file.  Make sure you have run QuickPrefs to
  355.       create the preferences files.  If you have, then check to see if the
  356.       S:SID2.path file exists.  The SID2.path file contains the name of the
  357.       directory where the SID preferences files should be stored.  If
  358.       s:SID2.path does not exist, then SID expects the preferences files to be
  359.       in the s: directory.
  360.  
  361.       Check the directory where SID expects to find the prefs files.  You can
  362.       double-check to make sure SID is reading them correctly by running SID
  363.       from the CLI and specifying the -p argument with the name of the
  364.       directory to load those prefs.  If SID can find the files but still
  365.       ends with the "button file" error, then either 1) the button file is
  366.       corrupted, or 2) the button file format has changed.  Note that the
  367.       latter case may be possible if you had been using a beta version of
  368.       SID2.  The release version of SID2 is purposely incompatible with the
  369.       beta version because of heavy pirating of the beta version.
  370.  
  371.     color file
  372.  
  373.       The SID color preferences file is likely corrupt.  Run QuickPrefs to
  374.       create a new one.
  375.  
  376.     config file
  377.  
  378.       The SID configuration preferences file is likely corrupt.  Run
  379.       QuickPrefs to create a new one.
  380.  
  381.     console.device
  382.  
  383.       SID cannot open the console device.  This is a problem because the
  384.       console.device should be resident at all times.  Reboot your system and
  385.       attempt to run SID again.
  386.  
  387.     desc file
  388.  
  389.       The SID description preferences file is likely corrupt.  Run QuickPrefs
  390.       to create a new one.
  391.  
  392. Troubleshooting SID, cont'd
  393. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  394.  
  395.     diskfont.library
  396.  
  397.       SID cannot open the diskfont library which should be located in the
  398.       libs: directory.  Copy the "diskfont.library" file from a clean
  399.       Workbench disk to your libs: directory.
  400.  
  401.     font file
  402.  
  403.       The SID font preferences file is likely corrupt.  Run QuickPrefs to
  404.       create a new one.
  405.  
  406.     graphics.library
  407.  
  408.       SID cannot open the graphics library.  This is a big problem because the
  409.       graphics library should be present in ROM at all times.  Reboot your
  410.       system and attempt to run SID again.
  411.  
  412.     icon.library
  413.  
  414.       SID cannot open the icon library.  This is a problem because the icon
  415.       library should be present in ROM at all times.  Reboot your system and
  416.       attempt to run SID again.
  417.  
  418.     input.device
  419.  
  420.       SID cannot open the input device.  This may just be a low-memory
  421.       problem.  Reboot your system and attempt to run SID again.
  422.  
  423.     layout file
  424.  
  425.       The SID layout preferences file is likely corrupt.  Run QuickPrefs to
  426.       create a new one.
  427.  
  428.     memory
  429.  
  430.       SID ran out of memory while creating the basic structures needed to run
  431.       the program.  End other programs to free up memory for SID.
  432.  
  433.     menu file
  434.  
  435.       The SID custom menu preferences file is likely corrupt.  Run QuickPrefs
  436.       to create a new one.
  437.  
  438.     packets
  439.  
  440.       SID could not create the message ports necessary to send communications
  441.       packets to AmigaDOS.  This may just be a low-memory problem.  End other
  442.       program to free up memory for SID or reboot the system.
  443.  
  444.     ROM font
  445.  
  446.       SID could not open the Topaz8 ROM font.  This really shouldn't happen,
  447.       though if you have severely altered the system ROM font (which you
  448.       really only can do with Amiga 1000 kickstart machines), this error may
  449.       appear.
  450.  
  451. Troubleshooting SID, cont'd
  452. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  453.  
  454.     screen
  455.  
  456.       SID could not open the custom screen, most likely due to lack of memory.
  457.  
  458.     tampering
  459.  
  460.       Tsk, tsk, somebody has been tampering with the program.  If someone
  461.       attempts to modify my name in the program, modify the version number,
  462.       or modify the registered user's name, this is the first and only
  463.       warning.  Should you bypass this verification, there are over two dozen
  464.       others and none of them are as polite as this one.
  465.  
  466.     trackdisk
  467.  
  468.       SID cannot open the trackdisk device.  This is a problem because the
  469.       trackdisk device should always be accessible (after all, it monitors
  470.       disk activity).  This may also just be a low-memory problem.  Reboot
  471.       your system and attempt to run SID again.
  472.  
  473.     window
  474.  
  475.       SID could not open its window due to low memory.  End other programs to
  476.       give SID more breathing space.
  477.  
  478.  
  479. Is SID acting very "strangely" after opening up or sometimes during its
  480. operation?
  481.  
  482.   Most likely somebody has been tampering with the program.  If you attempt
  483.   to modify my name in the program, modify the version number, or modify the
  484.   registered user's name, strange things will happen.
  485.  
  486.  
  487. Does SID crash when started?
  488.  
  489.   Make sure you are using the proper version of runback, if any.  RunBack_1.3
  490.   should be used when running Kickstart 1.3, and RunBack_2.x should be used
  491.   when running Kickstart 2.x.  See "Running SID" above.
  492.  
  493.  
  494. Once SID is Running
  495. ~~~~~~~~~~~~~~~~~~~
  496.  
  497. SID2 is equipped with full context-sensitive on-line help and a help index.
  498. To receive help at any time, just press the HELP key.  You can also receive
  499. help for any button or menu by pressing and holding the CTRL key while you
  500. select the button or menu item.  You can also select help from the "Program"
  501. menu: there's help getting started, help registering SID, and a glossary.
  502.  
  503.  
  504. Bugs
  505. ~~~~
  506.  
  507. ...or "undesirable features," as I like to refer to them.  If you have
  508. determined that SID is just not operating as it should, attempt to replicate
  509. the problem.  Just telling me that "SID doesn't work" will not help me solve
  510. the problem.  Once you have identified the bug and can repeat it, either
  511. write me or call the SID support BBS and provide me with the following
  512. information:
  513.  
  514.   > The steps required to produce the bug.
  515.   > The symptoms of the bug (crashes, locks, draws smiley faces, etc.)
  516.   > Amiga model number
  517.   > Kickstart and Workbench versions
  518.   > Other programs you're running if you think the bug is the
  519.     result of an interaction between SID and another program
  520.  
  521.  
  522. Ideas
  523. ~~~~~
  524.  
  525. I am always looking for new ideas.  If you have something that you would like
  526. to see in SID, or if you have an idea for another Amiga program, please pass
  527. it on!
  528.  
  529.  
  530. The Future
  531. ~~~~~~~~~~
  532.  
  533. The future of SID depends on your interest and support.  If you like this
  534. program, please send in your registration fee and promote it to others.  If
  535. you don't like this program, please let me know why so I can improve it.  SID
  536. has become what it is today due to heavy input from some very talented users.
  537.  
  538.  
  539. The End
  540. ~~~~~~~
  541.  
  542. Well, that's it.  Because SID2 has full on-line help, I didn't see much need
  543. to repeat it here.
  544.  
  545. Let me know what you think about SID.  But most of all, enjoy it!
  546.  
  547.  
  548. SID2.Docs v2.00 03/05/92
  549. © Copyright 1992 Timm Martin
  550. All Rights Reserved Worldwide
  551.  
  552. /*-- END --*/
  553.