summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2020-10-21 17:26:48 +0200
committerLudovic Courtès <ludo@gnu.org>2020-10-21 19:19:34 +0200
commit2c9f6ff2ae51e024ecf6b2338c924b3a2028b302 (patch)
tree1e7e6d083e2273af7719dd55d4654704bd062ad0 /doc
parent004a9455f9fccfdd9a9af3d3312e6d0d2779d6a8 (diff)
downloadguix-2c9f6ff2ae51e024ecf6b2338c924b3a2028b302.tar.gz
doc: Add an entry for the 'keyboard-layout' procedure.
* doc/guix.texi (Keyboard Layout): Add @deffn entry for
'keyboard-layout'.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 5116de5e8c..982b82e17f 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -13726,7 +13726,18 @@ the X Keyboard extension (XKB), each layout has four attributes: a name (often
 a language code such as ``fi'' for Finnish or ``jp'' for Japanese), an
 optional variant name, an optional keyboard model name, and a possibly empty
 list of additional options.  In most cases the layout name is all you care
-about.  Here are a few example:
+about.
+
+@deffn {Scheme Procedure} keyboard-layout @var{name} [@var{variant}] @
+                [#:model] [#:options '()]
+Return a new keyboard layout with the given @var{name} and @var{variant}.
+
+@var{name} must be a string such as @code{"fr"}; @var{variant} must be a
+string such as @code{"bepo"} or @code{"nodeadkeys"}.  See the
+@code{xkeyboard-config} package for valid options.
+@end deffn
+
+Here are a few examples:
 
 @lisp
 ;; The German QWERTZ layout.  Here we assume a standard