lcm-spy(1)

💅 lcm-spy — the manual page, bestie edition ✨

okay so you found lcm-spy(1), the traffic inspection tool from the Lightweight Communications and Marshalling (LCM) crew. buckle up, this one's fun 🎀

---

🌸 NAME 🌸

lcm-spy — traffic inspection tool. that's it, that's the name, short and iconic 💖

---

✨ SYNOPSIS ✨

lcm-spy [options]

just the binary and whatever options you're feeling. slay.

---

🦋 DESCRIPTION 🦋

so lcm-spy is the Lightweight Communications and Marshalling traffic inspection utility. it's a graphical tool for viewing messages received on an LCM network 🌈 and the vibe is very much like Ethereal/Wireshark and tcpdump — it can inspect all LCM messages received and give you information and statistics on the channels being used. main character energy, honestly 👑

when you hand it appropriate LCM type definitions, lcm-spy is able to automatically detect and decode messages, and it can display the individual fields of recognized messages. the catch: for unrecognized messages, lcm-spy is limited to displaying statistics only. no decoding for the mystery messages, sorry bestie 😭

here's what lcm-spy collects for each channel:

• Channel name
• Number of messages received
• Message Rate (Hz)
• Bandwidth (KB/s)
  • and on its own, this information can often be used to verify that messages are being transmitted on the expected channels, and at the expected data rates. lowkey a vibe check for your network 🫶

---

💅 OPTIONS 💅

these are the options lcm-spy provides:

• -l, --lcm-url=URL — use the specified LCM URL. that's it, that's the whole thing.
• -t, --title [LABEL] — display LABEL in the window title ✨ cute lil nameplate for your window.
• --title-url — display the LCM URL in the title instead. iykyk.
• -h, --help — shows some help text and exits. classic. respectful. we love a helpful queen 💖

---

🧚 AUTOMATIC MESSAGE DECODING 🧚

here's where it gets magical. if a Java class generated by lcm-gen for an LCM type definition is contained within a JAR file that is on the Java classpath, lcm-spy automatically detects the class and uses Java reflection to insert the corresponding LCM type definitions into a type database 🔮

and subsequently? lcm-spy is able to automatically recognize and decode messages received that correspond to all such types. no cap, it just knows 💅

---

👑 SEE ALSO 👑

• lcm-gen(1)

---

📜 COPYRIGHT 📜

lcm-spy 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

fr fr, read the license. it's giving "legally required but also lowkey important" 💀

---

🎀 AUTHOR 🎀

this manual page was written by Albert Huang. absolute legend, we stan 🫶

---

and that's the whole thing bestie!! this page came to you from the LCM project, dated 2009-07-28 — a classic, an icon, a moment in history ✨ stay decoding, stay slaying, and remember: lcm-spy(1) loves you 💖🌸