HALREPORT(1)

📦 version 2.9.4, in debian bookworm, debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 HALREPORT(1) — the halreport glow-up ✨

okay bestie, so this is halreport, a little tool from The Enhanced Machine Controller (aka LinuxCNC, you know her 💅). She makes a report on the status of the HAL. Yes, that HAL. The Hardware Abstraction Layer. Not the movie computer. 🎀

🌸 SYNOPSIS 🌸

halreport [outfilename]

that's it. one optional little filename and she's off. 🦋

✨ DESCRIPTION ✨

so halreport is out here doing the absolute most, and honestly? obsessed. here's the vibe check:

  1. she supports components made by halcompile 💖 plus a whole bunch of numerous legacy components (they're iconic, they're grandfathered in, we love them).
  2. known unhandled components — these ones are just... not it, no shade:
    • at_pid — naming conflicts with pid, seldom used. it's giving "we don't talk about her" 😭
    • boss_plc — no manpage or docs (any users?? like, literally anyone? 🙈)
    • watchdog — seldom used (no users in-tree). she's napping, lowkey forever 💀
  3. deprecated/obsolete components — rest in peace, queens 🕊️
    • counter
    • supply

identification of functions used according to pin name. it's giving detective energy 🔍

default handling works for components that:

  1. use names= | count= (.comp components created with halcompile) — the fancy halcompile girlies 💅
  2. have a single function — one function and one function only, main character, no ensemble cast

Full docs:

ngl bestie, the original literally just says "Full docs:" and then... nothing. leaving us on read. 💀 (this is exactly how it is in the source, fr fr, I'm not gatekeeping anything from you)

👑 SEE ALSO 👑

much more information about LinuxCNC and HAL is available in the LinuxCNC and HAL User Manuals, found at /usr/share/doc/LinuxCNC/. go read them, they're lowkey iconic ⭐

🦋 BUGS 🦋

None known at this time. ✨ flawless, no notes, periodt.

🎀 AUTHOR 🎀

This man page written by andypugh, as part of the LinuxCNC project. king behavior, honestly 👑

🌈 REPORTING BUGS 🌈

Report bugs at https://github.com/LinuxCNC/linuxcnc/issues — if you find one, speak up bestie, we're listening 🫶

Copyright © 2020 andypugh.

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

say it with me: NO warranty. not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. fr fr, don't come for her if your machine does a chaos. 😭

and that's the whole page, bestie 💖 this was the LinuxCNC Documentation version, dated 2020-08-26, and the manual section is HALREPORT(1). slay, go read the HAL manuals at /usr/share/doc/LinuxCNC/, mwah 💅✨🌸

📦 where this page comes from