aboutsummaryrefslogtreecommitdiff
path: root/vconsole.conf.5.txt
diff options
context:
space:
mode:
Diffstat (limited to 'vconsole.conf.5.txt')
-rw-r--r--vconsole.conf.5.txt61
1 files changed, 61 insertions, 0 deletions
diff --git a/vconsole.conf.5.txt b/vconsole.conf.5.txt
new file mode 100644
index 0000000..956ca6a
--- /dev/null
+++ b/vconsole.conf.5.txt
@@ -0,0 +1,61 @@
+/////
+vim:set ts=4 sw=4 syntax=asciidoc noet:
+/////
+vconsole.conf(5)
+================
+
+NAME
+----
+vconsole.conf - configuration file for the virtual console
+
+SYNOPSIS
+--------
+*/etc/vconsole.conf*
+
+DESCRIPTION
+-----------
+
+The /etc/vconsole.conf file configures the virtual console, i.e. keyboard mapping and console font.
+
+The basic file format of the vconsole.conf is a newline-separated list environment-like shell-compatible variable assignments. It is
+possible to source the configuration from shell scripts, however, beyond mere variable assignments no shell features are supported,
+allowing applications to read the file without implementing a shell compatible execution engine.
+
+In Arch /etc/rc.conf is also checked for vconsole configuration as well, however only as fallback, as described below.
+
+OPTIONS
+-------
+
+The following options are understood:
+
+*KEYMAP=*
+//, KEYMAP_TOGGLE=
+//The KEYMAP_TOGGLE= can be used to configured a second toggle keymap and is by default unset.
+// KEYMAP= defaults to us if not set.
+
+ Configures the key mapping table of for they keyboard. Overriding KEYMAP from rc.conf.
+
+*FONT=*, *FONT_MAP=*
+//, FONT_UNIMAP=
+// the unicode font map
+// FONT= defaults to latarcyrheb-sun16.
+
+ Configures the console font and the console map. Overriding respectively CONSOLEFONT and CONSOLEMAP from rc.conf.
+
+EXAMPLE
+-------
+*Example 1. German keyboard and console*
+
+/etc/vconsole.conf:
+
+ KEYMAP=de-latin1
+ FONT=latarcyrheb-sun16
+
+SEE ALSO
+--------
+
+systemd.vconsole.conf(5), loadkeys(1), setfont(8), rc.conf(5)
+
+AUTHORS
+-------
+Original by Lennart Poettering, adapted to Arch Linux by Tom Gundersen.