Debian Codegraph @

upstream/mageia-cauldron/man5/vconsole.conf.5

raw
1 '\" t
2 .TH "VCONSOLE\&.CONF" "5" "" "systemd 258.7" "vconsole.conf"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 vconsole.conf \- Configuration file for the virtual console
24 .SH "SYNOPSIS"
25 .PP
26 /etc/vconsole\&.conf
27 .SH "DESCRIPTION"
28 .PP
29 The
30 /etc/vconsole\&.conf
31 file configures the virtual console, i\&.e\&. keyboard mapping and console font\&. It is applied at boot by udev using
32 90\-vconsole\&.rules
33 file\&. You can safely mask this file if you want to avoid this kind of initialization\&.
34 .PP
35 The format of
36 vconsole\&.conf
37 is a newline\-separated list of environment\-like shell\-compatible variable assignments, ignoring comments and empty lines\&. 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\&. See
38 \fBos-release\fR(5)
39 for a detailed description of the format\&.
40 .PP
41 Note that the kernel command line options
42 \fIvconsole\&.keymap=\fR,
43 \fIvconsole\&.keymap_toggle=\fR,
44 \fIvconsole\&.font=\fR,
45 \fIvconsole\&.font_map=\fR,
46 \fIvconsole\&.font_unimap=\fR
47 may be used to override the console settings at boot\&.
48 .PP
49 Depending on the operating system other configuration files might be checked for configuration of the virtual console as well, however only as fallback\&.
50 .PP
51 /etc/vconsole\&.conf
52 is usually created and updated using
53 \fBsystemd-localed.service\fR(8)\&.
54 \fBlocalectl\fR(1)
55 may be used to instruct
56 \fBsystemd\-localed\&.service\fR
57 to query or update configuration\&.
58 .SH "OPTIONS"
59 .PP
60 The following options are understood:
61 .PP
62 \fIKEYMAP=\fR, \fIKEYMAP_TOGGLE=\fR
63 .RS 4
64 Configures the key mapping table for the keyboard\&.
65 \fIKEYMAP=\fR
66 defaults to
67 "us"
68 if not set\&. Specially, if
69 "@kernel"
70 is specified, no keymap will be loaded, i\&.e\&. the kernel\*(Aqs default keymap is used\&. The
71 \fIKEYMAP_TOGGLE=\fR
72 can be used to configure a second toggle keymap and is by default unset\&.
73 .RE
74 .PP
75 \fIFONT=\fR, \fIFONT_MAP=\fR, \fIFONT_UNIMAP=\fR
76 .RS 4
77 Configures the console font, the console map and the unicode font map\&.
78 .RE
79 .SH "KERNEL COMMAND LINE"
80 .PP
81 A few configuration parameters from
82 vconsole\&.conf
83 may be overridden on the kernel command line:
84 .PP
85 \fIvconsole\&.keymap=\fR, \fIvconsole\&.keymap_toggle=\fR
86 .RS 4
87 Overrides
88 \fIKEYMAP=\fR
89 and
90 \fIKEYMAP_TOGGLE=\fR\&.
91 .sp
92 Added in version 232\&.
93 .RE
94 .PP
95 \fIvconsole\&.font=\fR, \fIvconsole\&.font_map=\fR, \fIvconsole\&.font_unimap=\fR
96 .RS 4
97 Overrides
98 \fIFONT=\fR,
99 \fIFONT_MAP=\fR, and
100 \fIFONT_UNIMAP=\fR\&.
101 .sp
102 Added in version 232\&.
103 .RE
104 .SH "EXAMPLE"
105 .PP
106 \fBExample\ \&1.\ \&German keyboard and console\fR
107 .PP
108 /etc/vconsole\&.conf:
109 .sp
110 .if n \{\
111 .RS 4
112 .\}
113 .nf
114 KEYMAP=de\-latin1
115 FONT=eurlatgr
116 .fi
117 .if n \{\
118 .RE
119 .\}
120 .SH "SEE ALSO"
121 .PP
122 \fBsystemd\fR(1), \fBsystemd-vconsole-setup.service\fR(8), \fBloadkeys\fR(1), \fBsetfont\fR(8), \fBlocale.conf\fR(5), \fBsystemd-localed.service\fR(8)