Configuration file: what changed

Revision 0 to 1. Removed lines have a minus sign; added lines have a plus sign.

Title: Configuration file

New		Line
1	+	## Description
2	+
3	+	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.
4	+
5	+	## Format
6	+
7	+	One command line option is written per line with the same format as when used on the command line.
8	+
9	+	### Comments
10	+
11	+	Comment lines are allowed. They follow the Unix shell/Python/Perl comment-style: a '#' signifies the start of a comment.
12	+
13	+	### Conditional Processing
14	+
15	+	Special comment directives are available to allow a configuration file to be conditionally processed. Available directives are:
16	+
17	+	- \#CFGDIR - use the directory specified in this directive as the location to find files named in subsequent \#INCLUDE directives.
18	+	- \#SECTION
19	+	- \#WRITE - print a string
20	+
21	+	Directives that are equivalent to Free Pascal source code compiler directives. For example, \#DEFINE in a config file is equivalent to {\$DEFINE } in source code.
22	+
23	+	- \#DEFINE
24	+	- \#ELSE
25	+	- \#ENDIF
26	+	- \#IFDEF -
27	+	- \#IFNDEF
28	+	- \#INCLUDE
29	+	- \#UNDEF
30	+
31	+	### Example
32	+
33	+	``` pascal
34	+	# Perform range checking, IO checking, overflow checking, IEEE error checking
35	+	-Crio3
36	+	# compiler halts after warnings
37	+	-Sew
38	+	```
39	+
40	+	## Name
41	+
42	+	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 ) .
43	+
44	+	## Create
45	+
46	+	Example for Windows: Open a command prompt and go to the directory where fpc.exe is. This command will create a fpc.cfg for your installation and it will be placed in the current directory.
47	+
48	+	fpcmkcfg -d basepath=C:\fpc\\ -o .\fpc.cfg
49	+
50	+	See fpcmkcfg -? for meaning of commandline switches.
51	+
52	+	## Location
53	+
54	+	- Under a Unix or Unix-like operating systems (e.g. FreeBSD, Linux)
55	+
56	+	1. The current directory.
57	+	2. Your home directory, it looks for .fpc.cfg.
58	+	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)
59	+	4. The directory /etc.
60	+
61	+	- Under all other operating systems:
62	+
63	+	1. The current directory.
64	+	2. If it is set, the directory specified in the environment variable PPC_CONFIG_PATH.
65	+	3. The directory where the compiler is.
66	+
67	+	## Not Combined
68	+
69	+	Unlike Unix shell configuration files, FPC configuration files are not automatically combined (user-specific and system-wide). 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. However, you can use the \#INCLUDE directive (identical to {\$INCLUDE } in Free Pascal source code) to include another configuration file. For example, your personal fpc.cfg in the current directory file could include the /etc/fpc.cfg file that came with Free Pascal.
70	+
71	+	``` pascal
72	+	# To avoid having to duplicate options in the FPC-provided configuration file
73	+	# that file can be included in a custom configuration file.
74	+	# This is how the file would be included on a Unix-like system:
75	+
76	+	#INCLUDE /etc/fpc.cfg
77	+
78	+	# Then custom options can be added.
79	+
80	+	-Sew
81	+	```
82	+
83	+	You also can specify additional configuration files by specifying them on the command line, preceded by the @ symbol:
84	+
85	+	``` pascal
86	+	fpc @/dir1/dir2/configfile2.cfg @subdir/configfile3.txt @configfile3.txt my_program.pp
87	+	```
88	+
89	+	## Ignore
90	+
91	+	You can tell the compiler to not use a configuration file by giving the -n command line option.
92	+
93	+	---
94	+	From the Free Pascal wiki, page "Configuration file", as it stood on 2020-02-08 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).
95	+	Category: FPC

Back to history