{
    "content": [
        {
            "type": "text",
            "text": "# org.freedesktop.locale1 (man)\n\n## NAME\n\norg.freedesktop.locale1 - The D-Bus interface of systemd-localed\n\n## Sections\n\n- **NAME**\n- **INTRODUCTION**\n- **THE D-BUS API** (4 subsections)\n- **EXAMPLES** (1 subsections)\n- **VERSIONING**\n- **NOTES**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "org.freedesktop.locale1",
        "section": "",
        "mode": "man",
        "summary": "org.freedesktop.locale1 - The D-Bus interface of systemd-localed",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [
            "$ gdbus introspect --system \\",
            "--dest org.freedesktop.locale1 \\",
            "--object-path /org/freedesktop/locale1"
        ],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "INTRODUCTION",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "THE D-BUS API",
                "lines": 43,
                "subsections": [
                    {
                        "name": "Methods",
                        "lines": 25
                    },
                    {
                        "name": "Signals",
                        "lines": 3
                    },
                    {
                        "name": "Properties",
                        "lines": 10
                    },
                    {
                        "name": "Security",
                        "lines": 4
                    }
                ]
            },
            {
                "name": "EXAMPLES",
                "lines": 1,
                "subsections": [
                    {
                        "name": "Example 1. Introspect org.freedesktop.locale1 on the bus",
                        "lines": 5
                    }
                ]
            },
            {
                "name": "VERSIONING",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "NOTES",
                "lines": 9,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "org.freedesktop.locale1 - The D-Bus interface of systemd-localed\n",
                "subsections": []
            },
            "INTRODUCTION": {
                "content": "systemd-localed.service(8) is a system service that can be used to control the system locale\nand keyboard mapping from user programs. This page describes the D-Bus interface.\n",
                "subsections": []
            },
            "THE D-BUS API": {
                "content": "The service exposes the following interfaces on the bus:\n\nnode /org/freedesktop/locale1 {\ninterface org.freedesktop.locale1 {\nmethods:\nSetLocale(in  as locale,\nin  b interactive);\nSetVConsoleKeyboard(in  s keymap,\nin  s keymaptoggle,\nin  b convert,\nin  b interactive);\nSetX11Keyboard(in  s layout,\nin  s model,\nin  s variant,\nin  s options,\nin  b convert,\nin  b interactive);\nproperties:\nreadonly as Locale = ['...', ...];\nreadonly s X11Layout = '...';\nreadonly s X11Model = '...';\nreadonly s X11Variant = '...';\nreadonly s X11Options = '...';\nreadonly s VConsoleKeymap = '...';\nreadonly s VConsoleKeymapToggle = '...';\n};\ninterface org.freedesktop.DBus.Peer { ... };\ninterface org.freedesktop.DBus.Introspectable { ... };\ninterface org.freedesktop.DBus.Properties { ... };\n};\n\n\n\n\n\n\n\n\n\n\n\n\n",
                "subsections": [
                    {
                        "name": "Methods",
                        "content": "If you set a new system locale all old system locale settings will be dropped and the new\nsettings will be saved to disk. The locale will also be passed to the system manager, and\nsubsequently started daemons will inherit the new system locale. Note that already running\ndaemons will not learn about the new value.\n\nThe SetVConsoleKeyboard() method may be used to set the key mapping for the virtual console.\nSimilarly, SetX11Keyboard() may be used to set the default key mapping of any X11 servers.\n\nNote that SetVConsoleKeyboard() instantly applies the new key mapping to the console, while\nSetX11Keyboard() simply sets a default that may be used by later sessions.\n\nThe boolean argument convert may be set to optionally convert the console keyboard\nconfiguration to X11 keyboard mappings and vice versa. If true and SetVConsoleKeyboard() is\nused, the nearest X11 keyboard setting for the chosen console setting is set. If true and\nSetX11Keyboard() is used, the nearest console keyboard setting for the chosen X11 setting is\nset. Hence, it is usually sufficient to call only one of the two functions.\n\nFor graphical UIs that need to set the system keyboard mapping simply invoke\nSetX11Keyboard(), set convert=true and ignore SetVConsoleKeyboard().\n\nUse the empty string for the keymap parameters you wish not to set.\n\nThe interactive boolean parameters can be used to control whether polkit[1] should\ninteractively ask the user for authentication credentials if required.\n"
                    },
                    {
                        "name": "Signals",
                        "content": "Whenever the system locale or keymap is changed via the daemon, PropertyChanged signals are\nsent out to which clients can subscribe.\n"
                    },
                    {
                        "name": "Properties",
                        "content": "The system locale is shown in the Locale property. It is an array containing\nenvironment-variable-assignment-like strings. The following strings are known: LANG=,\nLCCTYPE=, LCNUMERIC=, LCTIME=, LCCOLLATE=, LCMONETARY=, LCMESSAGES=, LCPAPER=,\nLCNAME=, LCADDRESS=, LCTELEPHONE=, LCMEASUREMENT=, LCIDENTIFICATION=.\n\nThe X11Layout, X11Model, X11Variant, and X11Options properties show values configurable with\nSetX11Keyboard() described above (or SetVConsoleKeyboard() with convert=true). The\nVConsoleKeymap and VConsoleKeymapToggle properties show values configurable with\nSetVConsoleKeyboard() (or SetX11Keyboard() with convert=true).\n"
                    },
                    {
                        "name": "Security",
                        "content": "Changing the system locale or keymap using this interface is authenticated via polkit. The\npolkit action for SetLocale() is org.freedesktop.locale1.set-locale. The polkit action for\nSetX11Keyboard() and SetVConsoleKeyboard() is org.freedesktop.locale1.set-keyboard.\n"
                    }
                ]
            },
            "EXAMPLES": {
                "content": "",
                "subsections": [
                    {
                        "name": "Example 1. Introspect org.freedesktop.locale1 on the bus",
                        "content": "$ gdbus introspect --system \\\n--dest org.freedesktop.locale1 \\\n--object-path /org/freedesktop/locale1\n\n"
                    }
                ]
            },
            "VERSIONING": {
                "content": "These D-Bus interfaces follow the usual interface versioning guidelines[2].\n",
                "subsections": []
            },
            "NOTES": {
                "content": "1. polkit\nhttps://www.freedesktop.org/software/polkit/docs/latest/\n\n2. the usual interface versioning guidelines\nhttp://0pointer.de/blog/projects/versioning-dbus.html\n\n\n\nsystemd 249                                                               ORG.FREEDESKTOP.LOCALE1(5)",
                "subsections": []
            }
        }
    }
}