diff --git a/contrib/README.md b/contrib/README.md index 45e266a..4ed8ea2 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -41,11 +41,16 @@ Supported platforms: Linux (required tools: `sysfs`) * if AC is connected, $1 returns "On", if not it returns "Off", if AC doesn't exist, $1 is "N/A" -vicious.contrib.ati - - provides various info about ATI GPU status - - takes card ID as an argument, i.e. "card0" (and where possible, +**vicious.contrib.ati** + +Provides various info about ATI GPU status. +Supported platforms: Linux (required tools: `sysfs`) + +- Arguments: + * takes card ID as an argument, i.e. "card0" (and where possible, uses debugfs to gather data on radeon power management) - - returns a table with string keys: {method}, {dpm_state}, +- Returns: + * a table with string keys: {method}, {dpm_state}, {dpm_perf_level}, {profile}, {engine_clock mhz}, {engine_clock khz}, {memory_clock mhz}, {memory_clock khz}, {voltage v}, {voltage mv} diff --git a/contrib/ati.lua b/contrib/ati_linux.lua similarity index 95% rename from contrib/ati.lua rename to contrib/ati_linux.lua index fd9932c..1afe8f9 100644 --- a/contrib/ati.lua +++ b/contrib/ati_linux.lua @@ -17,8 +17,8 @@ local string = { -- ATI: provides various info about ATI GPU status --- vicious.widgets.ati -local ati = {} +-- vicious.contrib.ati +local ati_linux = {} -- {{{ Define variables @@ -76,4 +76,4 @@ local function worker(format, warg) end -- }}} -return setmetatable(ati, { __call = function(_, ...) return worker(...) end }) +return setmetatable(ati_linux, { __call = function(_, ...) return worker(...) end })