doc

Documentation

Index

• Constants
• Variables

Constants

const AdditionalHelpTopics = "AdditionalHelpTopics"

AdditionalHelpTopics is documented as part of the non-internal class

const Aliases = "Aliases"

Aliases is documented as part of the non-internal class

const AvailableCommands = "AvailableCommands"

AvailableCommands is documented as part of the non-internal class

const BaseDelimiter = "------ DELIMITER:BASE ------"

BaseDelimiter is documented as part of the non-internal class

const CfgForce = "CfgForce"

CfgForce is documented as part of the non-internal class

const CfgLocation = "CfgLocation"

CfgLocation is documented as part of the non-internal class

const CmdFlags = "CmdFlags"

CmdFlags is documented as part of the non-internal class

const CmdlineDelimiter = "------ DELIMITER:COMMANDLINE ------"

CmdlineDelimiter is documented as part of the non-internal class

const ConfFile = "ConfFile"

ConfFile is documented as part of the non-internal class

const ConfigCmd = "config"

ConfigCmd is documented as part of the non-internal class

const ConfigDelimiter = "------ DELIMITER:CONFIG ------"

ConfigDelimiter is documented as part of the non-internal class

const ConfigDisplayCmd = "config>display"

ConfigDisplayCmd is documented as part of the non-internal class

const ConfigEnvCmd = "config>env"

ConfigEnvCmd is documented as part of the non-internal class

const ConfigEnvMsg1 = "ConfigEnvMsg1"

ConfigEnvMsg1 is documented as part of the non-internal class

const ConfigEnvMsg2 = "ConfigEnvMsg2"

ConfigEnvMsg2 is documented as part of the non-internal class

const ConfigEnvMsg3 = "ConfigEnvMsg3"

ConfigEnvMsg3 is documented as part of the non-internal class

const ConfigHeader = "."

ConfigHeader is documented as part of the non-internal class

const ConfigInitCmd = "config>init"

ConfigInitCmd is documented as part of the non-internal class

const CustomDelimiter = "------ DELIMITER:CUSTOM ------"

CustomDelimiter is documented as part of the non-internal class

const DoTrace = "DoTrace"

DoTrace is documented as part of the non-internal class

const Example = "Example"

Example is documented as part of the non-internal class

const Examples = "Examples"

Examples is documented as part of the non-internal class

const Flags = "Flags"

Flags is documented as part of the non-internal class

const GlobalFlags = "GlobalFlags"

GlobalFlags is documented as part of the non-internal class

const HelpCmd = "help"

HelpCmd is documented as part of the non-internal class

const HelpDelimiter = "------ DELIMITER:HELP ------"

HelpDelimiter is documented as part of the non-internal class

const HelpFlag = "HelpFlag"

HelpFlag is documented as part of the non-internal class

const LogFile = "LogFile"

LogFile is documented as part of the non-internal class

const LogLevel = "LogLevel"

LogLevel is documented as part of the non-internal class

const Long = "Long"

Long is documented as part of the non-internal class

const NoCfg = "NoCfg"

NoEnv is documented as part of the non-internal class

const NoEnv = "NoEnv"

NoEnv is documented as part of the non-internal class

const Pretty = "Pretty"

Pretty is documented as part of the non-internal class

const ProvidesMoreInformationAboutACommand = "ProvidesMoreInformationAboutACommand"

ProvidesMoreInformationAboutACommand is documented as part of the non-internal class

const Short = "Short"

Short is documented as part of the non-internal class

const Usage = "Usage"

Usage is documented as part of the non-internal class

const UsageDelimiter = "------ DELIMITER:USAGE ------"

UsageDelimiter is documented as part of the non-internal class

const Use = "Use"

Use is documented as part of the non-internal class

const Verbosity = "Verbosity"

Verbosity is documented as part of the non-internal class

const VersionCmd = "version"

VersionCmd is documented as part of the non-internal class

Variables

var DefaultDocs = map[string][]string{
	"en": english,
	"it": italian,
}

DefaultDocs contains all the supported languages as a map of string lists following this format. As a library user one can decide to use this format, and call greenery.ConvertDocs, or write a DocSet directly.

------ HELP ------ help variable name, translated help text, ..... ------ USAGE ------ command name, short translated help text, long translated help text command name, short translated,long translated ... ------ COMMANDLINE ------ config struct variable name, translated variable commandline help text ..... ------ CONFIG ------ config block, config block help ..... config struct variable name, translated variable config file help text .....

This will be processed once the program starts into internal structs, it will panic if not successful so it should be easy to test.