HALRUN(1)

💖 HALRUN(1) — bestie's guide to halrun 💖

okay so this is from the HAL User's Manual, and it's literally the glow-up guide to halrun ✨

---

🌸 NAME 🌸

halrun — manipulate the LinuxCNC HAL from the command line 🫶

---

🎀 SYNOPSIS 🎀

halrun -h

halrun [-I] [halcmd_opts] [filename[.hal|.tcl]]

halrun -T [halcmd_opts] [filename[.hal|.tcl]]

halrun -U

---

✨ DESCRIPTION ✨

halrun is a convenience script, bestie. it's the little helper you use to manipulate the HAL (that's the Hardware Abstraction Layer, iykyk) from the command line 💅

when you invoke it, halrun:

• sets up the realtime environment 🌈
• executes a command interpreter (halcmd or haltcl)
• optionally runs an interactive session
• tears down the realtime environment 💀

if no filename is specified, an interactive session is started. the session will use halcmd(1) unless -T is specified, in which case haltcl(1) will be used. periodt.

if a filename is specified and neither the -I nor the -T option is included, the filename will be processed by the command interpreter corresponding to the filename extension (halcmd or haltcl). after processing, the realtime environment will be torn down. no cap.

if a filename is specified and the -I or -T option is included, the file is processed by the appropriate command interpreter and then an interactive session is started for halcmd or haltcl according to the -I or -T option. it's giving choose-your-own-adventure 🦋

---

💅 OPTIONS 💅

• halcmd_opts — when a .hal file is specified, the halcmd_opts are passed to halcmd. see the man page for halcmd(1) 👑 when a .tcl file is specified, the only valid options are:
  • -i <INI file>
  • -f <filename[.tcl|.hal]> (alternate means of specifying a file)
• -I — run an interactive halcmd session 🌸
• -T — run an interactive haltcl session.
• -U — forcibly cause the realtime environment to exit. it releases the HAL mutex, requests that all HAL components unload, and stops the realtime system. -U must be the only commandline argument. 🚨
• -h — display a brief help screen and exit ✨

---

🙈 BUGS 🙈

none known at this time. we love a clean slate fr fr 🎀

---

⭐ AUTHOR ⭐

original version by John Kasunich, as part of the LinuxCNC Enhanced Machine Controller project. now includes major contributions by several members of the project 🫶

---

💜 REPORTING BUGS 💜

report bugs to the LinuxCNC bug tracker ⟨https://github.com/LinuxCNC/linuxcnc/issues⟩.

---

👑 COPYRIGHT 👑

Copyright © 2003 John Kasunich.

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

---

🌈 SEE ALSO 🌈

halcmd(1), haltcl(1)

---

and that's the whole vibe check, bestie 🦋 this came from the LinuxCNC Documentation, dated 2012-01-31, and yeah it's literally labeled HALRUN(1) — iconic behavior, ate, no notes 💖✨