Configuration Files >

# About the Software Initialisation Configuration File

The software initialisation configuration file (by default, /usr/discreet/<product_home>/cfg/init.cfg) is parsed when you launch the software.

Keywords in the configuration file define parameters such as I/O devices, peripherals, workstation display settings, and environment directory paths. These parameters are independent of the project you select from the Project Management menu when you begin a session.

NoteFor information on each keyword in the software initialisation configuration file, see Software Initialisation File Keywords.

When you first install the software, you are prompted to edit the default software initialisation configuration file.

As you work with the software, you may have to edit this file under certain conditions, such as:

- After making changes to your hardware configuration
- When setting session-based keyword values, such as specifying an archiving device

You may choose to create different versions of the software initialisation configuration file to accommodate session-based needs that change through the course of a project.

To view the default software initialisation file, browse to the /usr/discreet/<product_home>/cfg/ directory, and open the init.cfg file in any text editor.

The file contains comments that provide brief descriptions of each keyword, keyword syntax, as well as usage examples.

In some cases keyword examples are not commented out and are used as the default settings. They are parsed during software initialisation and the corresponding parameter is set.

Sample Software Initialisation Configuration Files

The Visual Effects and Finishing application installation packages come with sample software initialisation configuration files for the usual needs of working with NTSC, PAL, HDTV, or film material.

These samples are located in the /usr/discreet/ <product_home> /cfg/linux-x86_64/sample directory.

You should never edit the sample configuration files. Instead, either make a copy of the sample software initialization configuration file that you like or just edit the real init.cfg file.

These samples are starting points toward configuring the software to best suit your needs.

Using a text editor, you can open a software initialisation configuration file for viewing. For example, you may want to read the keywords in different software initialisation configuration samples to see the differences. This is a good way to learn more about configuration keywords.

Modifying a Software Initialisation Configuration File

Software initialisation configuration files have open read/write permissions, and anyone can modify them. In some cases, you may want to restrict access to the files using the chmod command.

Here are some basic guidelines for modifying software initialisation configuration files:

- Do not modify the sample software initialisation configuration files. Make copies of the samples and work on those instead.
- Create a backup of a file before making any changes to it.
- After modifying a software initialisation configuration file, restart the software for the changes to take effect.
- To launch the software with a custom software initialisation configuration file, use the -c start-up option. For example:

  smoke -c /usr/discreet/smoke_2011/cfg/my_custom_init.cfg

  NoteIf you saved your custom software initialisation configuration file in a directory other than /usr/discreet/<product_home>/cfg, be sure to use the full directory path. If the custom file is not found, the application automatically uses the default init.cfg file.

Updating the Software Initialisation Configuration File

The xxdiff utility is normally used during software installation to transfer facility-specific modifications in a customized software initialization configuration file from an earlier application version to the current one.

The following procedure describes how to manually run xxdiff to compare old and new configuration files. While you may never need to do this, this procedure can be useful for troubleshooting problems in your facility. For example, you can use xxdiff to troubleshoot problems in a workstation by comparing its init.cfg file against the init.cfg file of a workstation without problems.

NoteIf you are upgrading from an earlier version of the application, several changes may have been applied to the software initialisation configuration file. Because of this, you may want to select the entire contents of the new init.cfg configuration file and then customize it to avoid adding obsolete keywords.

To update the software initialisation configuration file:

1. In a terminal, start xxdiff and load the two files for comparison by typing the following:

   xxdiff <old_file> <new_file>

   For example, to launch xxdiff to compare the previous and current software configuration files, you would type:

   xxdiff /usr/discreet/<product_home1>/cfg/init.cfg /usr/discreet/<product_home2>/cfg/init.cfg

   where <product_home1> is the home directory for the previous version and <product_home2> is the home directory for the current version.

   The previous and new configuration files appear beside each other in an xxdiff window. The left panel displays the previous file settings and the right panel displays the current file settings. The path to both files is displayed in the title bar. The vertical bar on the right indicates where differences exist between the two panels.

2. Scan the old configuration file for custom directories or keywords that you want to copy to the new init.cfg file.

   On a line-by-line basis, the differences between the old and new configuration files are highlighted.

3. For each highlighted difference, click the line that you want to keep:
   - To keep the setting in the old configuration file, click the line in the left window.
   - To keep the setting in the new configuration file, click the line in the right window.

   Highlighted lines change colour when you click them. You must select a line in the left or right window for each difference detected by xxdiff.

4. When you have finished updating, choose File | Save As Right to save the selected line differences under the name init.cfg.
5. Click OK to confirm, and then exit xxdiff.

#### Topics in this section

- Sample Software Initialisation Configuration Files
- Modifying a Software Initialisation Configuration File
- Updating the Software Initialisation Configuration File