debian: fix build-deps for focal
[amule.git] / src / utils / amps / SETTINGS
blob51379077f82c871dd55004ec41fed3c6a090a482
1 AMPS settings: documentation for the constants defined in AMPS
3 General
4 -------
6 VERSION         :       Version number of AMPS
7 AMULESIGDAT     :       Path of the aMule signature file. This must correspond
8                         with the path specified in the Tweaks settings tab in
9                         aMule. You must be sure that the user that PHP scripts
10                         run as (apache in many default installations) has
11                         sufficient privileges to read this file. If the file is
12                         outside the webserver's DocumentRoot, the safe_mode
13                         option in your php.ini MUST be set to Off. Default is
14                         /tmp/amulesig.dat
15 IMAGEPATH       :       Path (absolute or relative) where all the images AMPS
16                         uses are looked for. Default is ./images
17 IMAGETYPE       :       Type of image to output for error images and the
18                         signature image. Valid types are jpg, gif, and png. Note
19                         that your installation of GD must support the image type
20                         specified here. Default is png
23 Icon settings
24 NOTE: All icons are assumed to be PNG. This will probably not change.
25 -------------
27 CLEANSIGIMG     :       Image used as the base image for the signature. Default
28                         is baseimg.png
29 RUNNINGIMG      :       Icon placed beside the process status information in the
30                         signature. Default is running.png
31 RX0TX0IMG       :       Transmission status icon used when both RX and TX
32                         traffic are zero. Default is rx0tx0.png
33 RX0TX1IMG       :       Transmission status icon used when RX traffic is zero
34                         and TX traffic is nonzero. Default is rx0tx1.png
35 RX1TX0IMG       :       Transmission status icon used when RX traffic is nonzero
36                         and TX traffic is zero. Default is rx1tx0.png
37 RX1TX1IMG       :       Transmission status icon used when both RX and TX
38                         traffic are nonzero. Default is rx1tx1.png
39 HIGHIDIMG       :       Connection status image used when user is connected with
40                         high ID. Default is conn_highid.png
41 LOWIDIMG        :       Connection status image used when user is connected with
42                         low ID. Default is conn_lowid.png
43 NOCONNIMG       :       Connection status image used when user is not connected
44                         to a server. Default is noconn.png
45 TIMEGENIMG      :       Icon placed next to timestamp. Default is clock.png
46 SERVERIMG       :       Icon placed next to the server info. Default is
47                         serverbox.png
48 SHAREDFILESIMG  :       Icon placed next to the number of shared files. Default
49                         is files.png
50 QUEUEIMG        :       Icon placed to the queue status information.
52 Font information:
53 NOTE: AMPS uses TrueType fonts. This may be changed to support PS type 1 or
54 other font types if there is sufficient demand for it.
55 -----------------
57 ERRFONTPADDING  :       Number of pixels to pad around the text in error message
58                         images (hopefully you'll never see these images).
59                         Default is 5
60 FONTSIZE        :       Font size (in points) to use on the signature image. You
61                         will need to adjust this if you use a font other than
62                         the default one provided with AMPS. Default is 10
63 FONTFILE        :       Path and filename of the font to use for the error and
64                         signature image. Right now this must be a valid TrueType
65                         font that can be read by the user that the PHP script is
66                         run as. Make sure this is a *good* font that supports
67                         most of the European special characters used in the
68                         various translations. If you modify this from the
69                         default, make sure to adjust FONTSIZE accordingly.
70                         Default is ./LucidaSansRegular.ttf
71 IMAGETEXTCOLOR  :       Hex triplet that defines what color text to use in the
72                         signature image. Default is ffffff (white)