Ecasound Interactive Mode Help Command Guide

Ecasound's Interactive Mode (EIAM) includes an integrated help subsystem that allows users to query documentation for individual commands directly from the terminal prompt. This guide explains how to access, read, and utilize the built-in documentation in Ecasound without needing to consult external manual pages during an active session.

Accessing Interactive Mode

To access the help system, you must first start Ecasound in interactive mode by appending the -c flag to the command line:

ecasound -c

Once launched, you are presented with the interactive prompt (ecasound ('h' for help) >), where you can enter help queries directly.

Querying Help for Specific Commands

To view detailed documentation for any specific command, pass the command name as an argument to the help or h command:

help <command-name>

or using the shorthand:

h <command-name>

For example, to view the syntax and operational details of the chain setup command cs-add, enter:

help cs-add

Understanding the Command Help Output

When you request help for a specific command, Ecasound returns a concise reference block containing three main elements:

  1. Command Signature: Shows the exact command name and shorthand alias (if available).
  2. Parameters and Types: Lists any required or optional arguments alongside their expected data types (such as strings, integers, or floating-point values).
  3. Description: Provides a brief summary of what the command does, how it affects the audio engine or chain setup, and relevant return values.

For example, querying an engine command such as engine-status outputs:

- 'engine-status', 'es':
    Returns current engine status.
    Format: 'engine-status'

Discovering Available Commands

If you do not know the exact command name to query, Ecasound provides two methods to discover valid keywords: