lopsubgen(1)

📦
version 1.0.4 · 4 versions
, in ubuntu noble

💅 lopsubgen — the glow-up machine

okay so bestie, welcome to lopsubgen, and yes it lives in section 1, the User commands corner of the manual 💖. Think of it as the makeover station for your lopsub suite: it takes your suite and turns it into C or roff, no cap.

✨ SYNOPSIS ✨

lopsubgen  [--help] [--version] [--output-dir=<dir>] [--gen-c[=<path>]]
[--gen-header[=<path>]] [--gen-man[=<path>]] [--version-string=<string>]

🦋 DESCRIPTION 🦋

So here's the vibe: lopsubgen reads a lobsub suite from stdin and converts it into zero or more output formats. Zero is a real number here, bestie — if you don't name any output format, the input just gets a vibe check for syntactic correctness and that's it. 💅

The format of the input (the lopsub suite) is described in lopsub-suite(5). Go read it, iykyk 📖

🎀 OPTIONS 🎀

🌸 General options 🌸

  • -h, --help — print help and exit. And listen — give it twice and you get the detailed help. yes, twice. it's giving easter egg 🥚
  • -V, --version — print version and exit. iconic, brief, love her.
  • -o, --output-dir=<dir> — where to write the output file(s). default: . — meaning all output files land in the current working directory unless you say otherwise 🏠
  • --gen-c[=<path>] — generate C output 🔥 This produces a C file containing the definition of a subsub suite structure.

If <path> is absolute, the output goes to that exact path and the argument to --output-dir is ignored (yes, completely ignored, she does not care). Otherwise the output path is relative to the value of the --output-dir option.

If you don't pass the optional argument at all, the output file name is derived from the suite name by appending the string .lsg.c — cute, automatic, done 💫

  • --gen-header[=<path>] — generate a .h file ✨ The generated header file is meant to be included from the application. It defines handy C enums and preprocessor macros, like the number of commands defined in the suite. so useful, honestly 🫶

The path for the generated header file is determined the same way as for C output — peep --gen-c.

🧚 Options for man output 🧚

  • --gen-man[=<path>] — generate the man page 📖
Heads up bestie: if this option isn't given, all the subsequent options in this section are ignored. literally all of them. don't come crying 😭

The path for the output file is determined the same way as for C output — again, see --gen-c.

  • --version-string=<string> — override the version string 💜

If this option is given, its argument is used as the version string and the value of the version-string directive of the suite is ignored. Super useful for applications which dynamically create the version string by running a command like git-describe — yes, that git-describe. slay 🌈

Written by Andre Noll Copyright (C) 2016 Andre Noll License: GNU GPL version 3, http://www.gnu.org/licenses/gpl-3.0.html

This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. Report bugs to Andre Noll 🐛

🌈 SEE ALSO 🌈

Homepage: http://people.tuebingen.mpg.de/~maan/lopsub 🏡

and that's the whole page, bestie — this was lopsubgen, version 1.0.4, dated March 2024 💖✨ go forth and generate 🎀🦋

📦 where this page comes from