index.rst 817 B

1234567891011121314151617181920212223242526272829303132
  1. :py:mod:`qubes.tools` -- Command line utilities
  2. ===============================================
  3. Those are Python modules that house actual functionality of CLI tools -- the
  4. files installed in :file:`/usr/bin` only import these modules and run ``main()``
  5. function.
  6. The modules should make available for import theirs command line parsers
  7. (instances of :py:class:`argparse.ArgumentParser`) as either ``.parser``
  8. attribute or function ``get_parser()``, which returns parser. Manual page will
  9. be automatically checked during generation if its "Options" section contains all
  10. options from this parser (and only those).
  11. Module contents
  12. ---------------
  13. .. automodule:: qubes.tools
  14. :members:
  15. :show-inheritance:
  16. All CLI tools
  17. -------------
  18. .. toctree::
  19. :maxdepth: 1
  20. :glob:
  21. *
  22. .. vim: ts=3 sw=3 et tw=80