BACKEND-SPEC(7)

πŸ’– backend-spec, section 7 β€” the jw/backend interface πŸ’–

okay so bestie, this is backend-spec, and it lives in section 7 of the manual. It's the whole interface between jw and its backends. no cap. πŸ’…

🌸 NAME 🌸

backend-spec β€” the interface between jw and its backends. periodt. ✨

πŸ¦‹ DESCRIPTION πŸ¦‹

jw(1) calls backends like backends/html to do the "real" conversion work. The backend gets all necessary data delivered via environment variables ready to use. It's giving prepped-and-ready handoff. 🫢

This documentation describes those environment variables. Literally the whole point of this page. πŸ‘‘

The backend is run in the directory where the output files are to be created. It should return 0 if there weren't any problem, and return a positive value otherwise. That's the vibe check for success. βœ…

✨ VARIABLES ✨

These are the env vars, bestie β€” exact names, no freestyling. πŸ’–

  • SGML_FILE_NAME β€” the bare name of the source file. πŸŽ€
  • SGML_FILE β€” the full name and path of the source file. 🌸
  • SGML_JADE β€” the name of the parser (usually Jade or OpenJade). πŸ¦‹
  • SGML_ARGUMENTS β€” the full argument-string for Jade or OpenJade. ✨
  • SGML_CATALOG_FILES β€” the list of catalog files needed by Jade or OpenJade. πŸ“š
  • SGML_STYLESHEET β€” the style sheet to use. πŸ’…
  • SGML_BASE_DIR β€” the base directory of the SGML system (default is /usr/share/sgml). 🌈

πŸŽ€ FILES πŸŽ€

This section has no entries listed. Yes, literally empty, bestie β€” not a glitch. 🫢

πŸ’œ SEE ALSO πŸ’œ

πŸ‘‘ AUTHORS πŸ‘‘

  • Jochem Huhmann <joh@revier.com> β€” iconic. πŸ’–

Catch you later, bestie β€” this was BACKEND-SPEC(7), dated 05 December 2025. πŸ’…βœ¨πŸ¦‹

πŸ“¦ where this page comes from