fpcmake(5)

📦 version 3.2.4~rc1, in arch rolling, epel 10, epel 9, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0

💖 fpcmake(5) — the Free Pascal Makefile.fpc format 💖

okay bestie, sit down, hydrate, and let's talk about Makefile.fpc, the moment of the build system. this whole page is your group chat lore for how Free Pascal projects describe themselves to fpcmake.

✨ NAME ✨

Makefile.fpc — the configuration file for fpcmake. that's the whole assignment. iconic behavior honestly. 💅

🦋 SYNOPSIS 🦋

Makefile.fpc is a configuration file for the fpcmake command. starting from this file, a Makefile gets created to compile Free Pascal units and programs. like, you write the little config, it cooks up the whole makefile. main character energy fr fr. ✨

🌸 DESCRIPTION 🌸

Makefile.fpc is a plain ASCII file that contains a bunch of sections, exactly like a Windows ini file. no cap, same vibe. 🎀

The following sections are recognized (in alphabetical order, because we're organized queens):

🧼 clean

Specifies rules for cleaning the directory of units and programs. The following entries are recognized:

  • units — names of all units that should be removed when cleaning. Don't specify extensions, the makefile will append these by itself. she knows what to do 💅
  • files — names of files that should be removed. Specify full filenames. yes, the whole path, don't be shy.

🫶 defaults

The defaults section contains some default settings. The following keywords are recognized:

  • dirs
  • info

(and they each get their own little heading below, alphabetically, because that's how the list rolls 🌈)

📁 dirs

listed as a recognized section in the alphabetical lineup. the original doesn't spill more tea about it here, and neither will I. 🙈

💬 info

also hanging out in the alphabetical section list. that's all we've got on this one in the source. 🍓

📦 install

Contains instructions for installation of your units and programs. The following keywords are recognized:

  • dirprefix — the directory below which all installs are done. This corresponds to the --prefix argument to GNU configure. It is used for the installation of programs and units. By default, this is /usr on linux, and /pp on all other platforms. (note the platform split, bestie — linux girlies get /usr)
  • dirbase — the directory that is used as the base directory for the installation of units. By default this is dirprefix appended with /lib/fpc/FPC_VERSION for linux, or simply the dirprefix on other platforms.
Units will be installed in the subdirectory units/$(OS_TARGET) of the dirbase entry. 🦋

📚 libs

This section specifies what units should be merged into a library, and what external libraries are needed. It can contain the following keywords:

  • libname — the name of the library that should be created.
  • libunits — a comma-separated list of units that should be moved into one library.
  • needgcclib — a boolean value that specifies whether the gcc library is needed. This will make sure that the path to the GCC library is inserted in the library search path. 🔥
  • needotherlib — a boolean value that tells the makefile that other library directories will be needed.

🧚 packages

Which packages must be used. This section can contain the following keywords:

  • packages — a comma-separated list of packages that are needed to compile the targets. Valid for all platforms. In order to differentiate between platforms, you can prepend the keyword packages with the OS you are compiling for, e.g. linuxpackages if you want the makefile to use the listed packages on linux only. platform-specific packaging, we love to see it
  • fcl — this is a boolean value (0 or 1) that indicates whether the FCL is used.
  • rtl — this is a boolean value (0 or 1) that indicates whether the RTL should be recompiled.

⬇️ postsettings

Anything that is in this section will be inserted as-is in the makefile after the makefile rules that are generated by fpcmake, but before the general configuration rules.

In it, you cannot use variables that are defined by fpcmake rules, but you can define additional rules and configuration variables. so like, you can add stuff, you just can't lean on the generated vars. 💀

⬆️ presettings

Anything that is in this section will be inserted as-is in the makefile before the makefile target rules that are generated by fpcmake.

This means that you cannot use any variables that are normally defined by… and the sentence just kinda trails off there in the original, bestie, I'm not gonna lie to you. 🙈

📏 rules

In this section you can insert dependency rules and any other targets you wish to have.

Do not insert 'default rules' here. seriously. don't. periodt. 💅

🎛️ sections

Here you can specify which 'rule sections' should be included in the Makefile. The sections consist of a series of boolean keywords; each keyword decides whether a particular section will be written to the makefile. By default, all sections are written.

You can have the following boolean keywords in this section:

  • none — if this is set to true, then no sections are written.
  • units — if set to false, fpcmake omits the rules for compiling units.
  • exes — if set to false, fpcmake omits the rules for compiling executables.
  • loaders — if set to false, fpcmake omits the rules for assembling assembler files.
  • examples — if set to false, fpcmake omits the rules for compiling examples.
  • package — if set to false, fpcmake omits the rules for making packages.
  • compile — if set to false, fpcmake omits the generic rules for compiling pascal files.
  • depend — if set to false, fpcmake omits the dependency rules.
  • install — if set to false, fpcmake omits the rules for installing everything.
  • sourceinstall — if set to false, fpcmake omits the rules for installing the sources.
  • zipinstall — if set to false, fpcmake omits the rules for installing archives.
  • clean — if set to false, fpcmake omits the rules for cleaning the directories.
  • libs — if set to false, fpcmake omits the rules for making libraries.
  • command — if set to false, fpcmake omits the rules for composing the command-line based on the various variables.
  • exts — if set to false, fpcmake omits the rules for making libraries. (yes bestie, that's literally what it says, same words as libs 🙈)
  • dirs — if set to false, fpcmake omits the rules for running make in subdirectories..
  • tools — if set to false, fpcmake omits the rules for running some tools as the erchiver, UPX and zip.
  • info — if set to false, fpcmake omits the rules for generating information.

🎯 targets

In this section you can define the various targets. The following keywords can be used there:

  • dirs — a space separated list of directories where make should also be run.
  • examples — a space separated list of example programs that need to be compiled when the user asks to compile the examples. Do not specify an extension, the extension will be appended. ✨
  • loaders — a space separated list of names of assembler files that must be assembled. Don't specify the extension, the extension will be appended.
  • programs — a space separated list of program names that need to be compiled. Do not specify an extension, the extension will be appended.
  • rst — a list of rst files that needs to be converted to .po files for use with GNU gettext and internationalization routines. 🌈
  • units — a space separated list of unit names that need to be compiled. Do not specify an extension, just the name of the unit as it would appear un a uses clause is sufficient.

🛠️ tools

In this section you can specify which tools are needed. Definitions to use each of the listed tools will be inserted in the makefile, depending on the setting in this section.

Each keyword is a boolean keyword; you can switch the use of a tool on or off with it.

The following keywords are recognised:

  • toolppdep — use ppdep, the dependency tool. True by default.
  • toolppumove — use ppumove, the Free Pascal unit mover. True by default.
  • toolppufiles — use the ppufile tool to determine dependencies of unit files. True by default.
  • toolsed — use sed, the stream line editor. False by default.
  • tooldata2inc — use the data2inc tool to create include files from data files. False by default.
  • tooldiff — use the GNU diff tool. False by default.
  • toolcmp — use the cmp file comparer tool. False by default.
  • toolupx — use the upx executable packer. True by default.
  • tooldate — use the date date displaying tool. True by default.
  • toolzip — use the zip file archiver. This is used by the zip targets. True by default.

🤐 zip

This section can be used to make zip files from the compiled units and programs. By default, all compiled units are zipped. The zip behaviour can be influenced with the presettings and postsettings sections. 🦋

The following keywords can be used in this section:

  • zipname — this file is the name of the zip file that will be produced.
  • ziptarget — is the name of a makefile target that will be executed before the zip is made. By default this is the install target.

👀 SEE ALSO 👀

and that's the whole page, bestie. go forth and build. 🫶

💜 this was FreePascal, dated 12 Dec 1999. old-school, still slaying, no cap. 👑 mwah, good luck with your makefiles — you've got this, and I'm obsessed with you. 💖✨🎀
📦 where this page comes from