diff --git a/contrib/README.md b/contrib/README.md index cbbd184..db0cc83 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -85,11 +85,15 @@ vicious.contrib.openweather - returns a table with string keys: {city}, {wind deg}, {wind aim}, {wind kmh}, {wind mps}, {sky}, {weather}, {temp c}, {humid}, {press} -vicious.contrib.nvinf - - provides GPU utilization, core temperature, clock frequency information - about Nvidia GPU from nvidia-settings - - takes optional card ID as an argument, i.e. "1", or defaults to ID 0 - - returns first 4 values as usage of GPU core, memory, video engine and +**vicious.contrib.nvinf** + +provides GPU utilization, core temperature, clock frequency information about Nvidia GPU from nvidia-settings +Supported Platforms: platform independent + +- Arguments + * takes optional card ID as an argument, i.e. "1", or defaults to ID 0 +- Returns + * first 4 values as usage of GPU core, memory, video engine and PCIe bandwidth, 5th as temperature of requested graphics device, 6th as frequency of GPU core, 7th as memory transfer rate diff --git a/contrib/nvinf.lua b/contrib/nvinf_all.lua similarity index 89% rename from contrib/nvinf.lua rename to contrib/nvinf_all.lua index b277b78..35b1632 100644 --- a/contrib/nvinf.lua +++ b/contrib/nvinf_all.lua @@ -13,7 +13,7 @@ local helpers = require("vicious.helpers") -- vicious.widgets.nvinf -local nvinf = {} +local nvinf_all = {} -- {{{ NVIDIA infomation widget type @@ -32,4 +32,4 @@ local function worker(format, warg) end -- }}} -return setmetatable(nvinf, { __call = function(_, ...) return worker(...) end }) +return setmetatable(nvinf_all, { __call = function(_, ...) return worker(...) end })