help

package
v0.0.15 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 11, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package help implements the help builtin command.

help — display help for rshell features and commands

Usage: help [--all] [feature|command]

With no arguments, list rshell features with descriptions, a concise unsupported-feature summary, allowed commands, and a compact list of not-allowed commands. When --all is given, disabled commands are shown as a full description table. When a feature or command name is given, display detailed help for that topic.

Flags:

--all   show all commands (including not allowed) with descriptions

Exit codes:

0  Success (including when --help was requested).
1  Unknown topic.

Index

Constants

This section is empty.

Variables

View Source
var Cmd = builtins.Command{
	Name:        "help",
	Description: "display help for features and commands",
	MakeFlags:   registerFlags,
}

Cmd is the help builtin command descriptor.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL