diff options
author | Ran Benita <ran@unusedvar.com> | 2020-01-18 23:06:58 +0200 |
---|---|---|
committer | Ran Benita <ran@unusedvar.com> | 2020-01-18 23:06:58 +0200 |
commit | 517464eb7ad584fb387b95bccf2b22ec6f3e87af (patch) | |
tree | 13dd36b737976b593f527cbd4ddb22af89214210 /doc | |
parent | 335ebcadd4701d6a138b31c7f193db3bd26c8cde (diff) | |
download | xorg-lib-libxkbcommon-517464eb7ad584fb387b95bccf2b22ec6f3e87af.tar.gz |
doc/rules-format.txt: document include support
Signed-off-by: Ran Benita <ran@unusedvar.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/rules-format.txt | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/rules-format.txt b/doc/rules-format.txt index e8959fd..d97d8e8 100644 --- a/doc/rules-format.txt +++ b/doc/rules-format.txt @@ -40,7 +40,9 @@ Grammar (It might be helpful to look at a file like rules/evdev along with this grammer. Comments, whitespace, etc. are not shown.) -File ::= { "!" (Group | RuleSet) } +File ::= { "!" (Include | Group | RuleSet) } + +Include ::= "include" <ident> Group ::= GroupName "=" { GroupElement } "\n" GroupName ::= "$"<ident> @@ -59,6 +61,18 @@ KccgstValue ::= <ident> Notes: +- Include processes the rules in the file path specified in the ident, + in order. %-expanasion is performed, as follows: + + %%: + A literal %. + + %H: + The value of the HOME environment variable. + + %S: + The system-installed rules directory (usually /usr/share/X11/xkb/rules). + - The order of values in a Rule must be the same as the Mapping it follows. The mapping line determines the meaning of the values in the rules which follow in the RuleSet. |