lcm-gen(1)

✨ lcm-gen(1) ✨

okay bestie, grab a snack because we're about to talk about lcm-gen from the Lightweight Communications and Marshalling (LCM) project 💖 she's the code generation tool and she is, honestly, so iconic.

---

🌸 NAME 🌸

lcm-gen — the code generation tool. that's it, that's her whole job, and she does it flawlessly 💅

---

🦋 SYNOPSIS 🦋

lcm-gen [options] FILE...

---

🎀 DESCRIPTION 🎀

so lcm-gen is the Lightweight Communications and Marshalling code generation utility. you hand her one or more .lcm files (those are the ones holding your LCM message type definitions, iykyk), and she generates language-specific bindings for marshalling and unmarshalling messages of the types you specified. no cap. she just does that. 👑

and rn she can generate language bindings for C, C++, Java, Python, Lua, and C#. six languages, one girl, main character energy fr fr ✨

---

🌈 GENERAL OPTIONS 🌈

the universal ones, the ones that work no matter what language you're living in 🫶

• -h — prints some help text and dips out. cute, informative, quick.
• -t, --tokenize — shows the tokenization. like, the behind-the-scenes of how she's reading your file 👀
• -d, --debug — shows the parsed files. for when you wanna peek at what she actually understood.
• --lazy — generates the output file only if the .lcm file is newer than the output file (or if the output file doesn't already exist yet). so unserious of her, but honestly? valid. why do work you don't need to do 💅
• --package-prefix PFX — adds the package name PFX as a prefix to the declared package. a little name tag, a little accessory ✨
• --version — shows version information and exits. quick lil flex.

---

💜 C OPTIONS 💜

the C crew, we love them, we respect them 🎀

• -c, --c — emit C code. yes ma'am.
• --c-cpath DIR — destination directory for the generated .c files. (default: current directory)
• --c-hpath DIR — destination directory for the generated .h files. (default: current directory)
• --cinclude DIR — the generated #include lines reference this directory.
• --c-no-pubsub DIR — do not generate _publish and _subscribe functions. this gives you .c and .h files with no linking dependencies that you can use for just marshalling, totally separate from liblcm. but heads up bestie: they still #include <lcm/lcm_coretypes.h>, so you'll need to copy that file over to the appropriate include path yourself 🙈
• --c-typeinfo — generates typeinfo functions for each type. it's experimental, so like, she's trying something new, be nice 💅

---

⭐ C++ OPTIONS ⭐

• -x, --cpp — emit C++ code.
• --cpp-hpath DIR — destination directory for the generated .hpp files. (default: current directory)
• --cpp-include DIR — the generated C++ #include lines reference this directory.
• --cpp-std STD — the generated files comply with the specified C++ standard. supported values are: c++98, c++11. default is c++98. choose your era, bestie 🕰️

---

☕ JAVA OPTIONS ☕

• -j, --java — emit Java code.
• --jpath DIR — destination base directory for the generated Java files. (default: current directory)
• --jmkdir <true|false> — automatically create Java source directories. (default: true)
• --jdecl STR — a string added to class declarations. (default: implements lcm.lcm.LCMEncodable)
• --jdefaultpkg PKG — the default Java package if the LCM type has no package. (default: lcmtypes)

---

🐍 PYTHON OPTIONS 🐍

• -p, --python — emit Python code.
• --ppath DIR — destination base directory for the generated Python files. (default: current directory)

---

🌙 LUA OPTIONS 🌙

• -l, --lua — emit Lua code.
• --lpath DIR — Lua destination directory.

---

💀 C#.NET OPTIONS 💀

• --csharp — emit C#.NET code
• --csharp-path DIR — C#.NET destination directory
• --csharp-mkdir <true|false> — make C#.NET source directories automatically. (default: true)
• --csharp-strip-dirs <true|false> — do not generate folders for default and root namespace. (default: false)
• --csharp-decl STR — a string added to class declarations. (default: " : LCM.LCM.LCMEncodable")
• --csharp-root-nsp NSP — root C#.NET namespace (wrapper) added before the LCM package. (default: "")
• --csharp-default-nsp NSP — default C#.NET namespace if the LCM type has no package. (default: LCMTypes)

---

👑 COPYRIGHT 👑

lcm-gen is part of the Lightweight Communications and Marshalling (LCM) project. permission is granted to copy, distribute and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. see the file COPYING in the LCM distribution for more details regarding distribution 📜

LCM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. see the GNU Lesser General Public License for more details. you should have received a copy of the GNU Lesser General Public License along with LCM; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

---

🫶 AUTHOR 🫶

this manual page was written by Albert Huang. thank you for your service, legend 💖

---

and that's the whole vibe, bestie 🦋 this is LCM, dated 2007-12-13, living her best life as lcm-gen(1). go generate something iconic ✨💅🎀