packages feed

opt-env-conf-test-0.0.0.0: test_resources/docs/greet/man.txt

.Dd $Mdocdate$
.Dt greet 1
.Os
.Sh NAME
.Nm greet
.Nd hello world example
.Sh VERSION
0.0.0
.Sh SYNOPSIS
greet (-h|--help) | --version | (--config-file FILE_PATH -g|--greeting GREETING SUBJECT -p|--polite)
.Sh SETTINGS
  Show this help text
  switch: -h|--help

  Output version information: 0.0.0
  switch: --version

  Path to the configuration file
  option: --config-file FILE_PATH
  env: GREET_CONFIG_FILE FILE_PATH
  
  Greeting to use
  option: -g|--greeting GREETING
  env: GREET_GREETING GREETING
  config:
    greeting: # or null
      <string>
  
  Who to greet
  argument: SUBJECT
  
  Whether to be polite
  switch: -p|--polite
  env: GREET_POLITE ANY
  config:
    polite: # or null
      <boolean>
  

.Sh OPTIONS
  -h|--help     Show this help text                               
  --version     Output version information: 0.0.0                 
  --config-file Path to the configuration file                    
  -g|--greeting Greeting to use                   default: "Hello"
  SUBJECT       Who to greet                      default: "world"
  -p|--polite   Whether to be polite              default: False  

.Sh ENVIRONMENT VARIABLES
  GREET_CONFIG_FILE FILE_PATH   Path to the configuration file
  GREET_GREETING GREETING       Greeting to use               
  GREET_POLITE ANY              Whether to be polite          

.Sh CONFIGURATION VALUES
  Greeting to use
  greeting:
    # or null
    <string>
  Whether to be polite
  polite:
    # or null
    <boolean>