Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
  
[+] Expand All
[-] Collapse All

Tips for Editing Configuration Files

When editing configuration files, observe the following guidelines:

  • Configuration files are text files that you can edit using a standard text editor. If you use a word processing application such as Microsoft Word to edit your configuration files, make sure that you save the modified file in ASCII text format with UNIX line endings.
  • Make a backup copy of your configuration files before you make any changes, so that you have a working archive copy in the event that you delete or misconfigure an important setting and want to revert to your previous configuration.
  • Configuration files usually contain one or more sections, denoted with a [SectionName] line. Each section contains one or more settings, which typically take the format SettingName = SettingValue. In general, the SettingName text is not case-sensitive (ENABLE = 1, Enable = 1, and enable = 1 are all valid), but the SettingValue text is case-sensitive. If a setting is commented out or omitted, Steel-Belted Radius Carrier uses the default value for the setting.
  • You can enter comments in configuration files by starting the line containing the comment with a semicolon (;) as the first character of the line. To disable a setting, consider commenting it out (by putting a semicolon at the start of the line) instead of deleting it.

    Note: Commenting out a section header [SectionFoo] does not automatically comment out the parameters of that section. In the following example, the [SectionFoo] parameters are interpreted by the software in the same way as the [SectionBar] parameters:

    [SectionBar]
    BarParameter1 = click
    BarParameter2 = clack
    
    ;[SectionFoo]
    FooParameter1 = bit
    FooParameter2 = byte
  • Put comments on a separate line above or below configuration settings. You cannot include comments on the same line as a configuration setting.

    Correct:

    ;Set to 0 on 5/30/2006
    Session_Timeout = 0

    Incorrect:

    Session_Timeout = 0 ; Set to 0 on 5/30/2006
  • The default configuration files provided with Steel-Belted Radius Carrier typically include section headers and settings that are commented out. In such cases, Steel-Belted Radius Carrier uses the value shown in the commented setting as the default, meaning that you do not need to change the setting if you want to use the default value.

    To change the value for a setting to something other than the default value, you must uncomment the setting by removing the semicolon at the start of the line. The section headers (in square brackets) must also be uncommented for settings to be processed correctly.

  • Make sure that lines containing settings or section headers have a text character in the first column. If a line has white space in the first column, it might not be processed correctly.
  • If you mistype a setting or enter an invalid setting in a configuration file, Steel-Belted Radius Carrier ignores that setting. It is recommended that you avoid entering any invalid text in configuration files because the text may accidentally interfere with settings reserved for developers.
  • You can edit configuration files while Steel-Belted Radius Carrier is running. However, changes to some files, such as radius.ini, require that you execute a HUP command or restart Steel-Belted Radius Carrier for the changes to take effect.

Modified: 2017-03-07