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