LU-COMMENT-EXTRACTOR(1)

📦 version 0.0.9, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 LU-COMMENT-EXTRACTOR 💖

okay bestie, so you know how source files are always hiding little love notes in their comments? yeah. this is the girl that goes and gets them for you. it's lu-comment-extractor, a User Command, and she's about to pull the topmost comments out of your source files using GNU Source Highlight. no cap. ✨

🌸 NAME 🌸

lu-comment-extractor — extract comments from source code files 💅

🎀 SYNOPSIS 🎀

lu-comment-extractor [OPTION]... FILE

🦋 DESCRIPTION 🦋

She shows you the topmost comments of source files (using GNU Source Highlight, periodt).

Like, not all of them by default. Just the top ones. The main character comments, if you will. 👑

Here's the whole menu of options, and yes we're going through every single one because I love you:

  • -f, --full — instead of showing topmost comments, show them all. every last one. the whole group chat. 🔥
  • -s, --style NAME — parse comments in the style of NAME. it's giving "which language are we in rn"
  • --stats — also show starting and ending byte positions. receipts. 🧾
  • -O, --output FILE — dump comments to FILE instead of stdout. like, put them somewhere else, not in the terminal's face
  • -h, --help — display this help and exit. classic. she's helping. 🫶
  • --version — display version information and exit

⭐ the style situation ⭐

So NAME (that's the thing you pass to --style) can be one of these:

  • c
  • c++
  • javascript
  • shell
  • scheme
  • texinfo
  • latex
  • m4
  • haskell
  • groff
  • gettext
  • fortran
  • pascal

and "c" is the default. like, if you don't say anything, she assumes C. that's just her vibe. 💜

🍓 about --stats 🍓

Okay so --stats is lowkey iconic. It produces a terminating line showing the source row, source column, along with the destination row, destination column of the detected comments.

so like: where it came from, and where it's going. a little origin story for your comments. 📍➡️📍

😭 REPORTING BUGS 😭

Found a bug?? not her fault (jk it totally is, tell her anyway). Report bugs to:

<http://sv.nongnu.org/bugs/?group=licenseutils>

bestie please actually report them, she wants to know, she's not gonna be weird about it 🙈

🌈 and that's the page 🌈

This whole thing is lu-comment-extractor, living in the User Commands section, dated October 2017, straight out of the licenseutils group over at sv.nongnu.org. mwah. take care of her. 💖✨🎀🦋

📦 where this page comes from