Back to main menu

Program behaviour: setting up a configuration file

Syntax

none

Description

The default behaviour of Atomsk can be changed by setting up a configuration file.

When running on UNIX/Linux systems, the behaviour of the program can be set in a system-wide configuration file /etc/atomsk.conf. Each user can also customize the behaviour of the program by setting up his own personal configuration file, which must be placed in the user's configuration directory (defined by the environment variable $XDG_CONFIG_HOME or, if the latter is not defined, defined to be the hidden directory $HOME/.config/) and named atomsk.conf. Finally, a configuration file named atomsk.conf may also exist in the current directory.

When running on Microsoft® Windows® environments, each user can customize the behaviour of the program by setting up a personal configuration file, which must be placed in the user's personal directory (defined by the %HOMEPATH% environment variable) and named atomsk.ini (text file). Finally, a configuration file named atomsk.ini may also exist in the current directory

This configuration file has a pretty simple format. Empty lines and lines starting with the hash symbol (#) are ignored, and the following keywords can be used:

Default

By default, no output format is active. The language is the one used by the operating system, or defaults to English. Atomsk does not ignore nor overwrite files, but prompts the user what to do. The number of threads is the one set by the operating system's environment variable OMP_NUM_THREADS, or takes the maximum value by default. Coloured messages are disabled. Progress bars are displayed with the style "linear".

These default parameters are successively replaced (overwritten) by those defined in:

Example

~/.config/atomsk.conf

# This is a comment
# Always output to xsf and cfg
format xsf
format cfg

# If output files already exist,
# don't ask, just ignore them
overw no
ignore yes

# Always run in silent mode
verbosity 0

# Enable colours
colour yes
colour_error red bold blink

Back to main menu