From 7cd28a8a2fdf01293b0c07681a5f36f557fe51b4 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sun, 21 Oct 2012 03:35:00 +0200 Subject: [PATCH] man: add man page for localectl --- Makefile.am | 4 +- man/localectl.xml | 259 ++++++++++++++++++++++++++++++ man/systemd-hostnamed.service.xml | 4 + man/systemd-localed.service.xml | 8 +- 4 files changed, 272 insertions(+), 3 deletions(-) create mode 100644 man/localectl.xml diff --git a/Makefile.am b/Makefile.am index 42c481ed7..d39e3b62f 100644 --- a/Makefile.am +++ b/Makefile.am @@ -3183,8 +3183,8 @@ localectl_LDADD = \ bin_PROGRAMS += \ localectl -#MANPAGES += \ -# man/localectl.1 +MANPAGES += \ + man/localectl.1 endif diff --git a/man/localectl.xml b/man/localectl.xml new file mode 100644 index 000000000..6d7c7889b --- /dev/null +++ b/man/localectl.xml @@ -0,0 +1,259 @@ + + + + + + + + + localectl + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + localectl + 1 + + + + localectl + Control the system locale and keyboard layout settings + + + + + localectl OPTIONS COMMAND + + + + + Description + + localectl may be used to + query and change the system locale and keyboard layout + settings. + + 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. + + + + Options + + The following options are understood: + + + + + + + Prints a short help + text and exits. + + + + + + Prints a short version + string and exits. + + + + + + Do not pipe output into a + pager. + + + + + + Don't query the user + for authentication for privileged + operations. + + + + + + + Execute operation + remotely. Specify a hostname, or + username and hostname separated by @, + to connect to. This will use SSH to + talk to a remote + system. + + + + + + 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. + + + + The following commands are understood: + + + + status + + 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 + locale7 + for details on the available settings + and their meanings. Use + list-locales for a + list of available locales (see below). + + + + + list-locales + + List available locales + useful for configuration with + set-locale. + + + + set-keymap MAP [TOGGLEMAP] + + Set the system + keyboard mapping for the console. This + takes a keyboard mapping name (such as + "de" or "us"), and possibly a second + one to define a toggle keyboard + mapping. Unless + is + passed the selected setting is also + applied to the default keyboard + mapping of X11, after converting it to + the closest matching X11 keyboard + mapping. Use + list-locales for a + list of available keyboard mappings + (see below). + + + + list-keymaps + + List available + keyboard mappings for the console, + useful for configuration with + set-keyboard. + + + + set-x11-keymap LAYOUT [MODEL] [VARIANT] [OPTIONS] + + Set the system default + keyboard mapping for X11. This takes a + keyboard mapping name (such as "de" or + "us"), and possibly a model, variant + and options, see + kbd4 + for details. Unless + is + passed the selected setting is also + applied to the system console keyboard + mapping, after converting it to the + closest matching console keyboard + mapping. + + + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + Environment + + + + $SYSTEMD_PAGER + Pager to use when + is not given; + overrides $PAGER. Setting + this to an empty string or the value + cat is equivalent to passing + . + + + + + + See Also + + systemd1, + locale7, + locale.conf5, + vconsole.conf5, + loadkeys1, + kbd4, + systemctl1, + systemd-localed.service8 + + + + diff --git a/man/systemd-hostnamed.service.xml b/man/systemd-hostnamed.service.xml index 555bb7a2d..d9c191101 100644 --- a/man/systemd-hostnamed.service.xml +++ b/man/systemd-hostnamed.service.xml @@ -62,6 +62,10 @@ automatically activated on request and terminates itself when it is unused. + The tool + hostnamectl1 + is a command line client to this service. + See the developer documentation for information about diff --git a/man/systemd-localed.service.xml b/man/systemd-localed.service.xml index f0f069b93..6cefc4265 100644 --- a/man/systemd-localed.service.xml +++ b/man/systemd-localed.service.xml @@ -64,6 +64,10 @@ automatically activated on request and terminates itself when it is unused. + The tool + localectl1 + is a command line client to this service. + See the developer documentation for information about @@ -76,7 +80,9 @@ systemd1, locale.conf5, - vconsole.conf5 + vconsole.conf5, + localectl1, + loadkeys1