LOU_CHECKYAML(1)

πŸ’– LOU_CHECKYAML(1) β€” like, the manual page but make it cute πŸ’–

okay bestie, so this is lou_checkyaml from the Liblouis family (yes that's the manual name, we're already friends now 🫢) β€” a whole little tool whose entire job is running Braille tests that you wrote in a YAML file. she's a tester. that's her vibe check. ✨


🌸 SYNOPSIS 🌸

lou_checkyaml YAML_TEST_FILE

that's it. one argument. main character energy, minimal cast. πŸŽ€


πŸ’… DESCRIPTION πŸ’…

so what she does is: she runs the tests defined in YAML_TEST_FILE. and then she tells you how it went β€” returns 0 if all the tests pass, or 1 if any of the tests fail. ngl, 1 is the "ma'am, something is off" number. 😭

the details of failing tests get printed to stderr. so like, the drama goes to the error stream, not stdout. iykyk. πŸ’€

and she takes options too, which are:

  • -h, --help β€” displays this help and exits. she's like "here's the whole lore, bye" πŸ’–
  • -v, --version β€” displays version information and exits. iconique of her, honestly. πŸ‘‘
  • --verbose β€” reports expected failures. so like, failures you already knew about get a little shoutout instead of staying silent. not me being nosy about my own tests πŸ”₯

πŸ¦‹ AUTHOR πŸ¦‹

written by Christian Egli. respect to the legend, fr fr. πŸ™Œ


πŸ“ REPORTING BUGS πŸ“

found a bug? don't suffer in silence, bestie β€” report it to liblouis-liblouisxml@freelists.org. πŸ“¬

Liblouis home page: <http://www.liblouis.io> β€” go say hi 🌈


Copyright Β© 2024 Swiss Library for the Blind, Visually Impaired and Print Disabled. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.

this is free software β€” you are free to change and redistribute it. there is NO WARRANTY, to the extent permitted by law. okay so that part is genuinely serious: no warranty, like, at all, so don't come for her if something breaks. 🫢


⭐ SEE ALSO ⭐

the full documentation for lou_checkyaml is maintained as a Texinfo manual. if the info and lou_checkyaml programs are properly installed at your site, the command

info liblouis

should give you access to the complete manual. that's the deep lore, go read it, it's giving textbook but in a good way πŸ“šβœ¨


heads up bestie: this page is from Liblouis 3.39.0, dated September 2026. slay, go test your YAML, and may all your exit codes be 0 πŸ’–πŸŽ€πŸ¦‹
πŸ“¦ where this page comes from