home *** CD-ROM | disk | FTP | other *** search
/ The Education Master 1994 (4th Edition) / EDUCATIONS_MASTER_4TH_EDITION.bin / files / progmisc / smake20 / readme.sup < prev    next >
Text File  |  1991-06-03  |  24KB  |  511 lines
  1. ****************************************************************************
  2. Thank you for using Programmer's SUPER-MAINT.  The program has many 
  3. features, and after you become comfortable using it you'll find it 
  4. saves you time and effort in building your progamming projects.
  5. ****************************************************************************
  6.  
  7. ****************************************************************************
  8. You can conveniently read this file from within INSTALL, and print it to 
  9. your printer (if installed on lpt1) if you want to.
  10. ****************************************************************************
  11.  
  12. ****************************************************************************
  13. If you are new to make utilities print out and read the file NEW2MAKE.TXT
  14. (it is on Disk #2 (5 1/4" disks only), or in SUPER_B.ZIP).
  15. ****************************************************************************
  16.  
  17. ****************************************************************************
  18. If you are a shareware VENDOR, a BBS, or USER GROUP who wants to distribute 
  19. SUPER-MAINT please read the file VENDOR.DOC.
  20. ****************************************************************************
  21.  
  22. ****************************************************************************
  23. If you want to order a registered copy please see the file REG.FRM.
  24. ****************************************************************************
  25.  
  26. ****************************************************************************
  27. Since the manual was printed some additional features have been added. 
  28. Please print out the file ADDENDUM.MAN and insert it into your manual.
  29. ****************************************************************************
  30.  
  31. ****************************************************************************
  32. The topics covered in this file are:
  33.  
  34. 1.  Shareware                     2.  Installation
  35. 3.  Manual (view and print)       4.  Compiler Support
  36. 5.  The future                    6.  Product Support*
  37. 7.  Printing Utilities            8.  The sample program
  38. 9.  A note on building libraries
  39.  
  40. *General notes; Special notes for users of Clipper, Mix Power C
  41. ****************************************************************************
  42.  
  43. **************  A NOTE ABOUT OUR BULLETIN BOARD SYSTEM *********************
  44.  
  45. As of February 1991 the EmmaSoft Shareware Board BBS has been on line.  
  46. All the LATEST VERSIONS of EmmaSoft shareware can be found here.  In 
  47. addition there is a growing collection of other shareware programs, most 
  48. notably those written by Association of Shareware Professionals authors.  
  49. There is no charge for accessing this board, and downloads are unlimited 
  50. (except by the daily time limit).  In addition you may order any EmmaSoft 
  51. product using the BBS, and registered users may get technical support 
  52. there.  The EmmaSoft Shareware Board is an approved ASP BBS.
  53.  
  54. 607-533-7072    2400,1200,300bps    N,8,1    24 hours    No access Fee
  55.  
  56. ****************************************************************************
  57.  
  58. If you got SUPER-MAINT on 5 1/4" disks you MUST have DISK#1 AND DISK#2.
  59. Both are contained on the 3 1/2" disk version.  If you got an evaluation
  60. copy on a BBS you must have two files:  SUPER_A.ZIP and SUPER_B.ZIP.  On
  61. some BBSs these are both contained in a large file called SUPER.ZIP.
  62.  
  63. The following files MUST be on your distribution disks, or contained in
  64. the .zip file you recieved SUPER-MAINT on.  If any of these are missing 
  65. PLEASE CONTACT EMMASOFT IMMEDIATELY: you have probably recieved an 
  66. unauthorized package.  To insure that you get a complete version you must 
  67. have an authorized package.  You may get the distribution disk for a small 
  68. fee from EmmaSoft or from authorized shareware distributers, or get the 
  69. .zip file from many bulletin boards across the US.
  70.  
  71.     DISK #1  (or SUPER_A.ZIP)
  72.  
  73.          BBS.TXT            Information about EmmaSoft's BBS
  74.      INSTALL.EXE            Automatic Installation Program
  75.       README.1st            Where to find things to get started Now!
  76.       README.SUP            This File
  77.          REG.FRM            Registration Form 
  78.         SMAK.EXE            SUPER-MAINT Files
  79.        SUPER.INF            Brief Description of SUPER-MAINT
  80.       VENDOR.DOC            File for Shareware Vendors, SysOps, User Groups
  81.  
  82.     DISK #2  (or SUPER_B.ZIP)
  83.    
  84.     ADDENDUM.MAN            Recent Additions to the Manual
  85.          BOR.EXE            Borland Language Definition Files 
  86.         CLIP.EXE            Clipper Language Definition Files 
  87.         DEMO.EXE            Demo Language Definition Files/ Bogus Compilers
  88.         MANX.EXE            Aztec Manx Language Definition Files 
  89.          MIX.EXE            Mix Language Definition Files 
  90.           MS.EXE            Microsoft Language Definition Files
  91.     NEW2MAKE.TXT            File for programmers new to Make programs
  92.            S.COM            Landscape Print Utility
  93.     SMUPDATE.TXT            A history of updates to SUPER-MAINT
  94.       SMUTIL.EXE            Help files, Sample Program, Manual and Indexes
  95.  
  96. SUPER-MAINT consists of four programs:
  97.  
  98. SM.EXE    SUPER-MAINT                  A make program
  99. SME.EXE   SUPER-MAINT Editor           Automatically generates make and
  100.                                        other files
  101. SMSET.EXE SUPER-MAINT Setup Facility   Sets up parameters needed by all 
  102.                                        four programs
  103. SMH.EXE   SUPER-MAINT Help Facility    Used by maker, or can be used as
  104.                                        a stand alone program
  105.  
  106. Acknowledgements:
  107.  
  108. Special thanks to the beta testers:    For helping with a thorny problem:   
  109.  
  110.    Don Bowen                                Tom Bruce
  111.    Todd Hutchinson (version 1)
  112.    Herb Kraft
  113.    Ralph Mace
  114.    Allen Morris
  115.    Peter Schulz
  116.    Larry Weaver
  117.  
  118. ****************************************************************************
  119. ****************************************************************************
  120.  
  121. 1. SHAREWARE:
  122.  
  123. The advantage to using shareware is that you get to "try before you buy"
  124. the program.  There are many excellent shareware packages, and we hope 
  125. you will feel SUPER-MAINT is one of them.  If you do, and you use the
  126. program beyond 30 days, you must register your copy.
  127.  
  128. Registration has many advantages:
  129.  
  130. 1.  You get the latest version of SUPER-MAINT on disk with a printed manual.
  131.  
  132. 2.  The version you recieve has the registration reminder screens removed.
  133.  
  134. 3.  You get a serial number that entitles you to technical support.
  135.  
  136. 4.  You will recieve upgrade notices and you will be able to upgrade at
  137.     a discount.
  138.  
  139. 5.  You will recieve a free CompuServe Intro Pak including $15 on-line 
  140.     credit and a complimentary subscription to CompuServe Magazine
  141.  
  142. 6.  You may subscribe to Shareware Magazine for a substantial discount.
  143.  
  144. Registering SUPER-MAINT is still only $55.  See the file reg.frm for a 
  145. registration form (you may do this by mail, or by plastic: EmmaSoft 
  146. accepts phone registrations, registrations by CompuServe Mail, and on our 
  147. own BBS if you have Master Card or Visa).
  148.  
  149. SUPER-MAINT was written by Dan Veaner, an ASP (Association of Shareware 
  150. Professionals) member.  For more information about shareware and the ASP 
  151. see chapter 9 in the manual.  See "Product Support" below to see how to
  152. reach me.
  153.  
  154. ASP (Association of Shareware Professionals)
  155.  
  156. After reading chapter 9 if you are interested in learning more about the 
  157. ASP log onto CompuServe and GO ASP.  We also have information about the 
  158. ASP on our BBS.  Or write: Executive Director;  ASP;  545 Grover Road;  
  159. Muskegon, MI 49442-9427.  If you are a shareware author, distributer, or 
  160. BBS SysOp you should consider joining for the many benefits membership 
  161. provides.
  162.  
  163. ****************************************************************************
  164. ****************************************************************************
  165.  
  166. 2. INSTALLATION:
  167.  
  168. You should use the automatic installation program to install SUPER-MAINT.  
  169. (You will need approximately 560K free disk space to complete an 
  170. installation.)  It will copy the SUPER-MAINT files to your hard disk, 
  171. create directories, if needed, set up an initialization file, and perform 
  172. a few other tasks.  
  173.  
  174. A SPECIAL NOTE:
  175.  
  176. THE INSTALLATION PROGRAM WILL NOT MAKE NEW DIRECTORIES OR CHANGE YOUR
  177. AUTOEXEC.BAT FILE UNLESS YOU EXPLICITLY GIVE IT PERMISSION TO DO SO.
  178. THE PROGRAM DOES NOT TOUCH YOUR CONFIG.SYS FILE OR ANY OTHER FILES ON
  179. YOUR COMPUTER.  IF YOU CHOOSE **NOT** TO LET INSTALL UPDATE YOUR
  180. AUTOEXEC.BAT FILE YOU **MUST** SET THE SUPERFILES VARIABLE IN YOUR DOS 
  181. ENVIRONMENT, AND ADD THE SUPER-MAINT DIRECTORY TO YOUR PATH COMMAND FROM 
  182. YOUR AUTOEXEC.BAT FILE.
  183.  
  184. examples:
  185.  
  186.                          PATH C:\;C:\DOS;C:\SUPER
  187.  
  188.                          SET SUPERFILES=C:\SUPER  
  189.  
  190. ("C:\SUPER is the drive and directory containing your SUPER-MAINT files).
  191.  
  192.  
  193. To begin type:              INSTALL <Enter>
  194.  
  195. Just answer the questions you are asked as you go along.  If you change your
  196. mind INSTALL lets you change your answers before it begins installation.
  197.  
  198. ****************************************************************************
  199. After INSTALL finishes an installation it calls SMSET in `beginner' mode so
  200. you can set the options for your installation.  If you don't understand a
  201. category just accept the default.  When you are done print out the manual
  202. (SME alt-t alt-m alt-p) and refer to chapter 5 while running SMSET from
  203. the command line or from inside SME.
  204. ****************************************************************************
  205.  
  206. NOTE:  INSTALL.EXE does NOT copy itself, the compressed (self-extracting
  207. files), S.COM, or text files to your hard drive.  Only files that are 
  208. needed to run SUPER-MAINT are copied.
  209.  
  210.                          ----IMPORTANT----
  211.  
  212. WE NO LONGER SUPPORT MANUAL INSTALLATIONS.  PLEASE USE THE INSTALL.EXE
  213. PROGRAM TO INSTALL SUPER-MAINT.  PLEASE NOTE: WITH THE EXCEPTION OF 
  214. INSTALL.EXE AND S.COM ALL PROGRAM FILES ON THE DISTRIBUTION DISKS OR IN 
  215. THE ZIP FILES ARE SELF-EXTRACTING FILES.  SUPER-MAINT SHOULD BE INSTALLED
  216. ON A HARD DISK, NOT ON FLOPPIES.
  217.  
  218.  
  219. IMPORTANT NOTE:   It is assumed in these documents that your compilers
  220. are kept in directories that are included in your PATH command.  If they
  221. are not SUPER-MAINT will not be able to call them.
  222.  
  223. ****************************************************************************
  224. ****************************************************************************
  225.  
  226. 3. MANUAL:
  227.  
  228. Full documentation is included with each copy of SUPER-MAINT.  On disk
  229. it is provided in a special format SUPER-MAINT can read.  Here's how to
  230. view it and print it on your printer:
  231.  
  232. You may view the manual on line in the SUPER-MAINT Editor, or when using
  233. the Help Facility.  Most of the manual may be viewed in this way.  For
  234. the complete manual you will want a printed manual.  To get a printout 
  235. of the manual either go into the toolbox menu in the SUPER-MAINT Editor, 
  236. or call the Help facility as follows:  SMH MANUAL.  You will see a table 
  237. of contents on your screen.
  238.  
  239. Press Shift-F7.  You are now prompted for a printer or filename.  If you
  240. want to print directly to your printer type Enter (for lpt1), or you 
  241. may type lpt2, com1, or com2 if you printer is attached to one of these
  242. ports.  If you want to print to a file (for importation into a word
  243. processor, or to print later) type a file name.
  244.  
  245. By the way, the manual is about 60 pages long.  (If you register you may 
  246. notice the manual is 80 pages long.  The text is identical - it's just the 
  247. way the type is set that makes the difference.  The table of contents and 
  248. index have been adjusted for the different page numbers.)
  249.  
  250. A file called ADDENDUM.MAN has been included that has updates and 
  251. additions to the manual.  Please print this out and attach it to your
  252. printed manual.
  253.  
  254. ****************************************************************************
  255. ****************************************************************************
  256.  
  257. 4.  COMPILER SUPPORT
  258.  
  259. At the moment SUPER-MAINT can be configured for several brands of 
  260. compiler(s): Microsoft, Borland, Aztec, Clipper and Mix.  When you install 
  261. using INSTALL.EXE you choose to set it up for one of these or for the 
  262. demonstration (bogus) compilers.
  263.  
  264. BRAND SPECIFIC NOTES:
  265.  
  266. SUPER-MAINT always writes make files such that Linkers and Librarians ALWAYS 
  267. use Response files.
  268.  
  269. Borland, Aztec, Clipper and MIX users will want to include the full path 
  270. when setting library names in SME.
  271.  
  272. When generating a SUPER-MAINT file for Borland products some linker and 
  273. librarian commands are appended to the memory model macros in order to
  274. end up with the proper command structure.
  275.  
  276. When building a make file for AZTEC libraries SUPER-MAINT adds an action
  277. block to run the list of object files through the ORD program.
  278.  
  279. ****************************************************************************
  280. The SUPER-MAINT Editor builds make files with macro sets.  When the maker
  281. sees the symbol for one of these sets in a make file it calls the 
  282. appropriate macros, in order, in that set.  You should be aware that 
  283. SUPER-MAINT calls macros in different orders for some compiler brands:
  284.  
  285. BORLAND:       compiler_command  all_macros*  file_to_compile LxF2_macro
  286. CLIPPER:       compiler_command  file_to_compile all_macros
  287. ALL OTHERS:    compiler_command  all_macros  file_to_compile
  288.  
  289. compiler command:  CL for Microsoft, TC for Turbo C, etc.
  290. all_macros:        Set of 8 macros used by SUPER-MAINT (macros are defined 
  291.                    in LASTMACS.SM using the "Macros" choice in the "Make"
  292.                    menu of SME.EXE).
  293. file_to_compile:   MYFILE.C, MYPROG.ASM, etc.
  294. *All macros except the LxF2 are called before the file name (x refers to the 
  295. language number 1, 2, or 3)
  296. ****************************************************************************
  297. SPECIAL NOTES FOR USERS OF CLIPPER:
  298.  
  299. The Clipper Language Definitions Files come set up for using PLINK86 (that 
  300. comes with Clipper.  You will have to replace the LINKER.SM language 
  301. definition file if you set SUPER-MAINT to use a different linker.  (All 
  302. other brands are set to use the linker that comes with the language 
  303. products.)  This is easy to do:  but Disk#2 in drive a:.  Go to the directory 
  304. you have installed SUPER-MAINT files in.  If you want to use Microsoft's 
  305. LINK.EXE If you want to use Borland's type "A:MS LINKER.SM (Enter)".  
  306. TLINK.EXE type "A:BOR LINKER.SM (Enter)".  
  307.  
  308. In SMSET (setup facility), if you choose CLIPPER you are asked to choose a 
  309. linker.  If you choose PLINK86 or "None" you are also asked to choose a 
  310. librarian, even if you won't be using one.  You must set up a language 
  311. definition file for the librarian you choose.  Do this the same way you set
  312. up the linker language definition files, but replace "LINKER.SM" with 
  313. "LIB.SM" in the command.
  314.  
  315. If you choose "None" for your linker it means you are using a linker that is
  316. not supported by SUPER-MAINT.  Simply write your own response files for these
  317. linkers.  You may also have to change the linker action block in the make file.
  318.  
  319. SPECIAL NOTE FOR USERS OF MIX POWER C:
  320.  
  321. When using the MIX librarian (MERGE.EXE) the name of the library must not
  322. be the same as the name of one of the modules in it.  This is because
  323. object modules and libraries both use the same (.MIX) extension.  To
  324. automate this change the setting for the executable file name in the
  325. Setup menu as follows (from the main menu bar):
  326.  
  327.         Alt-s   Setup Menu
  328.         alt-n   Name Defaults
  329.                Down to Executable File Name
  330.         N       No for "Don't use default"
  331.                6 times to get to bottom
  332.         Enter   Accept changes
  333.         Esc     Back to main menu bar
  334.  
  335. /*************************************************************************
  336. *                                                                        *
  337. * If you use products other than those currently supported and would     *
  338. * like them supported by SUPER-MAINT We'll be happy to write them into   *
  339. * the program.  Contact us and we'll tell you what information we need.  *
  340. *                                                                        *
  341. *************************************************************************/
  342.  
  343. BOGUS COMPILERS (DEMO Setup):
  344.  
  345. The "Demo" files wer written for demonstrating Programmer's SUPER-MAINT at
  346. COMDEX.  The idea was to demonstrate the program without the overhead of
  347. a real compiler, assembler, etc.  The demonstration uses 5 programs: a
  348. bogus compiler, bogus assembler, bogus linker, bogus librarian, and a
  349. bogus debugger.  These and the requisite language definition files
  350. are placed on your disk when you choose "Demo" in INSTALL.
  351.  
  352. The first two create bogus object files.  These are actually ascii files
  353. with the .OBJ extension.  The linker does the same, but creates a file 
  354. with the .EXE extension.  The librarian uses the .LIB extension.  All 
  355. take similar arguments to their Microsoft counterparts, but the arguments
  356. have no effect.  The one exception is the /CO argument for the linker.
  357. If you use /CO the ascii file starts with a line "Debugging Information 
  358. Included."  The Bogus Debugger reads the first letter of the bogus .EXE
  359. file.  If it is a "D" the debugger starts normally.  If not it displays
  360. a message that debugging information is not included.
  361.  
  362. If you want to try Programmer's SUPER-MAINT without using real compilers,
  363. etc. install the "Demo" files when INSTALL.EXE asks "Who manufactures
  364. your compiler(s)?".  When you use SUPER-MAINT it will call the bogus
  365. programs to create bogus files.  Use the bogus debugger to see whether
  366. "debugging information" was included (as a test of the -d and -n flags).
  367.  
  368. IMPORTANT NOTE:  Do NOT try to run bogus .EXE files, and do NOT link
  369. bogus .OBJ or .LIB files into real programs!
  370.  
  371. ALSO NOTE:       When using the Demo setup SM.EXE and SME.EXE think they
  372. are set up for Microsoft Compilers.  (If you use alt-b you can confirm 
  373. this.)  This is NOT an error.
  374.  
  375.         Bogus C Compiler:       EBCL.EXE
  376.         Bogus Assembler:        EBMASM.EXE
  377.         Bogus Linker:           EBLINK.EXE
  378.         Bogus Librarian:        EBLIB.EXE
  379.         Bogus Debugger:         EBDB.EXE
  380.  
  381.                              --------
  382.  
  383. ****************************************************************************
  384. ****************************************************************************
  385.  
  386. 5.  THE FUTURE
  387.  
  388. Note from the author:
  389.  
  390. The reason I wrote SUPER-MAINT was to make life easier for myself and other
  391. programmers.  If there are features you would like in SUPER-MAINT please
  392. don't hesitate to contact me.  Please don't be angry at the program for
  393. not doing something you want it to do.  Instead let me know what you want
  394. and there is a very good chance it will be included.  I try to include as
  395. many users' suggestions into my programs as is reasonable (given the scope
  396. of the program).  So please keep those cards and letters coming!
  397.  
  398. If SUPER-MAINT works with your compiler that is not listed in this file
  399. please let me hear from you.  I would be grateful for language definition
  400. files for your compiler.  If you send them (and they are not duplicates
  401. of others sent) I will include them in a future release of the product with
  402. appropriate credit to you.
  403.  
  404.  
  405. ****************************************************************************
  406. ****************************************************************************
  407.  
  408. 6.  PRODUCT SUPPORT
  409.  
  410. We make every effort to make our products happy, bug free programs.  We 
  411. test our software rigorously before releasing it.  SUPER-MAINT has been 
  412. used in it's own development since there's been enough of it to work properly.  
  413. Every once in a while one of those pesky insects does get into a program, 
  414. and bug reports are greatly appreciated from all users.
  415.  
  416. Technical support is ONLY available to REGISTERED users with a valid
  417. serial number (when you register you are sent the latest copy of SUPER
  418. MAINT with printed documentation, a valid serial number, and WITHOUT the
  419. shareware reminder messages that are built in to the unregistered version).
  420.  
  421. EmmaSoft does NOT support third party products.  For example, we don't
  422. give technical support for Microsoft C, Turbo C, etc.  Please call the
  423. manufacturer for support for these products.
  424.  
  425. EmmaSoft is open 9 to noon, 1-5, M-F (and sometimes on Saturdays).  The
  426. address is:  EmmaSoft   PO Box 238   Lansing, NY 14882-0238.
  427.  
  428. The voice phone is  (607) 533-4685.
  429. The BBS phone is (607)533-7072  (24 hrs. 2400, 1200, 300 bps  N,8,1)
  430. CompuServe ID: 71460,2644.
  431.  
  432. If you are a registered user you may have access to the tech support 
  433. conference on EmmaSoft's BBS.  Leave a note for the SysOp, including your
  434. serial number, and within a day or so you will have access there.  Meanwhile
  435. you may leave support questions in private messages on the main board.
  436.  
  437. If you call and get the answering machine please leave a message.  If you
  438. want me to call you back please leave a number where we can call collect, 
  439. and some good times to reach you.
  440.  
  441. ****************************************************************************
  442. ****************************************************************************
  443.  
  444. 7.  PRINTING UTILITY
  445.  
  446. A source code landscape printing utility for LasetJet users is included with
  447. SUPER-MAINT.  Users of version 1 may wonder why there are no longer 2 
  448. utilities: the functions of both have been included in the new S.COM.
  449.  
  450. If you have the 2 disk set S.COM is on Disk 2.  If you downloaded 
  451. SUPER_A.ZIP and SUPER_B.ZIP it will be in the latter file.  INSTALL
  452. does not copy S.COM to your disk.
  453.  
  454. ****************************************************************************
  455. ****************************************************************************
  456.  
  457. 8.  THE SAMPLE PROGRAM
  458.  
  459. Included with this package is a set of sample files that you can use to
  460. experiment with.  These consist of:
  461.  
  462.   SAMPLE.C         C Code
  463.   SAMPLE1.C        C Code
  464.   SAMPLE2.C        C Code          {  use one or the other  }
  465.   SAMPLEA.ASM      Assembly Code   {  but not both modules  }
  466.   SAMPLEA.OBJ      Object made from SAMPLEA.ASM for C Programmers who don't
  467.                    own MASM
  468.   SAMPLE.EXE       An executable version.
  469.  
  470. SAMPLE.EXE is a simple multi moduled program addition using C and Assembly 
  471. language.  It contains 5 functions: 2 in each C module, and one in the 
  472. assembler module.
  473.  
  474. To call it you type SAMPLE and two numbers (ex: SAMPLE 5 67).  It will
  475. add the numbers and report on whether it is exiting properly or with
  476. an error condition.
  477.  
  478. NOTE:  You may only use SAMPLEA.ASM if you have Microsoft MASM.  If you do
  479. you must compile the program in the small model.  Otherwise, replace 
  480. SAMPLEA.ASM with SAMPLE2.C and compile in any model.  It contains the C 
  481. version of the assembly module.
  482.  
  483. ****************************************************************************
  484. ****************************************************************************
  485.  
  486. 9. A NOTE ON BUILDING LIBRARIES
  487.  
  488. Because SUPER-MAINT depends on response (command) files you may find building
  489. libraries minorly awkward if you are building the same library in more than 
  490. one memory model.  What you need to do is to build the library using the name 
  491. you have chosen.  For each memory model you build RENAME the final library.  
  492. For example if you are building three versions of the MYLIB library you build 
  493. it once for each memory model:
  494.  
  495.              sm -1 MYLIB
  496.  
  497. then rename the library for that model:
  498.  
  499.              ren MYLIB.LIB SMYLIB.LIB
  500.  
  501. Now rebuild for the medium model:    sm -er -2 MYLIB
  502.  
  503. and rename the final file:
  504.  
  505.              ren MYLIB.LIB MMYLIB.LIB
  506.  
  507. and so on.
  508.  
  509. Library maintainance is on the slate for major improvements in version 3.
  510. ****************************************************************************
  511.