Public/elog
1
0
Fork 0
mirror of https://gitea.psi.ch/ELOG/elog.git synced 2026-09-08 17:13:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Changed options syntax to 'option1|option2|...' config.html

Browse Source 
SVN revision: 184
This commit is contained in:
Stefan Ritt 2002-07-26 09:44:22 +00:00
parent d631f21394
commit 41131a4162
1 changed files with 43 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
doc/config.html
View File

@ -73,11 +73,19 @@ Use Mail Subject = Location
<a name="global"><hr> <a name="global"><hr>
<div class=title>&nbsp; Global options &nbsp;</div> <div class=title>&nbsp; Global options &nbsp;</div>
<p> <p>
The notation of the following options is such that items enclosed by <b>"&lt;"</b> and <b>"&gt;"</b>
should be replaced by a specific string. If a value contains blanks (like a complete sentence), it
should <b>not</b> be enclosed in quotation marks.<p>
If a setting has a number of possible options, they are shown in the form
<code><b>option1|option2|...</b></code>, meaning that one of the options (without any vertical bar)
should be used.
The following options are specific to the <b><code>[global]</code></b> section: The following options are specific to the <b><code>[global]</code></b> section:
<p> <p>
<UL> <UL>
<LI><b><code>Port</code></b> <LI><b><code>Port = &lt;port&gt;</code></b>
<br> <br>
Specifies the TCP port under which the server is listening. Default is 80. Can be superseeded Specifies the TCP port under which the server is listening. Default is 80. Can be superseeded
via the '-p' command line flag. via the '-p' command line flag.
@ -98,7 +106,7 @@ The online help for <code><b>elogd</b></code> is contained in the file <b>eloghe
<i>xx</i> are the first two letters of the language (like "<I>en</I>", "<I>ge</I>" and "<I>fr</I>"). For new languages, a new file of that type must be created as well. <i>xx</i> are the first two letters of the language (like "<I>en</I>", "<I>ge</I>" and "<I>fr</I>"). For new languages, a new file of that type must be created as well.
<p> <p>
<LI><b><code>Logbook Tabs = 0/1</code></b> <LI><b><code>Logbook Tabs = [0|1]</code></b>
<br> <br>
This flag controls the display of "<I>tabs</I>" on top of the logbook page which This flag controls the display of "<I>tabs</I>" on top of the logbook page which
allow to quickly switch between logbooks. allow to quickly switch between logbooks.
@ -111,7 +119,7 @@ to the main logbook selection page. The <b><code>string</b></code> is used for t
contents of the tab. contents of the tab.
<p> <p>
<LI><b><code>Welcome Title</code></b> <LI><b><code>Welcome Title = &lt;html code&gt;</code></b>
<br> <br>
This optional HTML code gets displayed in the title of the logbook selection This optional HTML code gets displayed in the title of the logbook selection
page. It can contain images via <b><code>&lt;img src="welcome.gif"&gt;</code></b>. page. It can contain images via <b><code>&lt;img src="welcome.gif"&gt;</code></b>.
@ -137,18 +145,18 @@ file. It can be completely customized in order to contain logos etc. As a templa
the standard selection page produced by <code><b>elogd</b></code> can be used. the standard selection page produced by <code><b>elogd</b></code> can be used.
<p> <p>
<LI><b><code>SMTP host</code></b> <LI><b><code>SMTP host = &lt;host.domain&gt;</code></b>
<br> <br>
This defines the SMTP host needed to send automatic email notifications. The host This defines the SMTP host needed to send automatic email notifications. The host
name you can get from your email program or your local system administrator. name you can get from your email program or your local system administrator.
<p> <p>
<LI><b><code>Logfile</code></b> <LI><b><code>Logfile = &lt;file&gt;</code></b>
<br> <br>
This option specifies a filename which logs all login/logout activities and This option specifies a filename which logs all login/logout activities and
successful user connections for logbooks with user level access.<p> successful user connections for logbooks with user level access.<p>
<LI><b><code>URL</code></b> <LI><b><code>URL = &lt;http://host.domain&gt;</code></b>
<br> <br>
This URL is used in automatic email notifications to point back to the new message. This URL is used in automatic email notifications to point back to the new message.
Usually, the elog daemon tries to obtain the URL from the "Referer" statement in the Usually, the elog daemon tries to obtain the URL from the "Referer" statement in the
@ -159,8 +167,8 @@ contain the port number if not the standard port 80 is used like<br>
<code>URL = http://host.domain:8080/</code> <code>URL = http://host.domain:8080/</code>
<p> <p>
<LI><b><code>User</code></b> <LI><b><code>User = &lt;name&gt;</code></b>
<LI><b><code>Group</code></b> <LI><b><code>Group = &lt;name&gt;</code></b>
<br> <br>
The user and group to run the elogd daemon under when started by root.<p> The user and group to run the elogd daemon under when started by root.<p>
@ -183,28 +191,28 @@ Here are the available options, by broad categories:<p>
<UL> <UL>
<LI><b><code>Data dir</code></b> <LI><b><code>Data dir = &lt;directory&gt;</code></b>
<br> <br>
Each logbook has a separate directory where the logbook entries are stored, which Each logbook has a separate directory where the logbook entries are stored, which
is controlled by this statement. Note that the directories must exist and must is controlled by this statement. Note that the directories must exist and must
be writable by the <code><b>elogd</b></code> program. be writable by the <code><b>elogd</b></code> program.
<p> <p>
<LI><b><code>Number Attachments</code></b> <LI><b><code>Number Attachments = &lt;number&gt;</code></b>
<br> <br>
The number of attachments which can be submitted in one entry. May be zero if no The number of attachments which can be submitted in one entry. May be zero if no
attachments are needed. Maximum is defined by MAX_ATTACHMENTS in elogd.c attachments are needed. Maximum is defined by MAX_ATTACHMENTS in elogd.c
(10 by default). (10 by default).
<p> <p>
<LI><b><code>Comment</code></b> <LI><b><code>Comment = &lt;comment&gt;</code></b>
<br> <br>
The comment is displayed on the logbook selection list. The selection list is The comment is displayed on the logbook selection list. The selection list is
displayed if more than one logbook is defined on a host and no logbook is displayed if more than one logbook is defined on a host and no logbook is
explicitly specified in the URL. explicitly specified in the URL.
<p> <p>
<LI><b><code>Theme</code></b> <LI><b><code>Theme = &lt;theme&gt;</code></b>
<br> <br>
A theme determines which layout and colors are used for a logbook, similar to A theme determines which layout and colors are used for a logbook, similar to
<i>skins</i> in other programs. The <i>theme</i> option points to a subdirectory <i>skins</i> in other programs. The <i>theme</i> option points to a subdirectory
@ -264,7 +272,7 @@ Here is an example:
The file must be present in the same directory as the <code><b>elogd</b></code> file. The file must be present in the same directory as the <code><b>elogd</b></code> file.
<p> <p>
<li><b><code>Message comment</code></b> <li><b><code>Message comment = &lt;comment&gt;</code></b>
</br> </br>
This optional comment is displayed on top of the text entry field when submitting This optional comment is displayed on top of the text entry field when submitting
a new message. It can contain a sentence like "<I>Please enter your message here</I>:". a new message. It can contain a sentence like "<I>Please enter your message here</I>:".
@ -325,7 +333,7 @@ Or it can contain other useful links. The file must be present in the same direc
as the <code><b>elogd</b></code> file. as the <code><b>elogd</b></code> file.
<p> <p>
<li><b><code>Help URL</code></b> <li><b><code>Help URL = &lt;URL&gt;</code></b>
<br> <br>
This URL is used for the Help button. By default, the file <b>eloghelp_xx.html</b> is This URL is used for the Help button. By default, the file <b>eloghelp_xx.html</b> is
returned with the contents of the help page. Edit this file directly to add site-specific help for all logbooks. Alternatively, use the <b><code>Help URL</code></b> option to specify different help pages for different logbooks. returned with the contents of the help page. Edit this file directly to add site-specific help for all logbooks. Alternatively, use the <b><code>Help URL</code></b> option to specify different help pages for different logbooks.
@ -333,18 +341,17 @@ It can point to a site-specific help page via <b><code>http://...</code></b> or
<b><code>file://c:/tmp/config.html</code></b>, or to the name of an HTML file which must be present in the same directory as the <code><b>elogd</b></code> file. <b><code>file://c:/tmp/config.html</code></b>, or to the name of an HTML file which must be present in the same directory as the <code><b>elogd</b></code> file.
<p> <p>
<li><b><code>Message Width</code></b> <li><b><code>Message Width = &lt;number&gt;</code></b>
<br> <br>
This value sets the number of characters per line of the main message entry field. This value sets the number of characters per line of the main message entry field.
The default value is 76 (78 for replies), and can be increased for installations The default value is 76 (78 for replies), and can be increased for installations
which need a larger window size (like pasting log files etc.). which need a larger window size (like pasting log files etc.).
<p> <p>
<li><b><code>Display mode</code></b> <li><b><code>Display mode = [full|summary|threaded]</code></b>
<br> <br>
Default mode for search display can be <b>"full"</b>, <b>"summary"</b> Default mode for search display. On the find entry form, the checkboxes
and <b>"threaded"</b>. On the find entry form, the checkboxes are set accordingly. The "Last xxx" page uses this setting directly.
are set accordingly. The "Last xxx" page used this setting directly.
<p> <p>
</UL> </UL>
@ -529,9 +536,9 @@ on in your browser</b>. Please consult your browser documentation about how to d
<p> <p>
<UL> <UL>
<LI><b><code>Read password</code></b> <LI><b><code>Read password = &lt;encoded password&gt;</code></b>
<LI><b><code>Write password</code></b> <LI><b><code>Write password = &lt;encoded password&gt;</code></b>
<LI><b><code>Admin password</code></b> <LI><b><code>Admin password = &lt;encoded password&gt;</code></b>
<LI><b><code>Write password expiration = &lt;hours&gt;</code></b> <LI><b><code>Write password expiration = &lt;hours&gt;</code></b>
<LI><b><code>Admin password expiration = &lt;hours&gt;</code></b> <LI><b><code>Admin password expiration = &lt;hours&gt;</code></b>
</ul> </ul>
@ -661,14 +668,14 @@ attribute. For a full list of possible substitutions, see the
<div class=section>&nbsp; Flags &nbsp;</div> <div class=section>&nbsp; Flags &nbsp;</div>
<ul> <ul>
<li><b><code>Show text = 0/1</code></b> <li><b><code>Show text = 0|1</code></b>
</br> </br>
This flag controls if logbook entries contain a body text. If an installation This flag controls if logbook entries contain a body text. If an installation
only requires attributes, this flag can be set to <b>0</b>. Default is only requires attributes, this flag can be set to <b>0</b>. Default is
<b>1</b>. <b>1</b>.
<p> <p>
<li><b><code>Show attachments = 0/1</code></b> <li><b><code>Show attachments = 0|1</code></b>
</br> </br>
This flag controls the display of attachments such as images on normal This flag controls the display of attachments such as images on normal
logbook pages. For logbooks with large images, this flag can be turned off, logbook pages. For logbooks with large images, this flag can be turned off,
@ -682,33 +689,33 @@ This specifies the number of text lines displayed in a summary page. Zero displa
no text at all. The default is 3. no text at all. The default is 3.
<p> <p>
<li><b><code>Reverse sort = 0/1</code></b> <li><b><code>Reverse sort = 0|1</code></b>
</br> </br>
If this flag is <b>1</b>, the result of the <i>"Last day"</i> and <i>"Last 10"</i> queries If this flag is <b>1</b>, the result of the <i>"Last day"</i> and <i>"Last 10"</i> queries
is sorted in reverse order (newest entry down to oldest). Default is <b>0</b>.<p> is sorted in reverse order (newest entry down to oldest). Default is <b>0</b>.<p>
<li><b><code>Search all logbooks = 0/1</code></b> <li><b><code>Search all logbooks = 0|1</code></b>
</br> </br>
If this flag is <b>1</b>, the search form displays the button <i>"Search all If this flag is <b>1</b>, the search form displays the button <i>"Search all
logbooks"</i>. The default is <b>1</b>. It might be necessary to turn this option logbooks"</i>. The default is <b>1</b>. It might be necessary to turn this option
off for public logbooks if there are also protected logbooks. Otherwise the off for public logbooks if there are also protected logbooks. Otherwise the
search result would also display entries from the protected logbooks.<p> search result would also display entries from the protected logbooks.<p>
<li><b><code>Enable browsing = 0/1</code></b> <li><b><code>Enable browsing = 0|1</code></b>
</br> </br>
If this flag is <b>1</b>, browsing (hitting the next/previous button) is enabled. If this flag is <b>1</b>, browsing (hitting the next/previous button) is enabled.
For some rare occasions it might be necessary to disable browsing. Default is For some rare occasions it might be necessary to disable browsing. Default is
<b>1</b>. <b>1</b>.
<p> <p>
<li><b><code>Filtered browsing = 0/1</code></b> <li><b><code>Filtered browsing = 0|1</code></b>
</br> </br>
If this flag is <b>1</b>, browsing (hitting the next/previous button) can be If this flag is <b>1</b>, browsing (hitting the next/previous button) can be
filtered by individual attributes. If the checkbox next to an attribute is checked, filtered by individual attributes. If the checkbox next to an attribute is checked,
only messages with the same attribute value are displayed. Default is <b>1</b>. only messages with the same attribute value are displayed. Default is <b>1</b>.
<p> <p>
<li><b><code>HTML default = 0/1/2/3</code></b> <li><b><code>HTML default = 0|1|2|3</code></b>
</br> </br>
This specifies the default state of the "<I>Submit as HTML text</I>" button on the This specifies the default state of the "<I>Submit as HTML text</I>" button on the
new message entry from. For installations where entries are normally submitted new message entry from. For installations where entries are normally submitted
@ -717,7 +724,7 @@ as HTML, the default can be set to <b>1</b>. If this value is set to <b>2
ore HTML submissions are possible, respectively. The default is <b>0</b>. ore HTML submissions are possible, respectively. The default is <b>0</b>.
<p> <p>
<li><b><code>Suppress default = 0/1/2</code></b> <li><b><code>Suppress default = 0|1|2</code></b>
</br> </br>
This specifies the default state of the "<I>Suppress Email notification</I>" button on the This specifies the default state of the "<I>Suppress Email notification</I>" button on the
new message entry form. For installations where normally an email notification is new message entry form. For installations where normally an email notification is
@ -727,7 +734,7 @@ entered, users can then uncheck the suppress box. If this value is set to <b>2
always produced. The default is <b>0</b>. always produced. The default is <b>0</b>.
<p> <p>
<li><b><code>Resubmit default = 0/1/2</code></b> <li><b><code>Resubmit default = 0|1|2</code></b>
</br> </br>
This specifies the default state of the "<I>Resubmit as new entry</I>" button on the This specifies the default state of the "<I>Resubmit as new entry</I>" button on the
edit message entry from. If this button is checked, the current message is removed edit message entry from. If this button is checked, the current message is removed
@ -737,7 +744,7 @@ have been updated recently. If this value is set to <b>2</b>, the resubmit box
is not displayed at all. The default is <b>0</b>. is not displayed at all. The default is <b>0</b>.
<p> <p>
<li><b><code>Display Email recipients = 0/1</code></b> <li><b><code>Display Email recipients = 0|1</code></b>
</br> </br>
If this flag is <b>1</b>, the email recipients are displayed when a logbook If this flag is <b>1</b>, the email recipients are displayed when a logbook
entry is entered which produces an email notification. Setting this flag to 0 entry is entered which produces an email notification. Setting this flag to 0
@ -745,20 +752,20 @@ suppresses this display, in case users need not see that email is being sent and
The default is <b>1</b>. The default is <b>1</b>.
<p> <p>
<li><b><code>Email message body = 0/1</code></b> <li><b><code>Email message body = 0|1</code></b>
</br> </br>
If this flag is <b>1</b>, the email notification send by elog contains the If this flag is <b>1</b>, the email notification send by elog contains the
full message body in addition to the attributes. The default is <b>0</b>. full message body in addition to the attributes. The default is <b>0</b>.
<p> <p>
<li><b><code>Back to main = 0/1</code></b> <li><b><code>Back to main = 0|1</code></b>
</br> </br>
If this flag is <b>1</b>, the "<I>Back</I>" button takes you back to the logbook If this flag is <b>1</b>, the "<I>Back</I>" button takes you back to the logbook
selection page instead to the last entry of the current logbook. selection page instead to the last entry of the current logbook.
The default is <b>0</b>. The default is <b>0</b>.
<p> <p>
<li><b><code>Restrict edit = 0/1</code></b> <li><b><code>Restrict edit = 0|1</code></b>
</br> </br>
If this flag is <b>1</b>, users can only edit their own messages. The system If this flag is <b>1</b>, users can only edit their own messages. The system
checks automatically if the currently logged in user matches the user checks automatically if the currently logged in user matches the user
@ -766,7 +773,7 @@ supplied in an author attribute via the <i>"Preset xxxx"</i> option.
The default is <b>0</b>. The default is <b>0</b>.
<p> <p>
<li><b><code>Top level only = 0/1</code></b> <li><b><code>Top level only = 0|1</code></b>
</br> </br>
If this flag is <b>1</b>, only top level messages are displayed in the search If this flag is <b>1</b>, only top level messages are displayed in the search
result page for threaded display. No replies are shown. The default is <b>0</b>. result page for threaded display. No replies are shown. The default is <b>0</b>.