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

FreeBSD Manual Pages

  
 
  

home | help 
APPJAIL-CONFIG(1)	     General Commands Manual	       APPJAIL-CONFIG(1)

NAME
     appjail-config -- Configuration utiliy for templates

SYNOPSIS
     appjail-config check [-qV] [-j jail|-t template]
     appjail-config edit [-j jail|-t template]
     appjail-config del [-iPV] [-r row] [-j jail|-t template] parameter
     appjail-config delAll [-j jail|-t template]
     appjail-config delColumn [-iPV] [-c column] [-r row] [-j jail|-t template]
		    parameter
     appjail-config get [-CiPV] [-N|-n] [-r row] [-j jail|-t template] parameter
     appjail-config getAll [-R|-r] [-j jail|-t template]
     appjail-config getColumn [-CiPpV] [-c column] [-r row]
		    [-j jail|-t template] parameter
     appjail-config help [command]
     appjail-config jailConf [-n name] [-o output] -j jail
     appjail-config jailConf [-o output] -n name -t template
     appjail-config set [-IV] [-A [0|1]] [-R [0|1]] [-r row]
		    [-j jail|-t template] parameter[=value]
     appjail-config setColumn [-AV] [-c column] [-r row] [-j jail|-t template]
		    parameter[=value]
     appjail-config usage command

DESCRIPTION
     The  appjail-config  utility  adds,  deletes,  gets,  checks  parameters or
     columns, or basically manipulates a template from command-line, very useful
     for scripting.

     The options are as follows:

     check [-qV] [-j jail|-t template]
	  Check for invalid parameters, template syntax and  other  related  is-
	  sues.

	  -q  If there is an error, a non-zero value is returned.

	  -V  Do  not  validate if the template's parameters are valid against a
	      list extracted from jail(8).

	  [-j jail|-t template]
	      Use the jail's template (-j) or the specified template (-t) .

     edit [-j jail|-t template]
	  The program specified by the EDITOR environment variable  is	open  to
	  edit the template.

	  [-j jail|-t template]
	      Use the jail's template (-j) or the specified template (-t) .

     del [-iPV] [-r row] [-j jail|-t template] parameter
	  Delete parameter .

	  -i  Ignore unknown parameters.

	  -P  Delete  all  matching  rows, not just one. The -r parameter is ig-
	      nored.

	  -V  Do not validate if parameter is valid  against  a  list  extracted
	      from jail(8) nor validate if parameter is a correct variable.

	  -r row
	      Limit matching with row .  The default is 0.

	  [-j jail|-t template]
	      Use the jail's template (-j) or the specified template (-t) .

     delAll [-j jail|-t template]
	  Delete all parameters.

	  [-j jail|-t template]
	      Use the jail's template (-j) or the specified template (-t) .

     delColumn [-iPV] [-c column] [-r row] [-j jail|-t template] parameter
	  Delete the parameter's column .

	  -i  Ignore unknown parameters, as well as columns.

	  -P  Delete  all  matching  rows, not just one. The -r parameter is ig-
	      nored.

	  -V  Do not validate if parameter is valid  against  a  list  extracted
	      from jail(8) nor validate if parameter is a correct variable.

	  -c column
	      Limit matching with column .  The default is 0.

	  -r row
	      Limit matching with row .  The default is 0.

	  [-j jail|-t template]
	      Use the jail's template (-j) or the specified template (-t) .

     get [-CiPV] [-N|-n] [-r row] [-j jail] [-j jail|-t template] parameter
	  Get the parameter's value

	  -C  Returns  0 if parameter exists, otherwise, a non-zero value is re-
	      turned.

	  -i  Ignore unknown parameters.

	  -P  Dump all matching rows, not just one. The -r parameter is ignored.

	  -V  Do not validate if parameter is valid  against  a  list  extracted
	      from jail(8) nor validate if parameter is a correct variable.

	  [-N|-n]
	      Dump only the parameters (-N) or the values (-n) .

	  [-r row]
	      Limit matching with row .  The default is 0.

	  [-j jail|-t template]
	      Use the jail's template (-j) or the specified template (-t) .

     getAll [-R|-r] [-j jail|-t template]
	  Delete all parameters.

	  [-R|-r]
	      Show  (-r)  only	the  required  parameters  or  return  (-R) 0 if
	      template has required parameters.

	  [-j jail|-t template]
	      Use the jail's template (-j) or the specified template (-t) .

     getColumn [-CiPpV] [-c column] [-r row] [-j jail|-t template] parameter
	  Get column's value from parameter .

	  -C  Returns 0 if parameter and column exists,  otherwise,  a	non-zero
	      value is returned.

	  -i  Ignore unknown parameters, as well as columns.

	  -P  Dump all matching rows, not just one. The -r parameter is ignored.

	  -p  Dump  all  matching columns, not just one. The -c parameter is ig-
	      nored.

	  -V  Do not validate if parameter is valid  against  a  list  extracted
	      from jail(8) nor validate if parameter is a correct variable.

	  -c column
	      Limit matching with column .  The default is 0.

	  -r row
	      Limit matching with row .  The default is 0.

	  [-j jail|-t template]
	      Use the jail's template (-j) or the specified template (-t) .

     help [command]
	  List	commands  with a brief description and, if command is specified,
	  display help information.

     jailConf [-n name] [-o output] -j jail | jailConf [-o output]  -n	name  -t
	  template
	  Convert a template to a jail.conf(5) file.

	  -n name
	      Jail name.

	      Optional if -j is specified.

	  -o output
	      Output file.  stdout (default) is used if output is -.

	  [-j jail|-t template]
	      Use the jail's template (-j) or the specified template (-t) .

     set   [-IV]   [-A	 [0|1]]  [-R  [0|1]]  [-r  row]  [-j  jail|-t  template]
	  parameter[=value]
	  Update a value of an existing parameter or create a new one.

	  -I  Insert parameter as a new row ignoring the -r parameter.

	  -V  Do not validate if parameter is valid  against  a  list  extracted
	      from jail(8) nor validate if parameter is a correct variable.

	  -A [0|1]
	      If  1,  mark  parameter  as  an  append parameter (+:) , otherwise
	      parameter is unmarked.

	  -R [0|1]
	      If 1, mark parameter as a required parameter, otherwise  parameter
	      is unmarked.

	  -r row
	      Limit matching with row .

	  [-j jail|-t template]
	      Use the jail's template (-j) or the specified template (-t) .

     setColumn	[-AV]  [-c  column]  [-r  row]	[-j  jail|-t template] parameter
	  [=value]
	  Update a column's value in a parameter or create a new one.

	  -A  Append value as a new column in parameter with row .
	      The -c parameter is ignored.

	  -V  Do not validate if parameter is valid  against  a  list  extracted
	      from jail(8) nor validate if parameter is a correct variable.

	  -c column
	      Limit matching with column .

	  -r row
	      Limit matching with row .

	  [-j jail|-t template]
	      Use the jail's template (-j) or the specified template (-t) .

     usage command
	  Show the syntax of a given command.

EXIT STATUS
     The appjail-config utility exits 0 on success, and >0 if an error occurs.

SEE ALSO
     sysexits(3) appjail-template(5)

AUTHORS
     JesAos Daniel Colmenares Oviedo <DtxdF@disroot.org>

FreeBSD ports 15.quarterly	  April 7, 2024 	       APPJAIL-CONFIG(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=appjail-config&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help