falconeer.fal(1)

💅 falconeer.fal — the Falcon Skeleton Module glow-up script

okay so first things first: this is falconeer.fal(1), straight out of the Falcon User Manuals bestie, and it's literally the script that takes your sad little directory of Falcon Skeleton Module files and makes it compilable on every system Falcon supports. no cap. 🦋

---

✨ NAME ✨

falconeer.fal — the Falcon skeleton module startup configurator script. it's giving "personal assistant for your module", fr fr 💅

---

🎀 SYNOPSIS 🎀

falconeer.fal -n moduleName [options]

---

🌸 DESCRIPTION 🌸

so the falconeer.fal script configures a directory containing the Falcon Skeleton Module so that it becomes ready for compilation under all the systems supported by Falcon. all of them. the whole roster. 👑

is it mandatory? nope! but a developer who's willing to write native modules for Falcon may use this facility to speed up the startup phase and begin with an already compilable module. it's basically a head start, and honestly? iconic. main character energy only. ⭐

the configuration consists of two whole things, and both of them slay:

• renaming the module files into the module name you specified in the command line 🔥
• updating the makefiles and project files provided for the various development platforms Falcon can be built on 🛠️

and like, other than the project name, the script allows you to configure other options too — those affect the template variables that get substituted in the modified files. so you're not just renaming stuff, you're customizing the whole vibe. 💖

once it's configured and built, the skeleton module provides already a skeleton() symbol that is exported to the VM, plus a service that exports that function (defined in the fskelmod_mod.cpp file) to C++ applications. yes bestie, it comes with the goods pre-loaded. 🎁

---

✨ OPTIONS ✨

• -a <author> — specifies the author name. put your name on it, you earned it 🫶
• -c "<copyright owner>" — indicates the copyright owner, if different from the author, to be set on the copyright line, right beside the copyright year. for when the author and the owner are not the same person, iykyk 📝
• -d <Description> — sets a brief description of the project. keep it cute, keep it brief 💫
• -l <File> — loads a license plate (that's a long statement indicating the license under which the files are distributed) from a template file. if not given, the standard FPLL license plate is applied to the generated files. so like, default behavior is FPLL unless you say otherwise 🎀
• -n <name> — sets the (short) name of the project. files will be renamed accordingly to this value, and also the final module name will be configured using this setting. this one's kind of the whole point tbh 👑
• -p <name> — sets the main project hood under which the file is created. usually, modules are part of wider projects, or can be distributed as sets. if not set, the text The Falcon Programming Language will be used instead. default text, noted 🦋

---

💀 BUGS 💀

okay so there's one (1) little hiccup: the file version.h cannot currently be properly configured. you have to edit it by hand. yeah. manually. with your own two hands. sorry bestie 😭🙈

---

🌈 NOTES 🌈

on some systems, the falconeer.fal script can be "proxied" with a falconeer pseudo command (shell script, batch file and so on). so if you see falconeer hanging around, that's why 💜

---

🧚 AUTHOR 🧚

Giancarlo Niccolai <gc@falconpl.org> — thank you for your service, king 🫡

---

🍓 SEE ALSO 🍓

• falcon(1)

---

⭐ LICENSE ⭐

this document is released under the "GNU Free Documentation License, version 1.2". on Debian systems, the complete text of the Free Documentation License, version 1.2, can be found in /usr/share/common-licenses/. legal stuff, but make it cute 💅

---

and that's the whole page, bestie — brought to you by the Falcon toolset, dated July 2007. ancient, but the vibes are timeless. mwah 💖✨🎀