LOCALECTL(1)                      localectl                     LOCALECTL(1)

NAME         top

       localectl - Control the system locale and keyboard layout settings

SYNOPSIS         top

       localectl [OPTIONS...] {COMMAND}

DESCRIPTION         top

       localectl may be used to query and change the system locale and
       keyboard layout settings. It communicates with systemd-localed(8) to
       modify files such as /etc/locale.conf and /etc/vconsole.conf.

       The system locale controls the language settings of system services
       and of the UI before the user logs in, such as the display manager,
       as well as the default for users after login.

       The keyboard settings control the keyboard layout used on the text
       console and of the graphical UI before the user logs in, such as the
       display manager, as well as the default for users after login.

       Note that the changes performed using this tool might require the
       initramfs to be rebuilt to take effect during early system boot. The
       initramfs is not rebuilt automatically by localectl.

       Note that systemd-firstboot(1) may be used to initialize the system
       locale for mounted (but not booted) system images.

OPTIONS         top

       The following options are understood:

           Do not query the user for authentication for privileged

           If set-keymap or set-x11-keymap is invoked and this option is
           passed, then the keymap will not be converted from the console to
           X11, or X11 to console, respectively.

       -H, --host=
           Execute the operation remotely. Specify a hostname, or a username
           and hostname separated by "@", to connect to. The hostname may
           optionally be suffixed by a container name, separated by ":",
           which connects directly to a specific container on the specified
           host. This will use SSH to talk to the remote machine manager
           instance. Container names may be enumerated with machinectl -H

       -h, --help
           Print a short help text and exit.

           Print a short version string and exit.

           Do not pipe output into a pager.

       The following commands are understood:

           Show current settings of the system locale and keyboard mapping.

       set-locale LOCALE...
           Set the system locale. This takes one or more assignments such as
           "LANG=de_DE.utf8", "LC_MESSAGES=en_GB.utf8", and so on. See
           locale(7) for details on the available settings and their
           meanings. Use list-locales for a list of available locales (see

           List available locales useful for configuration with set-locale.

       set-keymap MAP [TOGGLEMAP]
           Set the system keyboard mapping for the console and X11. This
           takes a mapping name (such as "de" or "us"), and possibly a
           second one to define a toggle keyboard mapping. Unless
           --no-convert is passed, the selected setting is also applied as
           the default system keyboard mapping of X11, after converting it
           to the closest matching X11 keyboard mapping. Use list-keymaps
           for a list of available keyboard mappings (see below).

           List available keyboard mappings for the console, useful for
           configuration with set-keymap.

       set-x11-keymap LAYOUT [MODEL [VARIANT [OPTIONS]]]
           Set the system default keyboard mapping for X11 and the virtual
           console. This takes a keyboard mapping name (such as "de" or
           "us"), and possibly a model, variant, and options, see kbd(4) for
           details. Unless --no-convert is passed, the selected setting is
           also applied as the system console keyboard mapping, after
           converting it to the closest matching console keyboard mapping.

       list-x11-keymap-models, list-x11-keymap-layouts,
       list-x11-keymap-variants [LAYOUT], list-x11-keymap-options
           List available X11 keymap models, layouts, variants and options,
           useful for configuration with set-keymap. The command
           list-x11-keymap-variants optionally takes a layout parameter to
           limit the output to the variants suitable for the specific

EXIT STATUS         top

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

ENVIRONMENT         top

           Pager to use when --no-pager is not given; overrides $PAGER. If
           neither $SYSTEMD_PAGER nor $PAGER are set, a set of well-known
           pager implementations are tried in turn, including less(1) and
           more(1), until one is found. If no pager implementation is
           discovered no pager is invoked. Setting this environment variable
           to an empty string or the value "cat" is equivalent to passing

           Override the options passed to less (by default "FRSXMK").

           Override the charset passed to less (by default "utf-8", if the
           invoking terminal is determined to be UTF-8 compatible).

SEE ALSO         top

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

NOTES         top

        1. The XKB Configuration Guide

COLOPHON         top

       This page is part of the systemd (systemd system and service manager)
       project.  Information about the project can be found at 
       ⟨⟩.  If you have a bug
       report for this manual page, see
       ⟨⟩.  This
       page was obtained from the project's upstream Git repository
       ⟨⟩ on 2019-11-19.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2019-11-19.)  If you discover any rendering problems in
       this HTML version of the page, or you believe there is a better or
       more up-to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not part
       of the original manual page), send a mail to

systemd 234                                                     LOCALECTL(1)

Pages that refer to this page: systemd-firstboot(1)locale.conf(5)vconsole.conf(5)systemd.directives(7)systemd.index(7)systemd-localed.service(8)