manual:config:items:item:key

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
manual:config:items:item:key [2014/09/30 12:54]
127.0.0.1 external edit
manual:config:items:item:key [2018/04/27 14:11]
natalja.cernohajeva Added additional explanation to "Parameter - unquoted string" section
Line 1: Line 1:
-==== - #1 Item key ==== +====1 Item key format ​=====
- +
-=== - Flexible and non-flexible parameters === +
- +
-A flexible parameter is a parameter which accepts an argument. For example, in vfs.fs.size[*] the asterisk symbol '​*'​ indicates a flexible parameter. +
-'​*'​ is any string that will be passed as an argument to the parameter. Correct definition examples: +
-  * vfs.fs.size[/​] +
-  * vfs.fs.size[/​opt] +
- +
-=== - Key format ​===+
  
 Item key format, including key parameters, must follow syntax rules. The following illustrations depict the supported syntax. Allowed elements and characters at each point can be determined by following the arrows - if some block can be reached through the line, it is allowed, if not - it is not allowed. Item key format, including key parameters, must follow syntax rules. The following illustrations depict the supported syntax. Allowed elements and characters at each point can be determined by following the arrows - if some block can be reached through the line, it is allowed, if not - it is not allowed.
  
-{{manual:​config:​item_key.png|}}+{{manual:​config:​item_key_2.png?600|}}
  
 To construct a valid item key, one starts with specifying the key name, then there'​s a choice to either have parameters or not - as depicted by the two lines that could be followed. To construct a valid item key, one starts with specifying the key name, then there'​s a choice to either have parameters or not - as depicted by the two lines that could be followed.
Line 47: Line 38:
  
 {{manual:​config:​key_param_quoted_string.png|}} {{manual:​config:​key_param_quoted_string.png|}}
 +
 +<note warning>​To quote item key parameters, use double quotes only. Single quotes are not supported.</​note>​
  
 **Parameter - unquoted string** **Parameter - unquoted string**
  
-If the key parameter is an unquoted string, any Unicode character is allowed except comma and right square bracket (]).+If the key parameter is an unquoted string, any Unicode character is allowed except comma and right square bracket (]). Unquoted parameter cannot start with left square bracket ([).
  
 {{manual:​config:​key_param_unquoted_string.png|}} {{manual:​config:​key_param_unquoted_string.png|}}
Line 59: Line 52:
  
 {{manual:​config:​key_param_array.png|}} {{manual:​config:​key_param_array.png|}}
- 
-=== - Available encodings === 
- 
-The parameter "​encoding"​ is used to specify encoding for processing corresponding item checks, so that data acquired will not be corrupted. For a list of supported encodings (code page identifiers),​ please consult respective documentation,​ such as documentation for [[http://​www.gnu.org/​software/​libiconv/​|libiconv]] (GNU Project) or Microsoft Windows SDK documentation for "Code Page Identifiers"​. If an empty "​encoding"​ parameter is passed, then ANSI with system-specific extension (Windows) or UTF-8 (default locale for newer Unix/Linux distributions,​ see your system'​s settings) is used by default.