Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SHTK_CONFIG_OVERRID... FreeBSD Library Functions Manual	SHTK_CONFIG_OVERRID...

NAME
     shtk_config_override -- Records an	override to be applied to the configu-
     ration

LIBRARY
     shtk_import config

SYNOPSIS
     shtk_config_override override

DESCRIPTION
     The shtk_config_override function records the override given in override,
     which must	have the form `variable=value'.

     Overrides are values given	to configuration variables that	can be set
     before the	configuration file is loaded with shtk_config_load(3).	This
     feature is	useful to support parsing all command line flags before	at-
     tempting to load the configuration	file, as the script should first vali-
     date all user input before	performing any action.

EXAMPLES
     This code snippet illustrates a program with a configuration file that
     supports a	VERBOSE	variable and that, for convenience reasons, can	be
     overriden via the command line using the -v flag:

	   shtk_config_init VERBOSE

	   local OPTIND
	   while getopts ':v' arg "${@}"; do
	       case "${arg}" in
		   v)  # Enable	verbose	mode.
		       shtk_config_override VERBOSE=yes
		       ;;
		   \?)
		       shtk_cli_usage_error "Unknown option -${OPTARG}"
		       ;;
	       esac
	   done
	   shift $((${OPTIND} -	1))

	   shtk_config_set VERBOSE no  # Set the default value.
	   shtk_config_load "/etc/my_program.conf"

SEE ALSO
     shtk(3), shtk_config(3)

HISTORY
     shtk_config_override first	appeared in shtk 1.0.

FreeBSD	13.0		       November	6, 2014			  FreeBSD 13.0

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | EXAMPLES | SEE ALSO | HISTORY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=shtk_config_override&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help