luadoc/awesome.lua

   1 --- awesome core API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("awesome")
   5
   6 --- awesome global table.
   7 -- @field font The default font.
   8 -- @field font_height The default font height.
   9 -- @field fg The default foreground color.
  10 -- @field bg The default background color.
  11 -- @field version The version of awesome.
  12 -- #field release The release name of awesome.
  13 -- @field conffile The configuration file which has been loaded.
  14 -- @class table
  15 -- @name awesome
  16
  17 --- Quit awesome.
  18 -- @param -
  19 -- @name quit
  20 -- @class function
  21
  22 --- Execute another application, probably a window manager, to replace
  23 -- awesome.
  24 -- @param cmd The command line to execute.
  25 -- @name exec
  26 -- @class function
  27
  28 --- Restart awesome.
  29 -- @param -
  30 -- @name restart
  31 -- @class function
  32
  33 --- Spawn a program.
  34 -- @param cmd The command to launch.
  35 -- @param use_sn Use startup-notification, true or false, default to true.
  36 -- @param screen Optional screen number to spawn the command on.
  37 -- @return Process ID if everything is OK, or an error string if an error occured.
  38
  39 --- Add a global signal.
  40 -- @param name A string with the event name.
  41 -- @param func The function to call.
  42 -- @name add_signal
  43 -- @class function
  44
  45 --- Remove a global signal.
  46 -- @param name A string with the event name.
  47 -- @param func The function to call.
  48 -- @name remove_signal
  49 -- @class function
  50
  51 --- Emit a global signal.
  52 -- @param name A string with the event name.
  53 -- @param ... Signal arguments.
  54 -- @name emit_signal
  55 -- @class function