qm-help

Display help for a specific command

$ qm [[h|help]] [command]

$ qm [[h|help]] [command] --verbose [true|false]

qm-help [section] topic
qm-help topic

topic
    The specific Qmail-related command, configuration file, concept, or utility for which documentation is sought (e.g., qmail-send, control-files).

section
    An optional numerical or descriptive section of the manual to search within (e.g., 1 for general commands, 5 for file formats, 8 for system administration). This helps to narrow down the search if multiple entries exist for the same topic across different manual sections.

The qm-help command is a specialized utility within the Qmail mail transfer agent (MTA) suite, designed to provide convenient access to its extensive documentation. Rather than being a general system-wide help tool, it focuses exclusively on Qmail-related topics, including commands, configuration files, administration procedures, and conceptual information. It functions much like a tailored man command, allowing users to quickly look up detailed information pertinent to Qmail's operation. Users can specify a particular topic (e.g., qmail-send, qmail-smtpd, control-files) or even a specific manual section along with the topic, similar to how standard man pages are categorized (e.g., section 1 for user commands, section 5 for file formats, section 8 for system administration commands). This integration simplifies the process of understanding and troubleshooting Qmail components by centralizing its documentation.

The qm-help command is specific to installations of the Qmail mail transfer agent. It will not be available or functional on systems that do not have Qmail installed. The quality and completeness of the displayed documentation depend entirely on the Qmail package and its associated documentation files present on the system. It is not a substitute for general Linux command documentation or other system utilities.

While conceptually similar to the standard man command, qm-help is pre-configured to search paths specific to Qmail's documentation. This streamlines the process of finding Qmail-specific man pages without needing to explicitly specify paths or rely on a globally indexed system that might not always prioritize Qmail documentation. It's especially useful for administrators managing Qmail installations who need quick access to component-specific details.

The qm-help command is an integral part of the Qmail suite, a mail transfer agent created by Daniel J. Bernstein (DJB) in the mid-1990s. Qmail gained significant popularity for its focus on security, reliability, and modular design, often cited as a more secure alternative to Sendmail at the time. qm-help was developed alongside the main Qmail components to provide readily accessible, integrated documentation, making it easier for administrators and users to navigate the specifics of Qmail's architecture and configuration. Its design reflects DJB's philosophy of providing complete and well-structured documentation alongside software.

man(1), qmail-send(8), qmail-smtpd(8), qmail-queue(8)