Skip to main content

Module help

Module help 

Source
Expand description

Help and Usage Information Module

This module provides help and usage information for the Torrust Tracker Deployer application. It contains functions to display helpful information to users when they need guidance on how to use the application.

§Design Principles

  • Independent: No dependencies on presentation layer or CLI structures
  • User-Focused: Clear, actionable guidance for users
  • Comprehensive: Covers getting started, examples, and next steps

Functions§

display_getting_started
Display helpful information to the user when no command is provided
display_troubleshooting
Display troubleshooting information for common issues