man/localectl.1

   1 '\" t
   2 .TH "LOCALECTL" "1" "" "systemd 219" "localectl"
   3 .\" -----------------------------------------------------------------
   4 .\" * Define some portability stuff
   5 .\" -----------------------------------------------------------------
   6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7 .\" http://bugs.debian.org/507673
   8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
   9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10 .ie \n(.g .ds Aq \(aq
  11 .el       .ds Aq '
  12 .\" -----------------------------------------------------------------
  13 .\" * set default formatting
  14 .\" -----------------------------------------------------------------
  15 .\" disable hyphenation
  16 .nh
  17 .\" disable justification (adjust text to left margin only)
  18 .ad l
  19 .\" -----------------------------------------------------------------
  20 .\" * MAIN CONTENT STARTS HERE *
  21 .\" -----------------------------------------------------------------
  22 .SH "NAME"
  23 localectl \- Control the system locale and keyboard layout settings
  24 .SH "SYNOPSIS"
  25 .HP \w'\fBlocalectl\fR\ 'u
  26 \fBlocalectl\fR [OPTIONS...] {COMMAND}
  27 .SH "DESCRIPTION"
  28 .PP
  29 \fBlocalectl\fR
  30 may be used to query and change the system locale and keyboard layout settings\&.
  31 .PP
  32 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\&.
  33 .PP
  34 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\&.
  35 .PP
  36 Use
  37 \fBsystemd-firstboot\fR(1)
  38 to initialize the system locale for mounted (but not booted) system images\&.
  39 .SH "OPTIONS"
  40 .PP
  41 The following options are understood:
  42 .PP
  43 \fB\-\-no\-ask\-password\fR
  44 .RS 4
  45 Do not query the user for authentication for privileged operations\&.
  46 .RE
  47 .PP
  48 \fB\-\-no\-convert\fR
  49 .RS 4
  50 If
  51 \fBset\-keymap\fR
  52 or
  53 \fBset\-x11\-keymap\fR
  54 is invoked and this option is passed, then the keymap will not be converted from the console to X11, or X11 to console, respectively\&.
  55 .RE
  56 .PP
  57 \fB\-H\fR, \fB\-\-host=\fR
  58 .RS 4
  59 Execute the operation remotely\&. Specify a hostname, or a username and hostname separated by
  60 "@", to connect to\&. The hostname may optionally be suffixed by a container name, separated by
  61 ":", 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
  62 \fBmachinectl \-H \fR\fB\fIHOST\fR\fR\&.
  63 .RE
  64 .PP
  65 \fB\-h\fR, \fB\-\-help\fR
  66 .RS 4
  67 Print a short help text and exit\&.
  68 .RE
  69 .PP
  70 \fB\-\-version\fR
  71 .RS 4
  72 Print a short version string and exit\&.
  73 .RE
  74 .PP
  75 \fB\-\-no\-pager\fR
  76 .RS 4
  77 Do not pipe output into a pager\&.
  78 .RE
  79 .PP
  80 The following commands are understood:
  81 .PP
  82 \fBstatus\fR
  83 .RS 4
  84 Show current settings of the system locale and keyboard mapping\&.
  85 .RE
  86 .PP
  87 \fBset\-locale LOCALE\&.\&.\&.\fR
  88 .RS 4
  89 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
  90 \fBlocale\fR(7)
  91 for details on the available settings and their meanings\&. Use
  92 \fBlist\-locales\fR
  93 for a list of available locales (see below)\&.
  94 .RE
  95 .PP
  96 \fBlist\-locales\fR
  97 .RS 4
  98 List available locales useful for configuration with
  99 \fBset\-locale\fR\&.
 100 .RE
 101 .PP
 102 \fBset\-keymap MAP [TOGGLEMAP]\fR
 103 .RS 4
 104 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
 105 \fB\-\-no\-convert\fR
 106 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
 107 \fBlist\-keymaps\fR
 108 for a list of available keyboard mappings (see below)\&.
 109 .RE
 110 .PP
 111 \fBlist\-keymaps\fR
 112 .RS 4
 113 List available keyboard mappings for the console, useful for configuration with
 114 \fBset\-keymap\fR\&.
 115 .RE
 116 .PP
 117 \fBset\-x11\-keymap LAYOUT [MODEL [VARIANT [OPTIONS]]]\fR
 118 .RS 4
 119 Set the system default keyboard mapping for X11 and the virtual console\&. This takes a keyboard mapping name (such as
 120 "de"
 121 or
 122 "us"), and possibly a model, variant, and options, see
 123 \fBkbd\fR(4)
 124 for details\&. Unless
 125 \fB\-\-no\-convert\fR
 126 is passed, the selected setting is also applied as the system console keyboard mapping, after converting it to the closest matching console keyboard mapping\&.
 127 .RE
 128 .PP
 129 \fBlist\-x11\-keymap\-models\fR, \fBlist\-x11\-keymap\-layouts\fR, \fBlist\-x11\-keymap\-variants [LAYOUT]\fR, \fBlist\-x11\-keymap\-options\fR
 130 .RS 4
 131 List available X11 keymap models, layouts, variants and options, useful for configuration with
 132 \fBset\-keymap\fR\&. The command
 133 \fBlist\-x11\-keymap\-variants\fR
 134 optionally takes a layout parameter to limit the output to the variants suitable for the specific layout\&.
 135 .RE
 136 .SH "EXIT STATUS"
 137 .PP
 138 On success, 0 is returned, a non\-zero failure code otherwise\&.
 139 .SH "ENVIRONMENT"
 140 .PP
 141 \fI$SYSTEMD_PAGER\fR
 142 .RS 4
 143 Pager to use when
 144 \fB\-\-no\-pager\fR
 145 is not given; overrides
 146 \fI$PAGER\fR\&. Setting this to an empty string or the value
 147 "cat"
 148 is equivalent to passing
 149 \fB\-\-no\-pager\fR\&.
 150 .RE
 151 .PP
 152 \fI$SYSTEMD_LESS\fR
 153 .RS 4
 154 Override the default options passed to
 155 \fBless\fR
 156 ("FRSXMK")\&.
 157 .RE
 158 .SH "SEE ALSO"
 159 .PP
 160 \fBsystemd\fR(1),
 161 \fBlocale\fR(7),
 162 \fBlocale.conf\fR(5),
 163 \fBvconsole.conf\fR(5),
 164 \fBloadkeys\fR(1),
 165 \fBkbd\fR(4),
 166 \m[blue]\fBThe XKB Configuration Guide\fR\m[]\&\s-2\u[1]\d\s+2,
 167 \fBsystemctl\fR(1),
 168 \fBsystemd-localed.service\fR(8),
 169 \fBsystemd-firstboot\fR(1)
 170 .SH "NOTES"
 171 .IP " 1." 4
 172 The XKB Configuration Guide
 173 .RS 4
 174 \%http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html
 175 .RE