1LOCALECTL(1) localectl LOCALECTL(1)
2
6 localectl - Control the system locale and keyboard layout settings
7
9 localectl [OPTIONS...] {COMMAND}
10
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 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 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 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 Note that systemd-firstboot(1) may be used to initialize the system
29 locale for mounted (but not booted) system images.
30
32 The following options are understood:
33 --no-ask-password
35 Do not query the user for authentication for privileged operations.
36 --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 -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 port ssh is listening on, seperated by
46 ":", and then a container name, separated by "/", which connects
47 directly to a specific container on the specified host. This will
48 use SSH to talk to the remote machine manager instance. Container
49 names may be enumerated with machinectl -H HOST. Put IPv6 addresses
50 in brackets.
51 -M, --machine=
53 Execute operation on a local container. Specify a container name to
54 connect to.
55 -h, --help
57 Print a short help text and exit.
58 --version
60 Print a short version string and exit.
61 --no-pager
63 Do not pipe output into a pager.
64
66 The following commands are understood:
67 status
69 Show current settings of the system locale and keyboard mapping. If
70 no command is specified, this is the implied default.
71 set-locale LOCALE, set-locale VARIABLE=LOCALE...
73 Set the system locale. This takes one locale such as "en_US.UTF-8",
74 or takes one or more locale assignments such as "LANG=de_DE.utf8",
75 "LC_MESSAGES=en_GB.utf8", and so on. If one locale without variable
76 name is provided, then "LANG=" locale variable will be set. See
77 locale(7) for details on the available settings and their meanings.
78 Use list-locales for a list of available locales (see below).
79 list-locales
81 List available locales useful for configuration with set-locale.
82 set-keymap MAP [TOGGLEMAP]
84 Set the system keyboard mapping for the console and X11. This takes
85 a mapping name (such as "de" or "us"), and possibly a second one to
86 define a toggle keyboard mapping. Unless --no-convert is passed,
87 the selected setting is also applied as the default system keyboard
88 mapping of X11, after converting it to the closest matching X11
89 keyboard mapping. Use list-keymaps for a list of available keyboard
90 mappings (see below).
91 list-keymaps
93 List available keyboard mappings for the console, useful for
94 configuration with set-keymap.
95 set-x11-keymap LAYOUT [MODEL [VARIANT [OPTIONS]]]
97 Set the system default keyboard mapping for X11 and the virtual
98 console. This takes a keyboard mapping name (such as "de" or "us"),
99 and possibly a model, variant, and options, see kbd(4) for details.
100 Unless --no-convert is passed, the selected setting is also applied
101 as the system console keyboard mapping, after converting it to the
102 closest matching console keyboard mapping.
103 list-x11-keymap-models, list-x11-keymap-layouts,
105 list-x11-keymap-variants [LAYOUT], list-x11-keymap-options
106 List available X11 keymap models, layouts, variants and options,
107 useful for configuration with set-keymap. The command
108 list-x11-keymap-variants optionally takes a layout parameter to
109 limit the output to the variants suitable for the specific layout.
110
112 On success, 0 is returned, a non-zero failure code otherwise.
113
115 $SYSTEMD_PAGER
116 Pager to use when --no-pager is not given; overrides $PAGER. If
117 neither $SYSTEMD_PAGER nor $PAGER are set, a set of well-known
118 pager implementations are tried in turn, including less(1) and
119 more(1), until one is found. If no pager implementation is
120 discovered no pager is invoked. Setting this environment variable
121 to an empty string or the value "cat" is equivalent to passing
122 --no-pager.
123 $SYSTEMD_LESS
125 Override the options passed to less (by default "FRSXMK").
126 If the value of $SYSTEMD_LESS does not include "K", and the pager
128 that is invoked is less, Ctrl+C will be ignored by the executable.
129 This allows less to handle Ctrl+C itself.
130 $SYSTEMD_LESSCHARSET
132 Override the charset passed to less (by default "utf-8", if the
133 invoking terminal is determined to be UTF-8 compatible).
134
136 systemd(1), locale(7), locale.conf(5), vconsole.conf(5), loadkeys(1),
137 kbd(4), The XKB Configuration Guide[1], systemctl(1), systemd-
138 localed.service(8), systemd-firstboot(1), mkinitrd(8)
139
141 1. The XKB Configuration Guide
142 http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html
143systemd 241 LOCALECTL(1)