diff --git a/man/org.freedesktop.locale1.xml b/man/org.freedesktop.locale1.xml index 7b2bf2870f..94c96456f9 100644 --- a/man/org.freedesktop.locale1.xml +++ b/man/org.freedesktop.locale1.xml @@ -69,37 +69,13 @@ node /org/freedesktop/locale1 { }; - - - - - - - - - - - - - - - The system locale consists of an array of environment-variable-assignment-like strings. The - following strings are known: LANG=, LC_CTYPE=, - LC_NUMERIC=, LC_TIME=, LC_COLLATE=, - LC_MONETARY=, LC_MESSAGES=, LC_PAPER=, - LC_NAME=, LC_ADDRESS=, LC_TELEPHONE=, - LC_MEASUREMENT=, LC_IDENTIFICATION=. - - Whenever the system locale or keymap is changed via the daemon PropertyChanged - signals are sent out to which clients can subscribe. - Methods If you set a new system locale all old system locale settings will be dropped, and the new settings will be saved to disk. It will also be passed to the system manager, and subsequently started - daemons will inherit the new system locale from it. Note that already running daemons will not learn - about the new system locale. + daemons will inherit the new system locale. Note that already running daemons will not learn about the + new value. The SetVConsoleKeyboard() call may be used to set the key mapping on the virtual console. Similarly, SetX11Keyboard() may be used to set the default key @@ -110,7 +86,7 @@ node /org/freedesktop/locale1 { sessions. The boolean argument convert may be set to optionally convert the console - keyboard configuration to X11 keyboard mappings, resp. vice versa. If true and + keyboard configuration to X11 keyboard mappings and vice versa. If true and SetVConsoleKeyboard() is used the nearest X11 keyboard setting for the chosen console setting is set. If true and SetX11Keyboard() is used, the nearest console keyboard setting for the chosen X11 setting is set. Usually it is hence sufficient to call one of the @@ -122,14 +98,45 @@ node /org/freedesktop/locale1 { Use the empty string for the keymap parameters you wish not to set. + The interactive boolean parameters can be used to control whether PolicyKit + should interactively ask the user for authentication credentials if it needs to. + + + + Signals + + Whenever the system locale or keymap is changed via the daemon, + PropertyChanged signals are sent out to which clients can subscribe. + + + + Properties + + The system locale is shown in the Locale property. It is an array containing + environment-variable-assignment-like strings. The following strings are known: + LANG=, LC_CTYPE=, LC_NUMERIC=, + LC_TIME=, LC_COLLATE=, LC_MONETARY=, + LC_MESSAGES=, LC_PAPER=, LC_NAME=, + LC_ADDRESS=, LC_TELEPHONE=, LC_MEASUREMENT=, + LC_IDENTIFICATION=. + + The X11Layout, X11Model, X11Variant, and + X11Options properties show values configurable with + SetX11Keyboard() described above (or SetVConsoleKeyboard() + with convert=true). The VConsoleKeymap and + VConsoleKeymapToggle propries sohw values configurable with + SetVConsoleKeyboard() (or SetX11Keyboard() with + convert=true). + + + + Security + Changing the system locale or keymap using this interface is authenticated via PolicyKit. The PolicyKit action for SetLocale() is org.freedesktop.locale1.set-locale. The PolicyKit action for SetX11Keyboard() and SetVConsoleKeyboard() is org.freedesktop.locale1.set-keyboard. - - The user_interaction boolean parameters can be used to control whether - PolicyKit should interactively ask the user for authentication credentials if it needs to.