github.com/loggregator/cli@v6.33.1-0.20180224010324-82334f081791+incompatible/cf/help/template.go (about)

     1  package help
     2  
     3  import . "code.cloudfoundry.org/cli/cf/i18n"
     4  
     5  func GetHelpTemplate() string {
     6  	return `{{.Title "` + T("NAME:") + `"}}
     7     {{.Name}} - {{.Usage}}
     8  
     9  {{.Title "` + T("USAGE:") + `"}}
    10     ` + `{{.Name}} ` + T("[global options] command [arguments...] [command options]") + `
    11  
    12  {{.Title "` + T("VERSION:") + `"}}
    13     {{.Version}}
    14     {{range .Commands}}
    15  {{.SubTitle .Name}}{{range .CommandSubGroups}}
    16  {{range .}}   {{.Name}} {{.Description}}
    17  {{end}}{{end}}{{end}}
    18  {{.Title "` + T("ENVIRONMENT VARIABLES:") + `"}}
    19     CF_COLOR=false                     ` + T("Do not colorize output") + `
    20     CF_HOME=path/to/dir/               ` + T("Override path to default config directory") + `
    21     CF_DIAL_TIMEOUT=5                  ` + T("Max wait time to establish a connection, including name resolution, in seconds") + `
    22     CF_PLUGIN_HOME=path/to/dir/        ` + T("Override path to default plugin config directory") + `
    23     CF_STAGING_TIMEOUT=15              ` + T("Max wait time for buildpack staging, in minutes") + `
    24     CF_STARTUP_TIMEOUT=5               ` + T("Max wait time for app instance startup, in minutes") + `
    25     CF_TRACE=true                      ` + T("Print API request diagnostics to stdout") + `
    26     CF_TRACE=path/to/trace.log         ` + T("Append API request diagnostics to a log file") + `
    27     https_proxy=proxy.example.com:8080 ` + T("Enable HTTP proxying for API requests") + `
    28  
    29  {{.Title "` + T("GLOBAL OPTIONS:") + `"}}
    30     --help, -h                         ` + T("Show help") + `
    31     -v                                 ` + T("Print API request diagnostics to stdout") + `
    32  `
    33  }