It is fairly common for software to install example configurations and let the user copy and modify this configuration for use with their actual installation. By "user" I mean anyone installing the software, be it a local administrator (root) installing the software system-wide or an unprivileged user installing the software under their $HOME
somewhere.
Example configuration files may, for example, be installed
- in or under
sysconfdir
, but with a modified filename (for example with a .example
suffix).
- is a separate
examples
directory somewhere under docdir
.
The INSTALL
document would then direct the user to copy and modify these examples to suit their needs.
The benefit of this is that the user installing a new version of the software would get an up to date example of the configuration file or files. They can then update their actual configuration based on the new files if they need to do so.
Avoiding installing a new configuration file, and not installing examples, would possibly leave the user in a bewildered state when the syntax of the configuration, or any of its settings, has changed as they don't know what the file should look like (unless this is clearly mentioned in the utility's manual and upgrade instructions).