home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: InfoMgt / InfoMgt.zip / birthday.zip / BIRTHDAY.HLP (.txt) < prev    next >
OS/2 Help File  |  1995-08-26  |  18KB  |  302 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Credits ΓòÉΓòÉΓòÉ
  3.  
  4.  
  5. ΓòÉΓòÉΓòÉ 2. About the birthday notifier ΓòÉΓòÉΓòÉ
  6.  
  7. The birthday notifier 
  8.  
  9. Welcome to the birthday notifier program. In order not to forget those 
  10. anniversaries ever again this program helps you to remember them in time. The 
  11. program shows you today's and tomorrow's anniversaries of your friends and 
  12. relatives. 
  13.  
  14. Why today and tomorrow? The today mode remembers you to give a call on the day 
  15. itself. The tomorrow mode allows you to mail a postcard just in time. 
  16.  
  17. Supposed usage 
  18.  
  19. The birthday program is intended to be used in the start-up folder. This will 
  20. give you an overview of all current birthday's on system start-up. 
  21.  
  22. Using the program 
  23.  
  24. Select one of the following options to learn more about how to use the program. 
  25.  
  26. o Starting the program / command line options 
  27. o Exiting the program 
  28. o Switching between Today/Tomorrow 
  29. o Getting on-line help 
  30. o Scrolling through the list of names 
  31. o Starting the program displaying tomorrow 
  32. o Writing a calendar data file 
  33. o Limitations 
  34. o Credits 
  35.  
  36.  
  37. ΓòÉΓòÉΓòÉ 3. Starting the program / command line options ΓòÉΓòÉΓòÉ
  38.  
  39. Starting the program 
  40.  
  41. You can start the program from a command line or from a program object. In 
  42. order to get the on-line help, make sure that the file birthday.hlp is either 
  43. in the current directory or in any directory specified by the 'HELP' variable 
  44. in your 'config.sys' file. 
  45.  
  46. The program uses a calendar file to read the birthday information from. The 
  47. default calendar file used is birthday.dat. This file must be in the current 
  48. directory. To override this file you can specify one or more calendar files on 
  49. the command line. 
  50.  
  51. Command syntax 
  52.  
  53.           birthday [-t] [calendar_files...]
  54.  
  55.      -t        start the program displaying tomorrow's birthday's 
  56.  
  57.      calendar_files... one or more calendar files to read birthday information 
  58.                from. If no file is specified, the file birthday.dat from the 
  59.                current directory is read. 
  60.  
  61.  Examples 
  62.  
  63.           birthday
  64.           birthday -t
  65.           birthday f:\data\friends.dat
  66.  
  67.  See also 
  68.  
  69.  o About the birthday notifier 
  70.  o Writing a calendar data file 
  71.  
  72.  
  73. ΓòÉΓòÉΓòÉ 4. Exiting the program ΓòÉΓòÉΓòÉ
  74.  
  75. Exiting the program 
  76.  
  77. To exit the program click on the "Ok" button. 
  78.  
  79. See also 
  80.  
  81. o About the birthday notifier 
  82.  
  83.  
  84. ΓòÉΓòÉΓòÉ <hidden> Ok button ΓòÉΓòÉΓòÉ
  85.  
  86. Ok button 
  87.  
  88. Click on the "Ok" button to exit the program . 
  89.  
  90. See also 
  91.  
  92. o About the birthday notifier 
  93.  
  94.  
  95. ΓòÉΓòÉΓòÉ 5. Switching between Today/Tomorrow ΓòÉΓòÉΓòÉ
  96.  
  97. Switching between Today/Tomorrow 
  98.  
  99. To have the program display tomorrow's anniversaries when displaying today's 
  100. anniversaries click on the "Tomorrow" button. 
  101.  
  102. To change the program (back) to displaying today's anniversaries click on the 
  103. same button, which will say "Today" now. 
  104.  
  105. See also 
  106.  
  107. o About the birthday notifier 
  108.  
  109.  
  110. ΓòÉΓòÉΓòÉ <hidden> Today/tomorrow button ΓòÉΓòÉΓòÉ
  111.  
  112. Today/tomorrow button 
  113.  
  114. This button changes between displaying today's and tomorrow's birthday's. Click 
  115. on the 'Today' button to display today's anniversaries. Click on the 'Tomorrow' 
  116. button to display tomorrow's anniversaries. 
  117.  
  118. See also 
  119.  
  120. o About the birthday notifier 
  121.  
  122.  
  123. ΓòÉΓòÉΓòÉ 6. Getting product information ΓòÉΓòÉΓòÉ
  124.  
  125. Getting product information 
  126.  
  127. To get product information click on the "About" button. 
  128.  
  129. See also 
  130.  
  131. o About the birthday notifier 
  132.  
  133.  
  134. ΓòÉΓòÉΓòÉ <hidden> About button ΓòÉΓòÉΓòÉ
  135.  
  136. About button 
  137.  
  138. Click on the "About" button to get product information. 
  139.  
  140. See also 
  141.  
  142. o About the birthday notifier 
  143.  
  144.  
  145. ΓòÉΓòÉΓòÉ 7. Getting on-line help ΓòÉΓòÉΓòÉ
  146.  
  147. Getting on-line help 
  148.  
  149. To get general help about this program and its usage, click on the "Help" 
  150. button. 
  151.  
  152. To get help about a specific button, press the F1 key when the button is 
  153. highlighted. To highlight a button you can use the TAB key and the arrow keys. 
  154.  
  155. See also 
  156.  
  157. o About the birthday notifier 
  158.  
  159.  
  160. ΓòÉΓòÉΓòÉ <hidden> Help button ΓòÉΓòÉΓòÉ
  161.  
  162. Help button 
  163.  
  164. Click on the "Help" button to get general help about this program and its 
  165. usage. 
  166.  
  167. To get help about a specific button, press the F1 key when the button is 
  168. highlighted. To highlight a button you can use the TAB key and the arrow keys. 
  169.  
  170. See also 
  171.  
  172. o About the birthday notifier 
  173.  
  174.  
  175. ΓòÉΓòÉΓòÉ 8. Scrolling names ΓòÉΓòÉΓòÉ
  176.  
  177. Scrolling names 
  178.  
  179. When there are more anniversaries on a day than will fit in the window, i.e. 5, 
  180. scroll buttons appear to enable you to scroll through the names. 
  181.  
  182. To scroll down the list of names, click on the button with the downwards 
  183. directed arrow. 
  184.  
  185. To scroll up the list again, click on the button with the upwards directed 
  186. arrow. 
  187.  
  188. The names will be listed in the same order as encountered in the calendar data 
  189. file(s). 
  190.  
  191. See also 
  192.  
  193. o About the birthday notifier 
  194.  
  195.  
  196. ΓòÉΓòÉΓòÉ <hidden> Scroll up button ΓòÉΓòÉΓòÉ
  197.  
  198. Scroll up button 
  199.  
  200. Click on the scroll up button to scroll up the list of anniversaries. The 
  201. scroll buttons only appear when there are more anniversaries to display than 
  202. will fit in the window, i.e. 5. 
  203.  
  204. See also 
  205.  
  206. o About the birthday notifier 
  207.  
  208.  
  209. ΓòÉΓòÉΓòÉ <hidden> Scroll down button ΓòÉΓòÉΓòÉ
  210.  
  211. Scroll down button 
  212.  
  213. Click on the scroll down button to scroll down the list of anniversaries. The 
  214. scroll buttons only appear when there are more anniversaries to display than 
  215. will fit in the window, i.e. 5. 
  216.  
  217. See also 
  218.  
  219. o About the birthday notifier 
  220.  
  221.  
  222. ΓòÉΓòÉΓòÉ 9. Product information ΓòÉΓòÉΓòÉ
  223.  
  224. Product information 
  225.  
  226. The product information window shows the copyright notices and credits to the 
  227. programmer. 
  228.  
  229. To close the product information click on the "Ok" button. 
  230.  
  231. See also 
  232.  
  233. o About the birthday notifier 
  234.  
  235.  
  236. ΓòÉΓòÉΓòÉ 10. Starting the program displaying tomorrow ΓòÉΓòÉΓòÉ
  237.  
  238. Starting the program displaying tomorrow 
  239.  
  240. Normally when the program is started it begins displaying today's 
  241. anniversaries. To let the program start with displaying tomorrow's 
  242. anniversaries you must start the program with the command line option "-t" as 
  243. follows. 
  244.  
  245.           birthday -t
  246.  
  247.  See also 
  248.  
  249.  o About the birthday notifier 
  250.  
  251.  
  252. ΓòÉΓòÉΓòÉ 11. Writing a calendar data file ΓòÉΓòÉΓòÉ
  253.  
  254. Writing a calendar data file 
  255.  
  256. The anniversaries that are displayed by the program are taken from a calendar 
  257. data file. By default they are taken from the file birthday.dat. Calendar files 
  258. are plain ASCII files. To add, change or remove names from a calendar file you 
  259. must edit it using a normal text editor (e.g. e.exe). 
  260.  
  261. To add a new birthday to the calendar file you must place the information on a 
  262. single line in the file. First type the day number then the month number and 
  263. then the persons name (or any text you want). E.g. 
  264.  
  265.           6 12 Sint Nicolaas
  266.  
  267.   declares the birthday of Sint Nicolaas at the sixth of December (this was 
  268.  actually the day he died). 
  269.  
  270.  Each birthday must be placed on a single line. It is not necessary to sort the 
  271.  birthday's by date. If there are more birthday's on a particular day the names 
  272.  will be listed in the same order as encountered in the calendar data file(s). 
  273.  
  274.  Note:  Names must be limited to 255 characters.[enote] 
  275.  
  276.  See also 
  277.  
  278.  o About the birthday notifier 
  279.  
  280.  
  281. ΓòÉΓòÉΓòÉ 12. Limitations ΓòÉΓòÉΓòÉ
  282.  
  283. Limitations 
  284.  
  285. The program has some limitations (read the programmer was to lazy to fix them). 
  286.  
  287.  Finding the data file 
  288.     The program is not smart in finding the default calendar data file. It must 
  289.     be in the current working directory when starting the  program. Otherwise 
  290.     the file must be specified as program argument. No errors are reported if 
  291.     any calendar data file can not be found or opened or is not in the 
  292.     appropriate format. 
  293.  
  294.  Limited name length 
  295.     Names in calendar files must be limited to 255 characters. Note however 
  296.     that names of about 25 or 30 characters is the maximum that you will see 
  297.     printed on the screen. 
  298.  
  299.  Program start-up 
  300.     There is no option to stop the program from starting if there are no 
  301.     birthday's to report. 
  302.