LOCALECTL(1)                       localectl                      LOCALECTL(1)

NNAAMMEE
       localectl - Control the system locale and keyboard layout settings

SSYYNNOOPPSSIISS
       llooccaalleeccttll [OPTIONS...] {COMMAND}

DDEESSCCRRIIPPTTIIOONN
       llooccaalleeccttll may be used to query and change the system locale and
       keyboard layout settings. It communicates with ssyysstteemmdd--llooccaalleedd(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 ssyysstteemmdd--ffiirrssttbboooott(1) may be used to initialize the system
       locale for mounted (but not booted) system images.

CCOOMMMMAANNDDSS
       The following commands are understood:

       ssttaattuuss
           Show current settings of the system locale and keyboard mapping. If
           no command is specified, this is the implied default.

       sseett--llooccaallee LLOOCCAALLEE, sseett--llooccaallee VVAARRIIAABBLLEE==LLOOCCAALLEE......
           Set the system locale. This takes one locale such as "en_US.UTF-8",
           or takes one or more locale assignments such as "LANG=de_DE.utf8",
           "LC_MESSAGES=en_GB.utf8", and so on. If one locale without variable
           name is provided, then "LANG=" locale variable will be set. See
           llooccaallee(7) for details on the available settings and their meanings.
           Use lliisstt--llooccaalleess for a list of available locales (see below).

       lliisstt--llooccaalleess
           List available locales useful for configuration with sseett--llooccaallee.

       sseett--kkeeyymmaapp MMAAPP [[TTOOGGGGLLEEMMAAPP]]
           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 ----nnoo--ccoonnvveerrtt 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 lliisstt--kkeeyymmaappss for a list of available keyboard
           mappings (see below).

       lliisstt--kkeeyymmaappss
           List available keyboard mappings for the console, useful for
           configuration with sseett--kkeeyymmaapp.

       sseett--xx1111--kkeeyymmaapp LLAAYYOOUUTT [[MMOODDEELL [[VVAARRIIAANNTT [[OOPPTTIIOONNSS]]]]]]
           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 kkbbdd(4) for details.
           Unless ----nnoo--ccoonnvveerrtt is passed, the selected setting is also applied
           as the system console keyboard mapping, after converting it to the
           closest matching console keyboard mapping.

       lliisstt--xx1111--kkeeyymmaapp--mmooddeellss, lliisstt--xx1111--kkeeyymmaapp--llaayyoouuttss,
       lliisstt--xx1111--kkeeyymmaapp--vvaarriiaannttss [[LLAAYYOOUUTT]], lliisstt--xx1111--kkeeyymmaapp--ooppttiioonnss
           List available X11 keymap models, layouts, variants and options,
           useful for configuration with sseett--kkeeyymmaapp. The command
           lliisstt--xx1111--kkeeyymmaapp--vvaarriiaannttss optionally takes a layout parameter to
           limit the output to the variants suitable for the specific layout.

OOPPTTIIOONNSS
       The following options are understood:

       ----nnoo--aasskk--ppaasssswwoorrdd
           Do not query the user for authentication for privileged operations.

       ----nnoo--ccoonnvveerrtt
           If sseett--kkeeyymmaapp or sseett--xx1111--kkeeyymmaapp 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H, ----hhoosstt==
           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 port ssh is listening on, separated by
           ":", and then 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 mmaacchhiinneeccttll --HH _H_O_S_T. Put IPv6 addresses
           in brackets.

       --MM, ----mmaacchhiinnee==
           Execute operation on a local container. Specify a container name to
           connect to, optionally prefixed by a user name to connect as and a
           separating "@" character. If the special string ".host" is used in
           place of the container name, a connection to the local system is
           made (which is useful to connect to a specific user's user bus:
           "--user --machine=lennart@.host"). If the "@" syntax is not used,
           the connection is made as root user. If the "@" syntax is used
           either the left hand side or the right hand side may be omitted
           (but not both) in which case the local user name and ".host" are
           implied.

       --hh, ----hheellpp
           Print a short help text and exit.

       ----vveerrssiioonn
           Print a short version string and exit.

       ----nnoo--ppaaggeerr
           Do not pipe output into a pager.

EEXXIITT SSTTAATTUUSS
       On success, 0 is returned, a non-zero failure code otherwise.

EENNVVIIRROONNMMEENNTT
       _$_S_Y_S_T_E_M_D___L_O_G___L_E_V_E_L
           The maximum log level of emitted messages (messages with a higher
           log level, i.e. less important ones, will be suppressed). Either
           one of (in order of decreasing importance) eemmeerrgg, aalleerrtt, ccrriitt, eerrrr,
           wwaarrnniinngg, nnoottiiccee, iinnffoo, ddeebbuugg, or an integer in the range 0...7. See
           ssyysslloogg(3) for more information.

       _$_S_Y_S_T_E_M_D___L_O_G___C_O_L_O_R
           A boolean. If true, messages written to the tty will be colored
           according to priority.

           This setting is only useful when messages are written directly to
           the terminal, because jjoouurrnnaallccttll(1) and other tools that display
           logs will color messages based on the log level on their own.

       _$_S_Y_S_T_E_M_D___L_O_G___T_I_M_E
           A boolean. If true, console log messages will be prefixed with a
           timestamp.

           This setting is only useful when messages are written directly to
           the terminal or a file, because jjoouurrnnaallccttll(1) and other tools that
           display logs will attach timestamps based on the entry metadata on
           their own.

       _$_S_Y_S_T_E_M_D___L_O_G___L_O_C_A_T_I_O_N
           A boolean. If true, messages will be prefixed with a filename and
           line number in the source code where the message originates.

           Note that the log location is often attached as metadata to journal
           entries anyway. Including it directly in the message text can
           nevertheless be convenient when debugging programs.

       _$_S_Y_S_T_E_M_D___L_O_G___T_I_D
           A boolean. If true, messages will be prefixed with the current
           numerical thread ID (TID).

           Note that the this information is attached as metadata to journal
           entries anyway. Including it directly in the message text can
           nevertheless be convenient when debugging programs.

       _$_S_Y_S_T_E_M_D___L_O_G___T_A_R_G_E_T
           The destination for log messages. One of ccoonnssoollee (log to the
           attached tty), ccoonnssoollee--pprreeffiixxeedd (log to the attached tty but with
           prefixes encoding the log level and "facility", see ssyysslloogg(3), kkmmssgg
           (log to the kernel circular log buffer), jjoouurrnnaall (log to the
           journal), jjoouurrnnaall--oorr--kkmmssgg (log to the journal if available, and to
           kmsg otherwise), aauuttoo (determine the appropriate log target
           automatically, the default), nnuullll (disable log output).

       _$_S_Y_S_T_E_M_D___P_A_G_E_R
           Pager to use when ----nnoo--ppaaggeerr is not given; overrides _$_P_A_G_E_R. If
           neither _$_S_Y_S_T_E_M_D___P_A_G_E_R nor _$_P_A_G_E_R are set, a set of well-known
           pager implementations are tried in turn, including lleessss(1) and
           mmoorree(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
           ----nnoo--ppaaggeerr.

           Note: if _$_S_Y_S_T_E_M_D___P_A_G_E_R_S_E_C_U_R_E is not set, _$_S_Y_S_T_E_M_D___P_A_G_E_R (as well
           as _$_P_A_G_E_R) will be silently ignored.

       _$_S_Y_S_T_E_M_D___L_E_S_S
           Override the options passed to lleessss (by default "FRSXMK").

           Users might want to change two options in particular:

           KK
               This option instructs the pager to exit immediately when Ctrl+C
               is pressed. To allow lleessss to handle Ctrl+C itself to switch
               back to the pager command prompt, unset this option.

               If the value of _$_S_Y_S_T_E_M_D___L_E_S_S does not include "K", and the
               pager that is invoked is lleessss, Ctrl+C will be ignored by the
               executable, and needs to be handled by the pager.

           XX
               This option instructs the pager to not send termcap
               initialization and deinitialization strings to the terminal. It
               is set by default to allow command output to remain visible in
               the terminal even after the pager exits. Nevertheless, this
               prevents some pager functionality from working, in particular
               paged output cannot be scrolled with the mouse.

           See lleessss(1) for more discussion.

       _$_S_Y_S_T_E_M_D___L_E_S_S_C_H_A_R_S_E_T
           Override the charset passed to lleessss (by default "utf-8", if the
           invoking terminal is determined to be UTF-8 compatible).

       _$_S_Y_S_T_E_M_D___P_A_G_E_R_S_E_C_U_R_E
           Takes a boolean argument. When true, the "secure" mode of the pager
           is enabled; if false, disabled. If _$_S_Y_S_T_E_M_D___P_A_G_E_R_S_E_C_U_R_E is not set
           at all, secure mode is enabled if the effective UID is not the same
           as the owner of the login session, see ggeetteeuuiidd(2) and
           ssdd__ppiidd__ggeett__oowwnneerr__uuiidd(3). In secure mode, LLEESSSSSSEECCUURREE==11 will be set
           when invoking the pager, and the pager shall disable commands that
           open or create new files or start new subprocesses. When
           _$_S_Y_S_T_E_M_D___P_A_G_E_R_S_E_C_U_R_E is not set at all, pagers which are not known
           to implement secure mode will not be used. (Currently only lleessss(1)
           implements secure mode.)

           Note: when commands are invoked with elevated privileges, for
           example under ssuuddoo(8) or ppkkeexxeecc(1), care must be taken to ensure
           that unintended interactive features are not enabled. "Secure" mode
           for the pager may be enabled automatically as describe above.
           Setting _S_Y_S_T_E_M_D___P_A_G_E_R_S_E_C_U_R_E_=_0 or not removing it from the inherited
           environment allows the user to invoke arbitrary commands. Note that
           if the _$_S_Y_S_T_E_M_D___P_A_G_E_R or _$_P_A_G_E_R variables are to be honoured,
           _$_S_Y_S_T_E_M_D___P_A_G_E_R_S_E_C_U_R_E must be set too. It might be reasonable to
           completely disable the pager using ----nnoo--ppaaggeerr instead.

       _$_S_Y_S_T_E_M_D___C_O_L_O_R_S
           Takes a boolean argument. When true, ssyysstteemmdd and related utilities
           will use colors in their output, otherwise the output will be
           monochrome. Additionally, the variable can take one of the
           following special values: "16", "256" to restrict the use of colors
           to the base 16 or 256 ANSI colors, respectively. This can be
           specified to override the automatic decision based on _$_T_E_R_M and
           what the console is connected to.

       _$_S_Y_S_T_E_M_D___U_R_L_I_F_Y
           The value must be a boolean. Controls whether clickable links
           should be generated in the output for terminal emulators supporting
           this. This can be specified to override the decision that ssyysstteemmdd
           makes based on _$_T_E_R_M and other conditions.

SSEEEE AALLSSOO
       ssyysstteemmdd(1), llooccaallee(7), llooccaallee..ccoonnff(5), vvccoonnssoollee..ccoonnff(5), llooaaddkkeeyyss(1),
       kkbbdd(4), TThhee XXKKBB CCoonnffiigguurraattiioonn GGuuiiddee[1], ssyysstteemmccttll(1), ssyysstteemmdd--
       llooccaalleedd..sseerrvviiccee(8), ssyysstteemmdd--ffiirrssttbboooott(1), mmkkiinniittrrdd(8)

NNOOTTEESS
        1. The XKB Configuration Guide
           http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html

systemd 251                                                       LOCALECTL(1)
