You can also look at the Example Page to see how the different options will look like.
| Parameter | Name | Description | Default |
|---|---|---|---|
| cache=B expires=X |
These parameters can be used to change the image caching behavior of certain web browsers. | The Boolean value of cache hints
the browser whether to cache the image or not. The integer value of expires
specifies the cache expiration duration time in seconds. If you specify cache=F, the
browser will be hinted to cache the image for the amount of seconds specified with expires
parameter. if cache=F and expires=0, then the browser should not cache the image, that is
whenever you come back to the page, the counter or clock will be refreshed. Use this
feature with discretion as it may increase load on your system. The expires
parameter is meaningless without cache=F, that means, if cache=T is specified,
expires parameter is ignored and the counter will not generate any HTTP Expires header.
This is the default behavior. The valid values for the Boolean parameter cache is Y,N,F,T
1 or 0. The valid integer range of the expires parameter is between 0 and 604800 (7 days).
Note, these parameters will work with browser supports the HTTP Expires header as specified in HTTP specification. By default, most web browsers caches the image got from the counter. That means, if someone visits your page and comes back after a while, the counter or clock does not get refreshed. |
cache=T expires=0 |
| display=X | Specifies what to display. | A valid string can be specified with display= parameter to display counter, clock or date. The valid value for the string parameter X is counter, clock or date For counter, this parameter is not need as counter is the default display type. | display=counter |
| timezone=X | Display time/date of the specified timezone. | The parameter timezone= is only significant with
display=clock or display=date. Use this parameter if you want to display time or date of
another timezone. The timezone must be specified with a negative or positive four digit
offset from GMT, for example: timezone=GMT-0500 or timezone=GMT+0000 or timezone=GMT+0530.
The routine to display time of various time zones are written in a generic way. Therefore,
the Unix machines will not be aware of daylight saving time because of the way the routine
is written. For example, if daylight saving time is on, to display time of NY, the
timezone will be timezone=GMT-0500 instead of timezone=GMT-0400. If the clock displays your local time wrong, specify your timezone with that parameter in order to display the correct time. |
None. |
| tformat=X | Time format in 12 or 24 hour. | This parameter can be used to display time in 12 or 24 hour format. The valid values for the parameter X is 12 or 24. | tformat=12 |
| dformat=X | Specifies date format. | This parameter is only significant with display=date. The valid value for the string parameter X is any combination of MMDDYY (Month-Day-Year). For example, dformat=ddmmyy, dformat=YYMMDD. | dformat=MMDDYY |
| istrip=B | Use of image strip On/Off | The Boolean value of istrip specifies whether to use image strip or not. If you specify istrip=F, the program will look for the individual digit image files in the digits/style directory. The valid values for the Boolean parameter istrip are Y, N, T, F, 1 or 0. | istrip=T |
| ft=X | Frame Thickness | You can wrap the counter in an ornamental frame of X pixels thick. Use 0 for no frame. Values over 5 make a nice 3-D effect. | ft=4 |
| frgb=R;G;B or frgb=RRGGBB (in hex) |
Frame Color | Specifies the color of the frame in RGB
(red/green/blue) format. Each color component, R, G, and B is specified as a value between
0 and 255. If you use ft= without a frgb= param, the default color is used. If you specify a frgb= without a ft=, then the frame thickness defaults to 5. All the examples show ft=5. The color can be specified as hex string or a name. Do not use a # before the hex string as Netscape. For example, if you want to specify white in hex, use frgb=ffffff. You also can use a color name (e.g. frgb=blue) if the counter configured to do so (look at the cfg file). Look at the color name mapping database for some hints about color name database. |
frgb=100;139;216 or frgb=648bd8 |
| tr=B | Transparency On/Off | You can specify if your counter image will have a transparent color with the Boolean B. So tr=Y means there will be a transparent color. It does not matter if the GIF files used for the digits are "transparent"; you must specify explicitly which color to make transparent. If you specify a trgb=, then you do not need to specify tr=Y. If you specify tr=Y and do not specify trgb=, then the default color black will be transparent. The valid values for B are Y, N, T, F, 1, or 0. | tr=F No Transparency |
| md=X | Max Digits | Defines maximum number of digits to display. Any value between 5 and 10 inclusive are permitted. Padding with leading zeros is automatically done for you; longer counts are truncated to the given X. | md=6 Without padding |
| pad=B | Left padding with 0s | Turn padding on/off in conjunction with md= setting. Valid values for the Boolean parameter B are Y, N, T, F, 1, or 0. | pad=N Without specification of a md=value pad=Y |
| dd=A | Digit Directory | Denotes directory of a specific styles of digits. Four styles of digits are supplied. They are kept at the directories A,B,C and D respectively. Visit the Esosoft styles pages for other styles of digits. | dd=A My green LED digits |
| image=gif_file | Display this GIF file | You can display any GIF image specified with this parameter. The location of this file is determined by the dd= parameter, that no path in the GIF file is allowed. All attributes of the counter apply to the image. Not, if you specify a datafile with df parameter and if incr is true, then counter will be incremented in the datafile. | None |
| comma=B | Display comma after every 3rd digit from right. | The Boolean value of parameter comma specifies whether to display comma after every 3rd digit from right. If you use this parameter as true, the left padding with zeros will be turned off. | comma=F |
| srgb=R;G;B or srgb=RRGGBB (in hex) prgb=R;G;B or prgb=RRGGBB (in hex) |
Change a color of the image to a target color on the fly. | Any one color of the image can be changed to a different color on the fly. srgb stands for source color, that is the color to change. prgb stands for pen color, that is the target color. The values for srgb and prgb can be colon separated color components (e.g, srgb=255;0;0), a hex value (e.g. srgb=ff0000) or a color name (e.g. srgb=red). The color name can be used if you configured the counter to do so (look at the cfg file). | srgb=00ff00 (0;255;0 green) prgb=00ffff With chcolor=T |
| chcolor=B | Change a color of the image. | This parameter is usually used to change the default green color to cyan. That is if you specify chcolor=T, and you want to change green to cyan, then you do not need to specify srgb and prgb parameters. 1x1 GIF is displayed. The valid values for the Boolean parameter B are Y, N, T, F, 1, or 0 | chcolor=F |
| st=X | Start Count | This parameter is used to set the initial value of the counter to some number X. This is only valid if you decided to allow automatic datafile creation. It is a bad practice to allow automatic datafile creation, however it makes site maintaining easier. The automatic datafile creation option is specified in configuration file and can be changed at run time. Note that this parameter has no effect if the datafile already exists. If you want to change the counter value in a existing datafile, hand edit the file. The minimum value for st is 1. | st=1 Count starts at 1 |
| sh=B | Show digits | Used to turn display of digits on or off according to
the Boolean B. When sh=T, counter will be displayed and incremented, this is the default
behavior. If sh=F no digits will show, but the counter will still increment; instead of digits a transparent 1x1 GIF is displayed. The valid values for the Boolean parameter B are Y, N, T, F, 1, or 0 |
sh=Y |
| df=data_file | Datafile to store count | Specifies the name of the file for storing the count
in. The file must be allocated to you as was mentioned in the "Authorizations"
section above. You can use df=random to display a random number. One special use of the parameter is df=RANDOM. This returns a random number using the fractional portion of the host's time of day clock as a seed for the generator. Unlike all other WWWcounter parameters, the file name provided is case-sensitive, except for the value random. Or Random, or rANDOM, etc. |
df=random if no datafile is specified |
| incr=B | Increment Count | Makes it possible to display the current count without incrementing the count. This can be used to examine the count for reporting or other purposes without adding to the count. Valid values for the Boolean parameter B are Y, N, T, F, 1, or 0. | incr=T Increment the counter |
| lit=X | Display literal | Makes it possible to display a given, predetermined string. The valid values for the string X are digits, a,p,: and - | None |
| negate=B | Negate the color | Makes it possible to negate the color of the counter digits. Note that the Frame is exempted from negating. Valid values for the Boolean parameter B are Y, N, T, F, 1, or 0. | negate=F Do not negate |
| degrees=X | Rotate X degrees | Makes it possible to rotate the counter image X degree. The possible values of X is 90, 180, 270 and 360. Note 360 is meaningless as the counter will come back to the original 0 degree. | degrees=270 With rotate=Y and without degrees=X rotate 270 degrees clockwise |
| rotate=B | Rotate On/Off | The Boolean value B turns on or off rotating. If you use degrees= setting, rotate is not needed. Valid values for the Boolean parameter B are Y, N, T, F, 1, or 0. | rotate=F Do not rotate |
Last Updated: 13 May 2001
Copyright © by Esosoft Corporation 1996-2001
All Rights Reserved.
http://www.esosoft.net