--- awesome core API -- @author Julien Danjou <julien@danjou.info> -- @copyright 2008-2009 Julien Danjou -- @release @AWESOME_VERSION@ -- @module awesome --- awesome global table. -- -- @field version The version of awesome. -- @field release The release name of awesome. -- @field conffile The configuration file which has been loaded. -- @field startup True if we are still in startup, false otherwise. -- @field startup_errors Error message for errors that occured during startup. -- @field composite_manager_running True if a composite manager is running. -- @table awesome --- Quit awesome. -- -- @function quit --- Execute another application, probably a window manager, to replace -- awesome. -- -- @param cmd The command line to execute. -- @function exec --- Restart awesome. -- -- @name restart -- @class function --- Spawn a program. -- -- @param cmd The command to launch. Either a string or a table of strings. -- @param use_sn Use startup-notification, true or false, default to true. -- @return Process ID if everything is OK, or an error string if an error occured. --- Load an image -- -- @param name The file name -- @return A cairo image surface as light user datum -- @function load_image --- Register a new xproperty. -- -- @param name The name of the X11 property -- @param type One of "string", "number" or "boolean" -- @function register_xproperty --- Change a xproperty. -- -- @param name The name of the X11 property -- @param value The new value for the property -- @function set_xproperty --- Get the value of a xproperty. -- -- @param name The name of the X11 property -- @function get_xproperty --- Add a global signal. -- -- @param name A string with the event name. -- @param func The function to call. -- @function connect_signal --- Remove a global signal. -- -- @param name A string with the event name. -- @param func The function to call. -- @function disconnect_signal --- Emit a global signal. -- -- @param name A string with the event name. -- @param ... Signal arguments. -- @function emit_signal --- Switch keyboard layout group. -- @param num keyboard layout number, integer from 0 to 3 -- @function xkb_set_layout_group --- Get current keyboard layout group. -- @return current keyboard layout number -- @function xkb_get_layout_group --- Get description of configured layouts -- @return String with description of configured layouts -- @function xkb_get_group_names