civodul pushed a commit to branch master
in repository guix.
commit 2c9f6ff2ae51e024ecf6b2338c924b3a2028b302
Author: Ludovic Courtès <[email protected]>
AuthorDate: Wed Oct 21 17:26:48 2020 +0200
doc: Add an entry for the 'keyboard-layout' procedure.
* doc/guix.texi (Keyboard Layout): Add @deffn entry for
'keyboard-layout'.
---
doc/guix.texi | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index 5116de5..982b82e 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