localectl(1)

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

COMMANDS

32       The following commands are understood:
33
34       status
35           Show current settings of the system locale and keyboard mapping. If
36           no command is specified, this is the implied default.
37
38       set-locale LOCALE, set-locale VARIABLE=LOCALE...
39           Set the system locale. This takes one locale such as "en_US.UTF-8",
40           or takes one or more locale assignments such as "LANG=de_DE.utf8",
41           "LC_MESSAGES=en_GB.utf8", and so on. If one locale without variable
42           name is provided, then "LANG=" locale variable will be set. See
43           locale(7) for details on the available settings and their meanings.
44           Use list-locales for a list of available locales (see below).
45
46       list-locales
47           List available locales useful for configuration with set-locale.
48
49       set-keymap MAP [TOGGLEMAP]
50           Set the system keyboard mapping for the console and X11. This takes
51           a mapping name (such as "de" or "us"), and possibly a second one to
52           define a toggle keyboard mapping. Unless --no-convert is passed,
53           the selected setting is also applied as the default system keyboard
54           mapping of X11, after converting it to the closest matching X11
55           keyboard mapping. Use list-keymaps for a list of available keyboard
56           mappings (see below).
57
58       list-keymaps
59           List available keyboard mappings for the console, useful for
60           configuration with set-keymap.
61
62       set-x11-keymap LAYOUT [MODEL [VARIANT [OPTIONS]]]
63           Set the system default keyboard mapping for X11 and the virtual
64           console. This takes a keyboard mapping name (such as "de" or "us"),
65           and possibly a model, variant, and options, see kbd(4) for details.
66           Unless --no-convert is passed, the selected setting is also applied
67           as the system console keyboard mapping, after converting it to the
68           closest matching console keyboard mapping.
69
70       list-x11-keymap-models, list-x11-keymap-layouts,
71       list-x11-keymap-variants [LAYOUT], list-x11-keymap-options
72           List available X11 keymap models, layouts, variants and options,
73           useful for configuration with set-keymap. The command
74           list-x11-keymap-variants optionally takes a layout parameter to
75           limit the output to the variants suitable for the specific layout.
76

OPTIONS

78       The following options are understood:
79
80       --no-ask-password
81           Do not query the user for authentication for privileged operations.
82
83       --no-convert
84           If set-keymap or set-x11-keymap is invoked and this option is
85           passed, then the keymap will not be converted from the console to
86           X11, or X11 to console, respectively.
87
88       -H, --host=
89           Execute the operation remotely. Specify a hostname, or a username
90           and hostname separated by "@", to connect to. The hostname may
91           optionally be suffixed by a port ssh is listening on, separated by
92           ":", and then a container name, separated by "/", which connects
93           directly to a specific container on the specified host. This will
94           use SSH to talk to the remote machine manager instance. Container
95           names may be enumerated with machinectl -H HOST. Put IPv6 addresses
96           in brackets.
97
98       -M, --machine=
99           Execute operation on a local container. Specify a container name to
100           connect to.
101
102       -h, --help
103           Print a short help text and exit.
104
105       --version
106           Print a short version string and exit.
107
108       --no-pager
109           Do not pipe output into a pager.
110

EXIT STATUS

112       On success, 0 is returned, a non-zero failure code otherwise.
113

ENVIRONMENT

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
124       $SYSTEMD_LESS
125           Override the options passed to less (by default "FRSXMK").
126
127           Users might want to change two options in particular:
128
129           K
130               This option instructs the pager to exit immediately when Ctrl+C
131               is pressed. To allow less to handle Ctrl+C itself to switch
132               back to the pager command prompt, unset this option.
133
134               If the value of $SYSTEMD_LESS does not include "K", and the
135               pager that is invoked is less, Ctrl+C will be ignored by the
136               executable, and needs to be handled by the pager.
137
138           X
139               This option instructs the pager to not send termcap
140               initialization and deinitialization strings to the terminal. It
141               is set by default to allow command output to remain visible in
142               the terminal even after the pager exits. Nevertheless, this
143               prevents some pager functionality from working, in particular
144               paged output cannot be scrolled with the mouse.
145
146           See less(1) for more discussion.
147
148       $SYSTEMD_LESSCHARSET
149           Override the charset passed to less (by default "utf-8", if the
150           invoking terminal is determined to be UTF-8 compatible).
151
152       $SYSTEMD_COLORS
153           The value must be a boolean. Controls whether colorized output
154           should be generated. This can be specified to override the decision
155           that systemd makes based on $TERM and what the console is connected
156           to.
157
158       $SYSTEMD_URLIFY
159           The value must be a boolean. Controls whether clickable links
160           should be generated in the output for terminal emulators supporting
161           this. This can be specified to override the decision that systemd
162           makes based on $TERM and other conditions.
163

NOTES

170        1. The XKB Configuration Guide
171           http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html
172
173
174
175systemd 245                                                       LOCALECTL(1)