NAME

appjail-template — Template file specification

DESCRIPTION

A Template is a file that contains the jail(8) parameters used by a jail. Unlike jail.conf(5), this one is intended to be easily interpreted by both humans and computers.

However, since the jail(8) utility reads a jail.conf(5) file, appjail-config(1) has the ability to convert a Template to a valid jail.conf(5) file.

TOKENS

One or more words are separated by spaces. To use spaces in words, the word can be enclosed in single or double quotes. Single and double quotes can be escaped using a backslash character (‘\’). The backslash character followed by a character other than the quotation mark (depending on whether it is single or double) will write without escaping.

Example 1:

The string ‘"Hello, world" "Escaping \""’ will be tokenized as follows:

Hello, world
Escaping "

Example 2:

To escape a quote within a token, you must use the escape character followed by the same type of quote (i.e. single or double quotes). That's why the second token can't escape the quotes using a string such as
‘'\'' "\'"’:

'
\'

FORMAT

The Template is parsed line by line.
Comments and empty lines are ignored.
A comment is a trimmed line starting with #. You don't have to worry about trimming a line, AppJail will do it for you, internally of course.
Each non-ignored line is a parameter.
A parameter is made up of a key and a value separated by : or :+.
Parameters starting with * are required parameters.
How the required parameters are treated is entirely up to the consumer, but at least for appjail-start(1), it will not start the jail until the user sets values for the required parameters.
A key is made up of -, _, ., alphanumeric characters and spaces.
Spaces in keys are only valid for variables.
A variable is a key that begins with $ and can optionally be enclosed in curly braces.
How variables are treated is entirely up to the consumer, but at least for jail(8) they have special meaning. This is relevant when appjail-start(1) generates the jail.conf(5) file.
The value is optional.
The value will be tokenized following the rules specified in TOKENS.
The tokens obtained from the value are formally called columns.
More than one parameter can be specified and they are formally called rows.
The first row should be specified with : and subsequent rows with :+, but the first row can also be specified with :+.

AUTHORS

Jesús Daniel Colmenares Oviedo <DtxdF@disroot.org>