1LOCALECTL(1)                       localectl                      LOCALECTL(1)
2
3
4

NAME

6       localectl - Control the system locale and keyboard layout settings
7

SYNOPSIS

9       localectl [OPTIONS...] {COMMAND}
10

DESCRIPTION

12       localectl may be used to query and change the system locale and
13       keyboard layout settings. It communicates with systemd-localed(8) to
14       modify files such as /etc/locale.conf and /etc/vconsole.conf.
15
16       The system locale controls the language settings of system services and
17       of the UI before the user logs in, such as the display manager, as well
18       as the default for users after login.
19
20       The keyboard settings control the keyboard layout used on the text
21       console and of the graphical UI before the user logs in, such as the
22       display manager, as well as the default for users after login.
23
24       Note that the changes performed using this tool might require the
25       initramfs to be rebuilt to take effect during early system boot. The
26       initramfs is not rebuilt automatically by localectl.
27
28       Note that systemd-firstboot(1) may be used to initialize the system
29       locale for mounted (but not booted) system images.
30

OPTIONS

32       The following options are understood:
33
34       --no-ask-password
35           Do not query the user for authentication for privileged operations.
36
37       --no-convert
38           If set-keymap or set-x11-keymap is invoked and this option is
39           passed, then the keymap will not be converted from the console to
40           X11, or X11 to console, respectively.
41
42       -H, --host=
43           Execute the operation remotely. Specify a hostname, or a username
44           and hostname separated by "@", to connect to. The hostname may
45           optionally be suffixed by a container name, separated by ":", which
46           connects directly to a specific container on the specified host.
47           This will use SSH to talk to the remote machine manager instance.
48           Container names may be enumerated with machinectl -H HOST.
49
50       -M, --machine=
51           Execute operation on a local container. Specify a container name to
52           connect to.
53
54       -h, --help
55           Print a short help text and exit.
56
57       --version
58           Print a short version string and exit.
59
60       --no-pager
61           Do not pipe output into a pager.
62

COMMANDS

64       The following commands are understood:
65
66       status
67           Show current settings of the system locale and keyboard mapping. If
68           no command is specified, this is the implied default.
69
70       set-locale LOCALE, set-locale VARIABLE=LOCALE...
71           Set the system locale. This takes one locale such as "en_US.UTF-8",
72           or takes one or more locale assignments such as "LANG=de_DE.utf8",
73           "LC_MESSAGES=en_GB.utf8", and so on. If one locale without variable
74           name is provided, then "LANG=" locale variable will be set. See
75           locale(7) for details on the available settings and their meanings.
76           Use list-locales for a list of available locales (see below).
77
78       list-locales
79           List available locales useful for configuration with set-locale.
80
81       set-keymap MAP [TOGGLEMAP]
82           Set the system keyboard mapping for the console and X11. This takes
83           a mapping name (such as "de" or "us"), and possibly a second one to
84           define a toggle keyboard mapping. Unless --no-convert is passed,
85           the selected setting is also applied as the default system keyboard
86           mapping of X11, after converting it to the closest matching X11
87           keyboard mapping. Use list-keymaps for a list of available keyboard
88           mappings (see below).
89
90       list-keymaps
91           List available keyboard mappings for the console, useful for
92           configuration with set-keymap.
93
94       set-x11-keymap LAYOUT [MODEL [VARIANT [OPTIONS]]]
95           Set the system default keyboard mapping for X11 and the virtual
96           console. This takes a keyboard mapping name (such as "de" or "us"),
97           and possibly a model, variant, and options, see kbd(4) for details.
98           Unless --no-convert is passed, the selected setting is also applied
99           as the system console keyboard mapping, after converting it to the
100           closest matching console keyboard mapping.
101
102       list-x11-keymap-models, list-x11-keymap-layouts,
103       list-x11-keymap-variants [LAYOUT], list-x11-keymap-options
104           List available X11 keymap models, layouts, variants and options,
105           useful for configuration with set-keymap. The command
106           list-x11-keymap-variants optionally takes a layout parameter to
107           limit the output to the variants suitable for the specific layout.
108

EXIT STATUS

110       On success, 0 is returned, a non-zero failure code otherwise.
111

ENVIRONMENT

113       $SYSTEMD_PAGER
114           Pager to use when --no-pager is not given; overrides $PAGER. If
115           neither $SYSTEMD_PAGER nor $PAGER are set, a set of well-known
116           pager implementations are tried in turn, including less(1) and
117           more(1), until one is found. If no pager implementation is
118           discovered no pager is invoked. Setting this environment variable
119           to an empty string or the value "cat" is equivalent to passing
120           --no-pager.
121
122       $SYSTEMD_LESS
123           Override the options passed to less (by default "FRSXMK").
124
125       $SYSTEMD_LESSCHARSET
126           Override the charset passed to less (by default "utf-8", if the
127           invoking terminal is determined to be UTF-8 compatible).
128

SEE ALSO

130       systemd(1), locale(7), locale.conf(5), vconsole.conf(5), loadkeys(1),
131       kbd(4), The XKB Configuration Guide[1], systemctl(1), systemd-
132       localed.service(8), systemd-firstboot(1), mkinitrd(8)
133

NOTES

135        1. The XKB Configuration Guide
136           http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html
137
138
139
140systemd 239                                                       LOCALECTL(1)
Impressum