home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the Mac Game Programming Gurus / TricksOfTheMacGameProgrammingGurus.iso / Tools / nShell™ 1.0.3 / src / Programmer's Guide / 05 Command Resources < prev    next >
Encoding:
Text File  |  1994-09-04  |  2.2 KB  |  41 lines  |  [TEXT/ttxt]
  1. 05 Command  Resources
  2. =====================
  3.  
  4. At the minimum, nShell commands contain a code resource (of type "NSHC") and two version resources (of type "vers").  Commands may also contain man pages (of type "TEXT") and custom resources.
  5.  
  6. Code Resource Types
  7. -------------------
  8.  
  9. The nShell environment supports single-segment code resources.  The code resource for a command should have a type of "NSHC" and a name of "command".
  10.  
  11. Version Resources
  12. -----------------
  13.  
  14. nShell commands contain two "vers" resources.  Resource I.D. #1 is used to specify which version of the nShell application the command was written for.  Resource I.D. #2 is used to specify the version of the command itself.
  15.  
  16. Please follow these rules when creating "vers" resources:
  17.  
  18. 1. Make the I.D. #1 resource match that of the application exactly.
  19.  
  20. 2. Make the major revision portion of the I.D. #2 resource match the major revision of the application exactly.  (If for example, the application had a version of a.b.c, please make your version a.x.x)
  21.  
  22. The nShell uses these version resources to determine which interface should be used when calling your command.
  23.  
  24. Man Page Resources
  25. ------------------
  26.  
  27. To create a "man page" for your command, create a "TEXT" resource with an I.D. of 16000 or above, and a name of "man general".  You can use ResEdit to create this resource and type in the text directly.
  28.  
  29. When the user types "man my_command", the man program will open my_command and read in the "man general" resource.  This resource is then listed to standard output.
  30.  
  31. If you would like to create supplemental man pages, give them resource I.D.s above 16000 and names in the format "man subject".
  32.  
  33. When the user types "man my_command something", the man program will open my_command and read in the "man something" resource.  This resource is then listed to standard output.
  34.  
  35. Other Resources
  36. ---------------
  37.  
  38. You may include any other resources you like with your command.  Just give them I.D.s above 16000.
  39.  
  40. Please note however, that the nShell detaches commands and closes the resource file before calling your main.  If you want to get a resource, use arg[0] to locate and open the file.  (See the source for the "man" command for an example of the technique.)
  41.