home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / BBS / RA / SUBDATE.ZIP / SUBDATE.DOC < prev    next >
Encoding:
Text File  |  1992-02-01  |  7.1 KB  |  187 lines

  1.  
  2.  
  3.    ┌────── WARNING ──────────────── WARNING ─────────────── WARNING ──────┐
  4.    │                                                                      │
  5.    │    THIS IS A BETA VERSION!  This BETA version of SUBDATE has been    │
  6.    │    released to the general public under the following conditions:    │
  7.    W                                                                      W
  8.    A      1: You accept FULL responsibility for any and all damage        A
  9.    R         this software may cause to your system because of bugs       R
  10.    N         or any other unforseen problems.                             N
  11.    I                                                                      I
  12.    N      2: You should not expect bug fixes or updates with any          N
  13.    G         regularity nor should you expect elaborate docs or           G
  14.    │         packaging.                                                   │
  15.    │                                                                      │
  16.    │                                                                      │
  17.    │                                                                      │
  18.    └────── WARNING ──────────────── WARNING ─────────────── WARNING ──────┘
  19.  
  20.  
  21. DO NOT use this software if any of the above bothers you.  SUBDATE writes
  22. to your message base and does so using new message writing routines so
  23. exercise extreme caution!
  24.  
  25.  
  26.  
  27. SUBDATE;  RACE User editor subscription utility, v0.2
  28.  
  29.  
  30. Intro
  31. -----
  32.  
  33. I've had dozens of questions from RACE users on how they go about getting
  34. RACE to send a message to a user BEFORE that user's subscription runs out.
  35. RACE, being an interactive utility, cannot do this.
  36.  
  37. RA cannot do this either and so it is apparent there is a need for such a
  38. utility.  SUBDATE is not too fancy but I believe it has everything needed
  39. to get the job done.
  40.  
  41. SUBDATE works entirely from command line parameters supplied by the Sysop.
  42. These can be typed manually and run while one watches or SUBDATE can be
  43. set up to run in the daily cleanup batch file.  The latter is the preferred
  44. method for a very important reason.
  45.  
  46. SUBDATE is set up to send a message to a user when that user's expiration
  47. date is =EXACTLY= the number of days away as the number of days parameter
  48. one provides on the command line.  If one runs SUBDATE in a hit and miss
  49. fashion, users about to run out of subscription time are sure to be passed
  50. by.  If run every day, this will not be a problem.
  51.  
  52. The reason for this is because it is not an easy matter to know if a user
  53. has already received a message about pending expiration of subscription.
  54. Using the exact match method means that the user will only get one message
  55. on the day his/her subscription is X days away.  Of course you'll want to
  56. make sure you only run SUBDATE once a day.
  57.  
  58. While not designed for logging, SUBDATE's output could be redirected to
  59. a file so you can see who has received a message if run in an unattended
  60. mode.  Of course you could also just look in the message base :-)
  61.  
  62.  **** IMPORTANT NOTICE ****
  63.  
  64. While it is possible for the SysOp to manually enter a subscription date in
  65. any date format, RA stores all other dates, and processes ALL dates, in
  66. MM-DD-YY format.
  67.  
  68. SUBDATE will take the -D parameter and convert the number of days to a
  69. MM-DD-YY format and then compare that to the user's subdate field.  As you
  70. can imagine, if the user's subdate is in any other format, the results when
  71. running SUBDATE.EXE will be unpredictable.
  72.  
  73.  
  74. Command Line Parameters
  75. -----------------------
  76.  
  77. The following are REQUIRED command line parameters.  SUBDATE also has a few
  78. optional parameters and I'll get into those a bit later.
  79.  
  80.  
  81. -M<textfile>
  82.  
  83. This switch defines the text file to use as the message that will be sent
  84. to users whose parameters meet the days parameter.  This should be an
  85. ASCII file.  This file may contain an assortment of codes that will
  86. be replaced by various user data (name, dates, etc.).  See the end of
  87. this document for a complete list of available codes.
  88.  
  89. -D<days>
  90.  
  91. This is the number of days in advance to send the message to a user.  This
  92. can be any number of days, even years in advance if you like.  As mentioned
  93. previously, the user's date must be EXACTLY -D<days> away before the
  94. message is sent.
  95.  
  96. -B<boardnum>
  97.  
  98. In which message board shall SUBDATE place the notification message?  NO
  99. check is made for an active area nor does SUBDATE have any idea as to
  100. whether or not the user has access to the message board you provide.  The
  101. only check made is to insure a number between 1 and 200 is used here.
  102. You'll probably want to use your general/private message area number.
  103.  
  104.  
  105. The following are OPTIONAL command line parameters:
  106.  
  107.  
  108. -P
  109.  
  110. Previously, the default was to NOT post a private message.  This has
  111. changed as of SUBDATE v0.3. The default now is to make the message
  112. private.  Use the -P switch if you do NOT want the message to have
  113. private status.
  114.  
  115.  
  116. -F"Mike Janke"
  117.  
  118. SUBDATE will place "Sysop" (no quotes of course) in the FROM field of the
  119. message unless you force otherwise by using this switch.  In this example,
  120. my name would go in the FROM field in place of the hard coded "Sysop".
  121.  
  122. IMPORTANT! If your name has spaces in it you *MUST* enclose your name in
  123. double quotes as my name is in the example above. DO NOT use underscores in
  124. your name. If you just use your first name or any single word, do NOT use
  125. the quote marks.
  126.  
  127.  
  128. -J<subject>
  129.  
  130. SUBDATE uses a message subject of "Subscription" by default.  If you would
  131. like a different subject, use this command line switch with the new
  132. subject.  As with the -F switch, if there are spaces in the text, you
  133. *MUST* enclose the entire subject in quotes.  Do not use quotes on a single
  134. word subject.
  135.  
  136.  
  137. Examples
  138. --------
  139.  
  140. example 1: SUBDATE -M\ra\expire30.msg -D30 -B3 -F"Da boss" -J"Send Money" -P
  141.  
  142. example 2: SUBDATE -M\ra\expire20.msg -D20 -B3 -J"Not much time left" -p
  143.  
  144. example 3: SUBDATE /d5 /b3 -Jadios -p -M\ra\expire5.msg
  145.  
  146.  
  147. As you can see from the examples, switch order is unimportant as is upper
  148. or lower case of switches.  Also, you may use / or - before the switch
  149. letter.  The three examples above could be run one after another in the
  150. daily cleanup.  Since each one affects users with a different number of
  151. days remaining, there will not be any duplicate messages sent to the same
  152. person.
  153.  
  154.  
  155. The following control codes are allowed for imported messages:
  156.  
  157. ^FA = user's full name
  158. ^FB = user's location
  159. ^F3 = user's handle
  160. ^F4 = Date of first call
  161. ^F5 = date of birth
  162. ^F6 = Subscription date
  163. ^FC = Password
  164. ^FD = Data phone number
  165. ^FE = Home phone number
  166. ^FF = Date of last call
  167. ^FG = Time of last call
  168. ^FL = NetMail credit
  169. ^FM = Total messages posted
  170. ^FO = Security level
  171. ^FP = Total calls to the BBS
  172. ^FQ = Number of uploads
  173. ^FR = Kilobytes of uploads
  174. ^FS = Number of downloads
  175. ^FT = Kilobytes of downloads
  176. ^FU = Minutes used today
  177. ^FW = user's first name
  178. ^F? = user's file ratio in number of files
  179. ^F@ = user's file ratio in kilobytes
  180.  
  181. If you are not familiar with how these codes work, see the RemoteAccess
  182. documentation.  SUBDATE handles the codes in exactly the same manner.
  183.  
  184.  
  185.  
  186.                                 The end.
  187.