Module help 

Help system for the interpreter prompt.

This module provides help text and usage information for interpreter commands and Tor control protocol commands.

Overview

The help system provides documentation for:

• Interpreter commands (/help, /events, /info, /python, /quit)
• Tor control commands (GETINFO, GETCONF, SETCONF, SIGNAL, etc.)

For some commands (like GETINFO and GETCONF), the help system queries Tor to provide a complete list of available options.

Usage

Help is accessed via the /help interpreter command:

/help           # General help overview
/help GETINFO   # Help for GETINFO command
/help signal    # Help for SIGNAL command (case-insensitive)

Example

use stem_rs::Controller;
use stem_rs::interpreter::help;

let mut controller = Controller::from_port("127.0.0.1:9051".parse()?).await?;
controller.authenticate(None).await?;

// Get general help
let general = help::response(&mut controller, "").await;
println!("{}", general);

// Get help for a specific command
let signal_help = help::response(&mut controller, "SIGNAL").await;
println!("{}", signal_help);

Python Stem Equivalent

This module corresponds to Python Stem’s stem.interpreter.help module.

Functions

response

Returns help text for the given topic.