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