precice-tools(1)

💖 NAME 💖

okay so this is precice-tools, the command line utility for preCICE, and she's hanging out in the General Commands Manual — main character energy for your terminal, fr fr. If you need config references, DTDs, markdown docs, version info, or a config vibe check, she's got you 🫶.

✨ SYNOPSIS ✨

precice-tools xml | dtd | md | [ version | --version ] | check file
[participant [size]]

🎀 OPTIONS 🎀

• xml — prints the configuration reference as XML with inlined help to the standard output. Obsessed with getting the whole reference right there in your terminal ✨.
• dtd — prints the DTD file to the standard output, which may be used to check XML configuration files. DTD bestie has entered the chat 💅.
• md — prints the configuration reference as markdown to the standard output. Markdown girlies, this one is literally for you 🎀.
• version | --version — prints the preCICE version string (precice::getVersionInformation()) to the standard output. Keeping that function name exact because iykyk 🔥.
• check file [participant [size]] — checks given preCICE configuration file and prints any errors. Pass the name of a participant to fully check its configuration. The optional size indicates how many ranks run in parallel, which checks custom <intra-comm: ... /> tags. Vibe check your config, no cap 🌈.

🔥 EXIT STATUS 🔥

precice-tools returns a zero exit status if it succeeds to run the provided command. Non zero is returned in case of failure. So bestie: zero is slay, nonzero is the config said no 😭.

🌸 SEE ALSO 🌸

• precice-version(1)
• precice-config-validate(1)
• precice-config-doc(1)
• precice.org - the website of the project

and that's the precice-tools(1) manual page signing off, General Commands Manual style 🫶💖✨