1
0

Add examples to config.def.h

This commit is contained in:
Aaron Marcher 2018-05-02 12:30:16 +02:00
parent 54ebd0dabe
commit af3cdfbbc8

View File

@ -10,43 +10,46 @@ static const char unknown_str[] = "n/a";
#define MAXLEN 2048 #define MAXLEN 2048
/* /*
* function description argument * function description argument (example)
* *
* battery_perc battery percentage battery name * battery_perc battery percentage battery name (BAT0)
* battery_state battery charging state battery name * battery_state battery charging state battery name (BAT0)
* cpu_perc cpu usage in percent NULL * cpu_perc cpu usage in percent NULL
* cpu_iowait cpu iowait in percent NULL * cpu_iowait cpu iowait in percent NULL
* cpu_freq cpu frequency in MHz NULL * cpu_freq cpu frequency in MHz NULL
* datetime date and time format string * datetime date and time format string (%F %T)
* disk_free free disk space in GB mountpoint path * disk_free free disk space in GB mountpoint path (/)
* disk_perc disk usage in percent mountpoint path * disk_perc disk usage in percent mountpoint path (/)
* disk_total total disk space in GB mountpoint path * disk_total total disk space in GB mountpoint path (/")
* disk_used used disk space in GB mountpoint path * disk_used used disk space in GB mountpoint path (/)
* entropy available entropy NULL * entropy available entropy NULL
* gid GID of current user NULL * gid GID of current user NULL
* hostname hostname NULL * hostname hostname NULL
* ipv4 IPv4 address interface name * ipv4 IPv4 address interface name (eth0)
* ipv6 IPv6 address interface name * ipv6 IPv6 address interface name (eth0)
* kernel_release `uname -r` NULL * kernel_release `uname -r` NULL
* keyboard_indicators caps/num lock indicators NULL * keyboard_indicators caps/num lock indicators NULL
* load_avg load average format string * load_avg load average format string
* (%.2f %.2f %.2f)
* num_files number of files in a directory path * num_files number of files in a directory path
* (/home/foo/Inbox/cur)
* ram_free free memory in GB NULL * ram_free free memory in GB NULL
* ram_perc memory usage in percent NULL * ram_perc memory usage in percent NULL
* ram_total total memory size in GB NULL * ram_total total memory size in GB NULL
* ram_used used memory in GB NULL * ram_used used memory in GB NULL
* run_command custom shell command command * run_command custom shell command command (echo foo)
* swap_free free swap in GB NULL * swap_free free swap in GB NULL
* swap_perc swap usage in percent NULL * swap_perc swap usage in percent NULL
* swap_total total swap size in GB NULL * swap_total total swap size in GB NULL
* swap_used used swap in GB NULL * swap_used used swap in GB NULL
* temp temperature in degree celsius sensor file * temp temperature in degree celsius sensor file
* (/sys/class/thermal/...)
* uid UID of current user NULL * uid UID of current user NULL
* uptime system uptime NULL * uptime system uptime NULL
* username username of current user NULL * username username of current user NULL
* vol_perc OSS/ALSA volume in percent "/dev/mixer" * vol_perc OSS/ALSA volume in percent mixer file (/dev/mixer)
* wifi_perc WiFi signal in percent interface name * wifi_perc WiFi signal in percent interface name (wlan0)
* wifi_essid WiFi ESSID interface name * wifi_essid WiFi ESSID interface name (wlan0)
*/ */
static const struct arg args[] = { static const struct arg args[] = {
/* function format argument */ /* function format argument */