Magnus' patch for $sending_ip_address and $sending_port.
[exim.git] / src / exim_monitor / EDITME
1 # $Cambridge: exim/src/exim_monitor/EDITME,v 1.1 2004/10/07 10:39:01 ph10 Exp $
2
3 ##################################################
4 #                The Exim Monitor                #
5 ##################################################
6
7 # This is the template for the Exim monitor's main build-time configuration
8 # file. It contains settings that are independent of any operating system. It
9 # should be edited and then saved to a file called Local/eximon.conf before
10 # running the make command to build the monitor, if any settings are required.
11 # Local/eximon.conf can be empty if no changes are needed. The examples given
12 # here (commented out) are the default settings.
13
14 # Any settings made in the configuration file can be overridden at run time
15 # by setting up an environment variable with the same name as any of these
16 # options, but preceded by EXIMON_, for example, EXIMON_WINDOW_TITLE.
17
18
19 ##################################################################
20 #      Set these variables as appropriate for your system        #
21 ##################################################################
22
23 # The qualifying name for your domain. The only use made of this is for
24 # testing that certain addresses are the same when displaying the
25 # log tail, and for shortening sender addresses in the queue display.
26
27 # QUALIFY_DOMAIN=
28
29 # The default minimum width and height for the whole window are 103 and
30 # 162 pixels respectively. This is enough to hold the left-most stripchart
31 # and the quit button. The values can be changed here.
32
33 # MIN_HEIGHT=162
34 # MIN_WIDTH=103
35
36 # If you uncomment the following setting, the window will start up at
37 # its minimum size, instead of the default maximum. There may be a quick
38 # flash during the start-up process. Defining it this way allows it to be
39 # overridden by an environment variable.
40
41 # START_SMALL=${EXIMON_START_SMALL-yes}
42
43 # The title for eximon's main display window. It is possible to have
44 # host name of the machine you are running on substituted into the
45 # title string. If you include the string ${fullhostname} then the
46 # complete name is used. If you include ${hostname} then the full
47 # host name will have the string contained in the DOMAIN variable
48 # stripped from its right-hand end before being substituted. Any other
49 # shell or environment variables may also be included.
50
51 # If you use any substitutions, remember to ensure that the $ and {}
52 # characters are escaped from the shell, e.g. by using single quotes.
53
54 # WINDOW_TITLE="${hostname} eximon"
55
56 # The domain that you want to be stripped from the machine's full hostname
57 # when forming the short host name for the eximon window title, as
58 # described above.
59
60 # DOMAIN=
61
62 # Parameters for the rolling display of the tail of the exim log file.
63 # The width and depth are measured in pixels; LOG_BUFFER specifies the
64 # amount of store to set aside for holding the log tail, which is displayed
65 # in a scrolling window. When this store is full, the earlier 50% of it
66 # is discarded - this is much more efficient that throwing it away line
67 # by line. The number given can be followed by the letter K to indicate
68 # that the value is in kilobytes. A minimum value of 1K is enforced.
69
70 # LOG_DEPTH=300
71 # LOG_WIDTH=950
72 # LOG_BUFFER=20K
73
74 # The font which is used in the log tail display. This is defined in
75 # the normal X manner. It must be a "character cell" font, because this
76 # is required by the text widget.
77
78 # LOG_FONT=-misc-fixed-medium-r-normal-*-14-140-*-*-*-*-iso8859-1
79
80 # Parameters for the display of message that are on the exim queue.
81 # The width and depth are measured in pixels.
82
83 # QUEUE_DEPTH=200
84 # QUEUE_WIDTH=950
85
86 # The font which is used in the queue display.
87
88 # QUEUE_FONT=$LOG_FONT
89
90 # When a message has more than one undelivered address, they are listed
91 # one below the other. A limit can be placed on the number of addresses
92 # displayed for any one message. If there are more, then "..." is used
93 # to indicate this.
94
95 # QUEUE_MAX_ADDRESSES=10
96
97 # The display of the contents of the queue is updated every QUEUE_INTERVAL
98 # seconds by default (there is a button to request update).
99
100 # QUEUE_INTERVAL=300
101
102 # The size of the popup text window that is used for looking at the
103 # contents of messages, etc.
104
105 # TEXT_DEPTH=200
106
107 # The keystroke/mouse-operation that is used to pop up the menu in the
108 # queue window is configurable. The default is Shift with the lefthand
109 # mouse button. The name of an alternative can be specified in the standard
110 # X way of naming these things. With the default configuration for the monitor,
111 # individuals can override this by setting the EXIMON_MENU_EVENT environment
112 # variable.
113
114 # MENU_EVENT='Shift<Btn1Down>'
115
116 # When the menu is used to perform an operation on a message, the result of the
117 # operation is normally visible in the log window, so Eximon doesn't display
118 # the output of the generated Exim command. However, you can request that
119 # this output be shown in a separate window by setting ACTION_OUTPUT to "yes".
120 # This does not apply to the output generated from attempting to deliver a
121 # message, which is always shown.
122
123 # ACTION_OUTPUT=no
124
125 # When some action is taken on a message, such as freezing it, or changing
126 # its recipients, the queue display is normally automatically updated. On
127 # systems that have very large queues, this can take some time and be dis-
128 # tracting. If this option is set to "no", the queue display is no longer
129 # automatically updated after an action is applied to a message.
130
131 # ACTION_QUEUE_UPDATE=yes
132
133 # When the menu item to display a message's body is invoked, the amount
134 # of data is limited to BODY_MAX bytes. This limit is a safety precaution
135 # to save the screen scrolling for ever on an enormous message.
136
137 # BODY_MAX=20000
138
139 # The stripcharts are updated every STRIPCHART_INTERVAL seconds.
140
141 # STRIPCHART_INTERVAL=60
142
143 # A stripchart showing the count of messages in the queue is always
144 # displayed on the left of eximon's window. Its name is "queue" by
145 # default, but can be changed by this variable.
146
147 # QUEUE_STRIPCHART_NAME=queue
148
149 # The following variable may be set to the name of a disc partition. If
150 # it is, a stripchart showing the percentage fullness of the partition
151 # will be displayed as the second stripchart. This can be used to keep
152 # a display of a mail spool partition on the screen.
153
154 # SIZE_STRIPCHART=/var/mail
155
156 # The name of the size stripchart will be the last component of SIZE_STRIPCHART
157 # unless the following variable is set to override it.
158
159 # SIZE_STRIPCHART_NAME=space
160
161 # The following variable contains a specification of which stripcharts
162 # you want eximon to display based on log entries. The string consists of
163 # pairs of strings, delimited by slash characters. The first string in each
164 # pair is a regular expression that matches some distinguishing feature in a
165 # exim log entry.
166
167 # Entries that match the expression will be counted and displayed in a
168 # stripchart whose title is given by the second string. The string may
169 # be continued over several input lines, provided that it is split
170 # after a slash, and an additional slash (optionally preceded by white
171 # space) is included at the start of the continuation line.
172
173 # Stripcharts configured by the following parameter are displayed to the
174 # right of the queue and size stripcharts, in the order defined here.
175
176 # LOG_STRIPCHARTS='/ <= /in/
177 #                  / => /out/
178 #                  / => .+ R=local/local/
179 #                  / => .+ T=[^ ]*smtp/smtp/'
180
181 # End of exim_monitor/EDITME