Difference between revisions of "Configuration file"

From Lazarus wiki
Jump to navigationJump to search
m (FPC user moved page fpc.cfg to Configuration file: better name)
(example and sections)
Line 1: Line 1:
Command line options for the Free Pascal compiler can be stored in a '''configuration file''' and will be used as if they had been typed on the command line. They can be combined with command line options, with configuration file being processed first, before the options given on the command line.  
+
==Description==
 +
To avoid having to include compiler options in build files or repeat them on the command line, Free Pascal allows them to be placed in a configuration file. The compiler options in the file will be read along with  options given on the command line, with the configuration file being processed first.
  
The file is named fpc.cfg, unless it is located in the HOME directory on a Unix-like system, in which case it will follow convention and start with a '.' :  .fpc.cfg. The compiler looks for a configuration file in certain directories, and in a specific order:
+
==Format==
 +
One ''command line option'' is written per line with the same format as when used on the command line.
  
 +
===Comments===
 +
Comment lines are allowed. They follow the Unix shell/Python/Perl comment-style: a '#' signifies the start of a comment.
 +
 +
===Example===
 +
<syntaxhighlight>
 +
# Perform range checking, IO checking, overflow checking, IEEE error checking
 +
-Crio3
 +
</syntaxhighlight>
 +
 +
==Name==
 +
The file is named '''fpc.cfg''', unless it is located in the HOME directory on a Unix-like system, in which case it will follow Unix configuration file convention and start with a '.'  ( .fpc.cfg ). 
 +
 +
==Location==
 
*Under a Unix or Unix-like operating systems (e.g. Linux, FreeBSD)
 
*Under a Unix or Unix-like operating systems (e.g. Linux, FreeBSD)
 
#The current directory.
 
#The current directory.
Line 13: Line 28:
 
#The directory where the compiler is.
 
#The directory where the compiler is.
  
NOTE: Unlike Unix shell configuration files, FPC configuration files are not combined. It will only use the first one that it finds and ignore any others that may also be on the system, including the configuration file that comes with Free Pascal.  
+
==Not Combined==
 +
Unlike Unix shell configuration files, FPC configuration files are not combined. It will only use the first one that it finds and ignore any others that may also be on the system, including the configuration file that comes with Free Pascal.  
  
 +
==Ignore==
 
You can tell the compiler to not use a configuration file by giving the '''-n''' command line option.
 
You can tell the compiler to not use a configuration file by giving the '''-n''' command line option.
 
In addition to command line options (one per line), the configuration file can have comment lines. They use the Unix shell/Python/Perl comment-style of a '#' signifying the start of a comment.
 

Revision as of 12:52, 14 July 2016

Description

To avoid having to include compiler options in build files or repeat them on the command line, Free Pascal allows them to be placed in a configuration file. The compiler options in the file will be read along with options given on the command line, with the configuration file being processed first.

Format

One command line option is written per line with the same format as when used on the command line.

Comments

Comment lines are allowed. They follow the Unix shell/Python/Perl comment-style: a '#' signifies the start of a comment.

Example

# Perform range checking, IO checking, overflow checking, IEEE error checking
-Crio3

Name

The file is named fpc.cfg, unless it is located in the HOME directory on a Unix-like system, in which case it will follow Unix configuration file convention and start with a '.' ( .fpc.cfg ).

Location

  • Under a Unix or Unix-like operating systems (e.g. Linux, FreeBSD)
  1. The current directory.
  2. Your home directory, it looks for .fpc.cfg.
  3. The directory specified in the environment variable PPC_CONFIG_PATH, and if it is not set, it will look in the etc directory above the compiler directory. (For instance, if the compiler is in /usr/local/bin, it will look in /usr/local/etc)
  4. The directory /etc.
  • Under all other operating systems:
  1. The current directory.
  2. If it is set, the directory specified in the environment variable PPC_CONFIG_PATH.
  3. The directory where the compiler is.

Not Combined

Unlike Unix shell configuration files, FPC configuration files are not combined. It will only use the first one that it finds and ignore any others that may also be on the system, including the configuration file that comes with Free Pascal.

Ignore

You can tell the compiler to not use a configuration file by giving the -n command line option.