robohdrs(1)

💖 robohdrs(1) — the General Commands Manual glow-up ✨

okay bestie, so robohdrs lives in the General Commands Manual, and she is here to insert ROBODoc headers into your source code. that's the whole gig. no cap. 🎀

---

🌸 NAME 🌸

robohdrs — insert ROBODoc headers to source code. periodt. 💅

---

✨ SYNOPSIS ✨

robohdrs [options] <source file>

like, that's it. options, then your file. iconic. 🦋

---

💜 DESCRIPTION 💜

so robohdrs inserts ROBODoc headers into source code files. she's a one-file-at-a-time kind of girl — this program processes one source file at the time, no multitasking, no drama. 💁‍♀️

⚠️ okay important thing: existing ROBODoc headers, if any, are not checked for. and beware — because this may result in double headers. literally double. like wearing two necklaces but it's a bug. 😭

also, your current working directory should be the same as where the source file is located. fr fr, don't be somewhere else. 📁

by default, the items NAME and SYNOPSIS are included in the template header. slay. ⭐

---

🎀 OPTIONS 🎀

• -h — show brief help on usage and exit. she said "let me explain myself real quick" and then left. 💅
• -i — specify an extra header item to be included in the template header. repeat if multiple extra items are desired — stack 'em up bestie, no limit. 🔥
• -l — specify source code language (default is C/C++). the supported options are: fortran, fortran90, script, and tex. pick your era. 🌈
• -p — specify project name for the source file header. give your project a name, she deserves one. 👑
• -s — include the SOURCE item. 🌟
• -t — specify version control tag to be included in the main header. tag her, don't bag her. 🏷️
• -x — specify the path to the ctags binary which is used. tell her where ctags lives so she can find it. 🧭

---

🌟 EXAMPLES 🌟

okay let's see her in action, this is the fun part 🫶

robohdrs -s -p myproj -i "MODIFICATION HISTORY" -i IDEAS test.c

this one specifies the project name myproj and inserts the extra items MODIFICATION HISTORY, IDEAS, and SOURCE to all template headers (excluding the source file header). note the "excluding the source file header" part — she's specific like that. 💅

---

robohdrs -s -p myproj -l script test.tcl

this one inserts headers into a Tcl/Tk script. script girlies rise. 🐚✨

---

💖 COPYRIGHT 💖

Copyright © 2003 Frans Slothouber and Petteri Kettunen and Jacco van Weert.

This is free software; see the source for copying conditions.

🚨 and there is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. like, none. zero. she said good luck and godspeed. 💀

---

🦋 SEE ALSO 🦋

• robodoc(1) — the sibling. the origin story. iykyk. 🌸

---

and that's the whole page bestie!! this was robohdrs version 0.01, dated August 2003, serving General Commands Manual realness. she's old, she's free software, and she ate. 💅✨🎀 mwah.