help

package
v1.9.0 Latest Latest
Warning

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

Go to latest
Published: Jul 3, 2025 License: GPL-3.0 Imports: 12 Imported by: 0

Documentation

Overview

Package help manages usage information

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Usage

func Usage(verbose bool, exe string) ([]string, error)

Usage return usage information

Types

type Documentation

type Documentation struct {
	Executable         string
	MoveCommand        string
	RemoveCommand      string
	ReKeyCommand       string
	CompletionsCommand string
	CompletionsEnv     string
	HelpCommand        string
	HelpConfigCommand  string
	NoColor            string
	ReadOnlyCommands   string
	Config             struct {
		Env  string
		Home string
		XDG  string
	}
	ReKey struct {
		KeyFile string
		NoKey   string
	}
	Database struct {
		Fields   string
		Examples string
	}
}

Documentation is how documentation segments are templated

Jump to

Keyboard shortcuts

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