package zli2

import "zgo.at/elles/zli2"

Index ¶

• type Flag
• type Section
• type Usage
• func MustParse(s string) Usage
• func Parse(s string) (Usage, error)
• func (u Usage) CompleteBash() string
• func (u Usage) CompleteFish() string
• func (u Usage) CompleteZsh(name, site string) string
• func (u Usage) Flag(name string) (string, bool)
• func (u Usage) Mandoc(name string, sect int) string
• func (u Usage) Section(name string) (string, bool)
• func (u Usage) String() string

Types ¶

type Flag ¶

type Flag struct {
	Names []string
	Text  string
	Line  int
}

type Section ¶

type Section struct {
	Title string
	Text  string
	Line  int
	Flags []Flag
}

type Usage ¶

type Usage struct {
	Intro    string
	Sections []Section
	// contains filtered or unexported fields
}

func MustParse ¶

func MustParse(s string) Usage

func Parse ¶

func Parse(s string) (Usage, error)

func (Usage) CompleteBash ¶

func (u Usage) CompleteBash() string

TODO

func (Usage) CompleteFish ¶

func (u Usage) CompleteFish() string

TODO

func (Usage) CompleteZsh ¶

func (u Usage) CompleteZsh(name, site string) string

TODO: finish; to really get something decent we need at least:

- A short description for flags. - Annotate which flags conflict. - Know if _files is correct. - Flags that can be doubled (-ll).

And also:

- Flags that take arguments, and what kind. - Positional arguments.

func (Usage) Flag ¶

func (u Usage) Flag(name string) (string, bool)

flag gets documentation for the flag.

func (Usage) Mandoc ¶

func (u Usage) Mandoc(name string, sect int) string

func (Usage) Section ¶

func (u Usage) Section(name string) (string, bool)

Section gets documentation for the section.

func (Usage) String ¶

func (u Usage) String() string

Should print back the original.

Source Files ¶

usagep.go