home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bbs / amigalib / d983 / titleclock.lha / TitleClock / TitleClock.doc < prev    next >
Encoding:
Text File  |  1994-04-05  |  7.7 KB  |  213 lines
  1.                                TitleClock V3
  2.                            by Anders Hammarquist
  3.  
  4. This is FREEWARE, You may copy this program freely as long as you don't
  5. make a profit by doing so. A nominal copying charge is premissible. Fred
  6. Fish has explicit permission to include it in his collection, as do
  7. Pascal Rullier have explicit permission to include it in the BUGSS PD
  8. collection.
  9.  
  10. TitleClock is a little commodity (about 4k) that throws up a clock in the
  11. top right corner of a screens titlebar. It may be set up to display itself
  12. on one or more screens, it may be set to follow you default public screen
  13. and also to always display on the frontmost screen.
  14.  
  15. There have been quite a few changes since the first release. It will now
  16. display clocks on multiple screens, and also on non-public screens. This
  17. has resulted in new options, and some changes in the way that the program
  18. operates. Beware also that the stack requirement has increased (due to the
  19. use of dos.library's pattern matching functions). Since version 2,
  20. support for locale.library's FormatDate() has been added. Some of the
  21. code has been cleaned up, and, by popular demand, you get to see the code.
  22. Part of the problem with proportional fonts present in version 2 has
  23. also been fixed. You should no longer get remnants of the first
  24. character to the left of the string, but the text may still jerk back
  25. and forth as the text changes. Unfortunately, this problem is not easy
  26. to fix, as it would require remembering where on each screen the clock
  27. should be printed. As it is now, the clock does not even remember
  28. which screens it is displayed on from one second to the next.
  29.  
  30. TitleClock accepts the following arguments, entered on the command line
  31. from the CLI and in the ToolType field of the icon if run from the
  32. Workbench.
  33.  
  34. UPDATE=
  35.  
  36.     Number of seconds between clock updates. It's not recommended that you
  37.     make this value 0. Although you can, it will load the CPU enormously,
  38.     as TitleClock won't be waiting. Also, you probably don't want to make
  39.     the value too large, as the clock gets erased every time Intuition
  40.     changes the screen title. Though if you have a program that doesn't
  41.     change the screen's title, it would be no problem to put up a
  42.     TitleClock on it with UPDATE set to 60 seconds. Default is 1 second.
  43.     Please note that it believes wierd values, if you set update to -1, it
  44.     will update every 4 294 967 295 seconds
  45.  
  46. SHOWDATE
  47.  
  48.     If present, TitleClock will show todays date in addition to the current
  49.     time.
  50.  
  51. SHOWDAY
  52.  
  53.     If present, TitleClock will show the day in addition to the current
  54.     time.
  55.  
  56. SHORTDAY
  57.  
  58.     If present, the day name will be truncated to the three first
  59.     characters.
  60.  
  61. SHOWSECS
  62.  
  63.     If present, TitleClock will display seconds as well as hours and
  64.     minutes.
  65.  
  66. FORMAT=
  67.  
  68.     Sets the format of the date display. It can be one of the following:
  69.  
  70.     DOS             - displays as dd-mmm-yy
  71.     International   - displays as yy-mmm-dd
  72.     American        - displays as mm-dd-yy
  73.     Canadian        - displays as dd-mm-yy
  74.  
  75.     Default is DOS.
  76.  
  77. DATEFORMAT=
  78.  
  79.     Specify a format string for the date/time to be displayed in the
  80.     screen title. This option requires that you have locale.library
  81.     installed (available with Workbench version 2.1 and later). If you do
  82.     not, this option will simply be ignored. Beware that this option
  83.     overrides any other formatting options you have specified if you do
  84.     have locale.library. You can specify any text you want in the string,
  85.     and insert the current time and day in your default language by using
  86.     the following % sequences:
  87.  
  88.             %a - abbreviated weekday name
  89.         %A - weekday name
  90.         %b - abbreviated month name
  91.         %B - month name
  92.         %c - same as "%a %b %d %H:%M:%S %Y"
  93.         %C - same as "%a %b %e %T %Z %Y"
  94.         %d - day number with leading 0s
  95.         %D - same as "%m/%d/%y"
  96.         %e - day number with leading spaces
  97.         %h - abbreviated month name
  98.         %H - hour using 24-hour style with leading 0s
  99.         %I - hour using 12-hour style with leading 0s
  100.         %j - julian date
  101.         %m - month number with leading 0s
  102.         %M - the number of minutes with leading 0s
  103.         %p - AM or PM strings
  104.         %q - hour using 24-hour style
  105.         %Q - hour using 12-hour style
  106.         %r - same as "%I:%M:%S %p"
  107.         %R - same as "%H:%M"
  108.         %S - number of seconds with leadings 0s
  109.         %T - same as "%H:%M:%S"
  110.         %U - week number, taking Sunday as first day of week
  111.         %w - weekday number
  112.         %W - week number, taking Monday as first day of week
  113.         %x - same as "%m/%d/%y"
  114.         %X - same as "%H:%M:%S"
  115.         %y - year using two digits with leading 0s
  116.         %Y - year using four digits with leading 0s
  117.  
  118.     In future versions of the operating system, Commodore may add more
  119.     formatting strings. In particular, %Z may one day be implemented. As
  120.     it is now, %Z does not exists, but %C tries to use it, which has
  121.     rather interesting effects, making the %C formatting string rather
  122.     useless until that time. If you wish to include a single %-sign in
  123.     the display, enter %% into the format string. A few examples:
  124.  
  125.         DATEFORMAT=Current time: %T
  126.  
  127.     Yields something like:
  128.  
  129.         Current time: 15:06:12
  130.  
  131.         DATEFORMAT=%Hh%M, of %e %B
  132.  
  133.     Yields something like:
  134.  
  135.         15h06, of  4 January
  136.  
  137.  
  138. PUBSCREEN=
  139.  
  140.     Tells TitleClock which public screen to appear on. This may be a
  141.     standard AmigaDOS pattern, in which case the clock will appear on all
  142.     public screens whose name matches this pattern. The match is case
  143.     sensitive. Please note that specifying a pattern if you have a lot of
  144.     public screens will affect system performance.
  145.  
  146. SCREENPAT=
  147.  
  148.     This tells TitleClock which NON-public screens to appear on. It is a
  149.     standard AmigaDOS pattern, compared to the default title of all system
  150.     screens. The match is case sensitive. Note that the default title of
  151.     a screen may not be the same as that which is displayed. For example,
  152.     the default title for the Workbench screen is 'Workbench Screen'. Also
  153.     note that specifying this option when you have a lot of screens will
  154.     affect system performance.
  155.  
  156. FRONTSCREEN
  157.  
  158.     If this option is specified, TitleClock will display a clock on the
  159.     frontmost screen.
  160.  
  161. DEFSCREEN
  162.  
  163.     If this option is specified, TitleClock will display a clock on the
  164.     default public screen.
  165.  
  166. CX_PRIORITY=
  167.  
  168.     Sets the priority of TitleClock's commodity broker. Default is 0.
  169.  
  170. TOOLPRI=
  171.  
  172.     Sets the priority of TitleClock's task. Default is 0.
  173.  
  174. If you do not specify any of the PUBSCREEN, SCREENPAT, FRONTSCREEN, or
  175. DEFSCREEN options you will not get a clock. Also, the clock will not be
  176. displayed on any screen whose title is hidden, such as on a lot of terminal
  177. programs. Beware that Commodore's screenblanker included with 3.0 does NOT
  178. hide the title, so you will get a clock on it if you specify FRONTSCREEN
  179. (you can't match it's title, since it's NULL. This was discovered the
  180. hard way, via Enforcer).
  181.  
  182. If you put TitleClock in your WBStartup drawer, Workbench likes to see
  183. a DONOTWAIT ToolType.
  184.  
  185. That should be it.
  186.  
  187. Thanks go to:
  188.  
  189.     Gaël Marziou - for good ideas, and help with locale.library.
  190.     Pascal Rullier - for the French manual translation.
  191.     All the users who wrote me - for good ideas, and makeing me feel
  192.         happy having done something useful. Sorry if your idea hasn't
  193.         been implemented yet.
  194.     Everyone who makes the Amiga what it is.
  195.  
  196. Questions, comments, bug reports, et.c. to:
  197.  
  198. Internet:
  199.     f92anha@dd.chalmers.se
  200.     -or-
  201.     Anders_Hammarquist@p16.f123.n203.z2.fidonet.cd.chalmers.se
  202.  
  203. FidoNet:
  204.     Anders Hammarquist of 2:203/123.16
  205.  
  206. Spare harddrives, memory, those Ethernet cards you aren't using, anything
  207. else you feel like donating (and any paper mail) to:
  208.  
  209.     Anders Hammarquist
  210.     Schottisvägen 17
  211.     S-424 38  Angered
  212.         Sweden
  213.