VOTCA_HELP2DOC(1)

📦 version 2022.1, in debian bookworm

💖 NAME 💖

okay so bestie, meet votca_help2doc — it's part of the VOTCA package. that's the whole name section, slay, we move.

✨ SYNOPSIS ✨

votca_help2doc [OPTIONS]

votca_help2doc [--help]

like, that's it. that's the whole summoning ritual. 🕯️

🦋 DESCRIPTION 🦋

ngl this one is such a little utility goblin and i'm obsessed with it. votca_help2doc takes a Votca CLI's help message and converts it into either RST or GROFF format. that's the vibe. documentation glow-up, no cap. 📝✨

🎀 OPTIONS 🎀

the option list, aka the main characters:

  • -h, --help — shows this help message and then dips, exit stage left. 👋
  • -n NAME, --name NAME — the name of the tool you want to extract the help message from. you gotta tell it who. 🕵️♀️
  • -o OUT, --out OUT — the output file. where the magic lands. 💾
  • -f {rst,groff}, --format {rst,groff} — the output format. and bestie, it's literally just those two options: rst or groff. pick your fighter. 🥊
  • --version — shows the program's version number and then bounces. 🏷️

👑 AUTHORS 👑

written and maintained by the VOTCA Development Team <devs@votca.org> — kings, honestly. 🫶

Copyright 2009-2021 The VOTCA Development Team (http://www.votca.org)

licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. you may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. see the License for the specific language governing permissions and limitations under the License. 🫡

and that's the whole page, bestie!! this was the votca_help2doc User Manual, brought to you by the VOTCA Development Team, filed under VOTCA_HELP2DOC(1). go forth and convert those help messages 💅💖🧚

📦 where this page comes from