5,838
edits
Cumulus.ini (preserving history): Difference between revisions
Cumulus.ini (preserving history) (view source)
Revision as of 04:45, 21 June 2013
, 04:45, 21 June 2013Edit for consistency - refer to parameter line throughout
m (→File Contents: Revising Introduction to cover Cumulus updates) |
m (Edit for consistency - refer to parameter line throughout) |
||
| Line 1: | Line 1: | ||
The cumulus.ini [[:Category:Configuration Files| configuration file]] is located in the directory in which you installed Cumulus. It is a text file containing initialization parameters used by the Cumulus application, and is read only when Cumulus starts up. | The cumulus.ini [[:Category:Configuration Files| configuration file]] is located in the directory in which you installed Cumulus. It is a text file containing initialization parameters used by the Cumulus application, and is read only when Cumulus starts up. Parameter lines are in the form 'attribute=value' and grouped into sections. Cumulus re-writes the contents of the application configuration screens to the file when it shuts down. | ||
== Editing the file == | == Editing the file == | ||
=== Settings controlled by application === | === Settings controlled by application === | ||
Many configuration | Many configuration parameter lines are changed from the various application configuration pages, and those screens should ensure your replacement values are acceptable. You should never edit these directly in the file while Cumulus is running, as Cumulus will replace these parameters with the contents of the relevant application Edit/View/Configuration screens to the file when it shuts down. You can edit them in the file with Cumulus stopped, but beware of selecting invalid values for these parameters, generally it is safer to use the application to edit them (unless you are importing values from another setup), and Cumulus will read the new values when it restarts. | ||
=== Settings independent of application === | === Settings independent of application === | ||
Some configuration settings can only be applied by editing this file to insert | Some configuration settings can only be applied by editing this file to insert a new parameter line; they do not appear anywhere in the configuration screens. Cumulus does not write these values back out to the file on shut down, so they do not appear with default values - in other words, you need to ''add'' them if you want to set them. Make sure you place these additional parameters in the correct section as listed below. | ||
=== General notes === | === General notes === | ||
*It is best to take a copy of the existing cumulus.ini file before you make any changes (either by using application screens or by editing the file), so you can return to the original if necessary. | *It is best to take a copy of the existing cumulus.ini file before you make any changes (either by using application screens or by editing the file), so you can return to the original if necessary. | ||
*If your system is configured to use a comma for a decimal separator, then you should use a comma in any decimal values that you set in this file. | *If your system is configured to use a comma for a decimal separator, then you should use a comma in any decimal values that you set in this file. | ||
*You should use a text editor (not a rich text editor nor word processor) to edit this file as only letters, numerical digits, decimal separators and the equals symbol are allowed in any parameter. If you use a spreadsheet program to make use of the manipulation it offers, ensure it is set to output in pure text. | *You should use a text editor (not a rich text editor nor word processor) to edit this file as only letters, numerical digits, decimal separators and the equals symbol are allowed in any parameter. If you use a spreadsheet program to make use of the manipulation it offers, ensure it is set to output in pure text. | ||
*The | *The parameter lines (attribute=value) can be in any order, but must be in the correct section. You might find it helpful to sort the attributes within a section into alphabetical order, to ensure you have no duplicates and to make it easier to find the particular parameter line you may wish to edit in the future. | ||
== File Contents == | == File Contents == | ||
| Line 19: | Line 19: | ||
Each new version of cumulus may add additional parameters set by revised configuration screens (these initially appear at the end of the relevant section), and/or permit additional parameters to be added manually (these can be inserted anywhere within the section). If you are using an old version, then checking the release information may be advisable to identify the sections applicable to your build and the parameters allowed within those sections may be a subset of those listed below. Equally if you are using a beta build, there may be changes to the information shown below with additional sections and/or additional parameters under test. | Each new version of cumulus may add additional parameters set by revised configuration screens (these initially appear at the end of the relevant section), and/or permit additional parameters to be added manually (these can be inserted anywhere within the section). If you are using an old version, then checking the release information may be advisable to identify the sections applicable to your build and the parameters allowed within those sections may be a subset of those listed below. Equally if you are using a beta build, there may be changes to the information shown below with additional sections and/or additional parameters under test. | ||
The entries shown in the 'parameter line entry' column include the default value from the configuration screen where applicable, a typical example value where appropriate, or just the attribute and an equals sign where there is no typical value. | |||
=== Section: Station === | === Section: Station === | ||
| Line 24: | Line 26: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 418: | Line 420: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 466: | Line 468: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 483: | Line 485: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 651: | Line 653: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 877: | Line 879: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 1,139: | Line 1,141: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 1,321: | Line 1,323: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 1,371: | Line 1,373: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 1,392: | Line 1,394: | ||
|- | |- | ||
|OauthToken= | |OauthToken= | ||
| | |Twitter inserted authentication token parameter - you can delete this line with Cumulus stopped | ||
|- | |- | ||
|OauthTokenSecret= | |OauthTokenSecret= | ||
| | |Twitter inserted authentication token parameter - you can delete this line with Cumulus stopped | ||
|} | |} | ||
| Line 1,402: | Line 1,404: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 1,442: | Line 1,444: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 1,479: | Line 1,481: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 1,517: | Line 1,519: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 1,555: | Line 1,557: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 1,577: | Line 1,579: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 1,655: | Line 1,657: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||
| Line 1,681: | Line 1,683: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:150px" | | !style="width:150px" | Parameter Line Entry | ||
!style="width:600px" | Function | !style="width:600px" | Function | ||
|- | |- | ||