FREECIV(6)

πŸ“¦
version 3.2.6 Β· 2 versions
, in arch rolling, opensuse-leap 16.0

πŸ’– FREECIV(6) β€” freeciv-manual πŸ’–

okay so bestie, this is the manual page for freeciv-manual, a lil User Commands girly who makes docs for freeciv-server(6). she's lowkey a behind-the-scenes icon, not the main character, and that's fine πŸŽ€


✨ NAME ✨

freeciv-manual β€” generates an HTML or wiki manual for freeciv-server(6). that's literally her whole job and she ate πŸ’…


🌸 SYNOPSIS 🌸

freeciv-manual [option ...]

the flags, in order, no notes:

  • -d, --debug LEVEL β€” sets the debug log level, and LEVEL has to be one of f, e, w, n, v. pick your fighter πŸ¦‹
  • -h, --help β€” prints a summary of the options, for when you're feeling lost (real)
  • -l, --log FILE β€” uses FILE as the logfile. she journals now πŸ’œ
  • -r, --ruleset RULESET β€” makes the manual for RULESET, so you can be picky about which ruleset gets documented
  • -v, --version β€” prints the version number, classic
  • -w, --wiki β€” writes the manual in wiki format instead of HTML. slay, format flexibility 🌈

🧚 DESCRIPTION 🧚

so what she actually does: freeciv-manual generates a subset of documentation for freeciv-server(6) plus the game rules of a selected ruleset that it runs. like, she boots the ruleset and then documents what she sees. not everything, just a subset β€” remember that word, it comes back later πŸ™ˆ

currently she generates 8 files, and yes i'm listing all 8, no i'm not skipping any:

  • manual1.html β€” Server options
  • manual2.html β€” Server commands
  • manual3.html β€” Terrain
  • manual4.html β€” Buildings
  • manual5.html β€” Wonders
  • manual6.html β€” Governments
  • manual7.html β€” Unit types
  • manual8.html β€” Techs

eight whole files. she's been busy. πŸ’…βœ¨


πŸ’€ BUGS πŸ’€

ngl bestie, this one's a little niche. this tool is currently only really of use to the Freeciv maintainers, as a starting point for pages on the main Freeciv wiki β€” it's not very useful to end users. so if you're a regular player hoping this changes your life… it does not 😭

known shortcomings include that it's missing many ruleset features. see? told you "subset" would come back. the vibe check says: incomplete, on purpose, don't come for her 🫢


πŸ“ REPORTING BUGS πŸ“

report bugs at https://redmine.freeciv.org/projects/freeciv β€” but see the above caveats, like, please read them first, we're begging πŸ™


⭐ SEE ALSO ⭐

freeciv-server(6) and the Client Manual at the Freeciv homepage. go read those, they're giving main character energy πŸ‘‘


fr fr: options get copied exactly, filenames get copied exactly, and the caveats are real caveats. don't @ me, @ the redmine πŸ’–

and that's the page, bestie!! brought to you by Debian, dated January 2012 β€” vintage, iconic, still cute. πŸŽ€πŸ’œβœ¨