home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 198.lha / JDisk_v1.0 / jdisk.doc < prev    next >
Encoding:
Text File  |  1988-12-28  |  4.9 KB  |  126 lines
  1. /* Copyright 1988 by I2(EYE) Systems.        JDISK.DOC - Version 1.0
  2. *
  3. *
  4. *          JDISK - Disk (Volume) Requester Program
  5. *
  6. *  This software may be freely distributed provided that this notice
  7. *  is retained.  It may be hacked or used as is in any product as long
  8. *  as you credit me for it.
  9. *
  10. *  If you find this program useful for enhancing your script file
  11. *  capabilities, please send $5.00 to:
  12. *
  13. *            I2(EYE) Systems
  14. *            6620 Hunter Road
  15. *            Elkridge, MD 21227
  16. *            Attn: J. Barshinger
  17. *
  18. *    USENET or ARPANET: barsh@stsci
  19. *
  20. *    Note: if you send $10.00,  I'll send you the source and the
  21. *          latest enhancements.
  22. *          Planned enhancements include a re-entrant version so
  23. *          that it can be made resident and a mouse-move capability
  24. *          that will automatically move the pointer to the default
  25. *          gadget.
  26. *
  27. *        JDISK - Disk (Volume) Requester Program
  28. *        ---------------------------------------
  29. *            
  30. *  JDISK is a disk requester program that can be used in your startup-
  31. *  sequence or any AmigaDos script file.  It will allow the user to
  32. *  specify the disk (volume) name that is desired in a particular
  33. *  drive.  When the correct disk is inserted in the specified drive
  34. *  JDISK will automatically exit with no error.  If the user clicks
  35. *  on the positive gadget (CANCEL), JDISK will return WARN (5) to
  36. *  AmigaDos, much like a positive response from the AmigaDos 1.3 ASK
  37. *  command.  If the user selects the negative gadget (RETRY), JDISK
  38. *  will check to see if the correct disk has been inserted and if the
  39. *  disk is found, return success (0).
  40. *
  41. *  You can move the "requester" to the bottom of the screen or to the front
  42. *  or back of other screens if you don't want to answer it at the moment.
  43. *
  44. *            JDISK Parameters
  45. *            ---------------
  46. *                
  47. *    -r  This parameter specifies the "requester" text.  This is
  48. *        the question you want to ask.
  49. *         
  50. *        This is a REQUIRED parameter. (40 character max.)
  51. *
  52. *        EXAMPLE: "-rPLEASE insert LATTICE_5_0_2 in DF1:"
  53. *        = PLEASE insert LATTICE_5_0_2 in DF1: in the requester box.
  54. *        (put quotes around the string to put spaces in the text)
  55. *    
  56. *    -v  This parameter specifies the name of the disk you want
  57. *        in a given drive.
  58. *
  59. *        This is a REQUIRED parameter. (20 character max.)
  60. *
  61. *        EXAMPLE: -vLATTICE_5_0_2
  62. *        = LATTICE_5_0_2 is the name of the desired disk.
  63. *
  64. *    -x  This parameter specified which drive you want the specified
  65. *        disk put in.  This is a hex integer.
  66. *        The following are valid inputs:
  67. *         1 = df0:,  2 = df1:,  4 = df2:,  8 = df3:,
  68. *        10 = df4:, 20 = df5:, 40 = df6:, 80 = df7:
  69. *        You can also specify a combination of disks by
  70. *        adding the above numbers. (i.e. say you want the
  71. *        disk in df2 or df5 or df7, add 4 + 20 + 80 = A4,
  72. *        remember we're adding in hex).
  73. *
  74. *        Another way to look at it is: consider that each bit position
  75. *        specifies a drive number, it the bit is set, that means we
  76. *        want to look at that drive.  Currently, we only look at bits
  77. *        0 - 7, I can't believe you have more drives than that...
  78. *        If bit 0 is set, you have selected df0:
  79. *        If bit 1 is set, you have selected df1:
  80. *        If bit 2 is set, you have selected df2:
  81. *        If bit 7 is set, you have selected df7:
  82. *        If bits 1, 2, 7 are set, you have selected df1, df2, and df7.
  83. *        Now just convert that to hex and pass it in this parameter.
  84. *
  85. *        This is a REQUIRED parameter.
  86. *
  87. *        EXAMPLE: -x3 = look for the disk in drives df0: and df1:
  88. *
  89. *    -p  This specifies the text for the positive (left) gadget.
  90. *        When this gadget is selected, WARN (5) will be returned.
  91. *        (put quotes around the string to put spaces in the text)
  92. *        DEFAULT: CANCEL    (12 character max.)
  93. *        EXAMPLE: "-pGIVE UP" = GIVE UP in the left gadget.
  94. *
  95. *    -n  This specifies the text for the negative (right) gadget.
  96. *        When this gadget is selected, 0 will be returned (success).
  97. *        (put quotes around the string to put spaces in the text)
  98. *        DEFAULT: RETRY        (12 character max.)
  99. *        EXAMPLE: -nREADY = READY in the right gadget.
  100. *
  101. *    -t  This will specify a timeout period in seconds.  When the
  102. *        timeout period expires, the default answer will be returned.
  103. *        DEFAULT: wait forever
  104. *        EXAMPLE: -t10 = wait 10 seconds.
  105. *        
  106. *    -d  This parameter specifies which gadget is the default (safe)
  107. *        answer.  It does two things:
  108. *        a) determines if the positive or negative answer is 
  109. *           to be default.
  110. *        b) makes a more extravagant border for the specified
  111. *           gadget.
  112. *        n specifies the negative answer, p specifies the positive
  113. *        answer.
  114. *        DEFAULT: if this is not specified, both gadgets will look
  115. *                 the same, but the positive (CANCEL) gadget will 
  116. *             be returned.
  117. *        EXAMPLE: -dp = Fancy gadget rendered on positive and positive
  118. *                       is the default answer.
  119. *
  120. *    -q  This specifies whether you want the "requester" quick or if
  121. *        you want the "requester" to scroll up.
  122. *        DEFAULT: the "requester" scrolls up to it final position.
  123. *        EXAMPLE: -q = turn off the scrolling effects.
  124. *
  125. */
  126.