help

Documentation

Overview

Package help - internal help handling code.

Index

• Variables
• func CommandList(commandMap map[string]string) string
• func Name(scriptName, name, description string) string
• func OptionList(args []SynopsisArg, options []*option.Option) string
• func Synopsis(scriptName, name string, args []SynopsisArg, options []*option.Option, ...) string
• type SynopsisArg

Variables

var Indentation = 4

Indentation - Number of spaces used for indentation.

Functions

func CommandList

func CommandList(commandMap map[string]string) string

CommandList - commandMap => name: description

func Name

func Name(scriptName, name, description string) string

Name -

func OptionList

func OptionList(args []SynopsisArg, options []*option.Option) string

OptionList - Return a formatted list of options and their descriptions.

func Synopsis

func Synopsis(scriptName, name string, args []SynopsisArg, options []*option.Option, commands []string) string

Synopsis - Return a default synopsis.

Types

type SynopsisArg

type SynopsisArg struct {
	Arg         string
	Description string
}