REGINA-ENGINE-CONFIG(1)

πŸ“¦
version 7.4.1 Β· 3 versions
, in arch rolling, ubuntu resolute, ubuntu stonking

✨ REGINA-ENGINE-CONFIG(1) ✨

okay bestie, welcome to the Regina Handbook, page one of the regina-engine-config saga πŸ’– this is the little utility that tells you exactly which compiler and linker flags you need to build your own stuff against Regina, no guessing, no vibe-based flag archaeology πŸ’…


🌸 NAME 🌸

regina-engine-config β€” get compiler and linker flags to build software against Regina 🫢


πŸŽ€ SYNOPSIS πŸŽ€

regina-engine-config [ --prefix ] [ --version ] [ --cflags ] [ --libs ]

πŸ¦‹ DESCRIPTION πŸ¦‹

so basically: this utility tells you which compiler and linker flags should be used to build the mathematical engine of Regina into your own programs. and like, Regina's mathematical engine is typically installed in the library libregina-engine.so ✨ iconic, honestly.

lowkey though, this utility is only available in some settings, and you need a vibe check on which one you're in:

  • If you are using GNU/Linux and you have Regina installed in a system location (e.g., beneath /usr/ or /usr/local/), then regina-engine-config should be included with your installation, and it should output compiler/linker flags relative to this system installation. πŸ’–
  • If you are building Regina yourself from the source tree (on any platform), then you can run regina-engine-config from the source tree, and it should output compiler/linker flags relative to the same source tree. In particular, you do not need to install Regina for these compiler/linker flags to work. πŸ”₯
  • If you are using pre-built packages for Regina on macOS or Windows, then regina-engine-config will not be included in your installation. 😭 tragic but true.
instead of using regina-engine-config as part of the compilation process, you may find it easier to create a Makefile using regina-helper and then just use make instead. fr fr, that's the main character move πŸ‘‘

✨ OPTIONS ✨

  • --prefix β€” prints the installation prefix where Regina has been installed. πŸ“
  • --version β€” prints the currently installed version of Regina. this will include any BUILD_INFO string that was set when Regina was built, so you get the full lore 🫢
  • --cflags β€” print the compiler flags that are required to compile a program that uses the Regina calculation engine. 🌈
  • --libs β€” print the linker flags that are required to link a program against the Regina calculation engine. πŸ”—

🌟 EXAMPLE 🌟

example$ regina-engine-config --cflags
-std=c++20
-I/usr/include/regina-normal -I/usr/include -I/usr/include/libxml2
example$

look at her go, ate that πŸ’…


πŸ‘€ SEE ALSO πŸ‘€

regina-helper.


πŸ’œ AUTHOR πŸ’œ

This utility was written by Benjamin Burton <bab@maths.uq.edu.au>. Many people have been involved in the development of Regina; see the users' handbook for a full list of credits. 🌸

This script was long ago based on gtk-config, though very little of that remains nowadays. The original gtk-config was Copyright (C) 1998 Owen Taylor and used an MIT-style license; see the regina-engine-config script for full details. πŸ“œ


okay that's the whole page, no cap πŸŽ€ this was the Regina Handbook's REGINA-ENGINE-CONFIG(1), dated 25 August 2025, and bestie you made it all the way to the end so here's your gold star ⭐ mwah πŸ’–

πŸ“¦ where this page comes from