GDLGSDOC(1)

πŸ“¦ version 0.12.0+git20250112, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– GDLGSDOC πŸ’–

okay bestie, welcome to gdlgsdoc β€” that's section 1 of the GNUstep Manual Pages btw, iykyk. she's a little command-line girly whose whole entire job is turning .eomodel files into .gsdoc files. no thoughts, just conversion. πŸ¦‹


✨ NAME ✨

gdlgsdoc β€” produce .gsdoc files from .eomodel files πŸ’…


🌸 SYNOPSIS 🌸

gdlgsdoc [--verbose=level] [--project=|--projectName=name]
[--documentationDirectory=dir] [--define-variable=value]
--template=filename FILES...

πŸŽ€ DESCRIPTION πŸŽ€

so here's the tea, bestie: gdlgsdoc generates .gsdoc files from your input .eomodel files. that's it, that's the whole vibe. ✨

and the math is simple, no cap β€” the number of generated files corresponds to the number of input files. one in, one out, main character energy all around. πŸ‘‘

⚠️ heads up!! this tool does not generate HTML. not her job, not her problem. if you want HTML, go bother autogsdoc(1) instead. πŸ’€

πŸ’… OPTIONS πŸ’…

  • --verbose=level β€” sets the verbosity level for debugging messages. default is 0 (aka no extra messages, silent queen πŸŽ€). 1 gives you standard debugging output, and 3 is maximum verbosity, the full yap. 2 does the exact same thing as 1, and literally any number above 3 just acts like 3. slay.
  • --project=name β€” sets the project name. simple, iconic.
  • --projectName=name β€” this is just an alias for --project. same girl, different name. 🫢
  • --documentationDirectory=dir β€” sets the directory for saving the .gsdoc file(s), relative to the directory of the input .eomodel file(s). the default is the same directory. so if you don't say anything, she just drops it right where she found you. 🌸
  • --define-variable=value β€” defines a user variable to a specific value. you can use this option multiple times, stack 'em up. πŸ“ variable placeholders get set in the template file and then get substituted with the corresponding value at generation time. and ooh β€” if your verbosity level is set to 3, the variable(s)/value(s) get printed to the standard output. very demure, very transparent. πŸ‘‘
  • --template=filename β€” uses filename as the template for the generated .gsdoc file(s). note that this is a mandatory option β€” fail to specify it and no .gsdoc file will be created. like, at all. nothing. empty. πŸ•³οΈ so don't forget it, bestie, i'm begging.

🌈 SEE ALSO 🌈

autogsdoc(1), GNUstep(7)


πŸ‘‘ AUTHORS πŸ‘‘

gdlgsdoc was written by Manuel Guesdon. πŸ’œ

this manual page was written by Yavor Doganov <yavor@gnu.org> for the Debian project, but it may be used by others. sharing is caring fr fr. 🫢


🧚 COPYING 🧚

Β© 2024 Debian GNUstep maintainers

this manual page is distributed under the same license as the gdlgsdoc program. periodt. πŸ’…


✨ and that's the whole page, bestie ✨ this was GNUstep, June 2024 β€” go forth and generate those .gsdoc files, you absolute icon. πŸŽ€πŸ¦‹πŸ’–

πŸ“¦ where this page comes from