X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/8f5219b6dab5a1c9b7f92362a34aacfd393fa0e4..d1b23e5509863fd0790261b2b388e687d5218d53:/config.def.h

diff --git a/config.def.h b/config.def.h
index f4a6bed..0895f6a 100644
--- a/config.def.h
+++ b/config.def.h
@@ -1,7 +1,7 @@
 /* See LICENSE file for copyright and license details. */
 
 /* interval between updates (in ms) */
-static const int interval = 1000;
+const unsigned int interval = 1000;
 
 /* text to show if no value can be retrieved */
 static const char unknown_str[] = "n/a";
@@ -10,47 +10,59 @@ static const char unknown_str[] = "n/a";
 #define MAXLEN 2048
 
 /*
- * function             description                     argument
+ * function            description                     argument (example)
  *
- * battery_perc         battery percentage              battery name
- * battery_power        battery power usage             battery name
- * battery_state        battery charging state          battery name
- * cpu_perc             cpu usage in percent            NULL
- * cpu_freq             cpu frequency in MHz            NULL
- * datetime             date and time                   format string
- * disk_free            free disk space in GB           mountpoint path
- * disk_perc            disk usage in percent           mountpoint path
- * disk_total           total disk space in GB          mountpoint path
- * disk_used            used disk space in GB           mountpoint path
- * entropy              available entropy               NULL
- * gid                  GID of current user             NULL
- * hostname             hostname                        NULL
- * ipv4                 IPv4 address                    interface name
- * ipv6                 IPv6 address                    interface name
- * kernel_release       `uname -r`                      NULL
- * keyboard_indicators  caps/num lock indicators        NULL
- * load_avg             load average                    NULL
- * num_files            number of files in a directory  path
- * ram_free             free memory in GB               NULL
- * ram_perc             memory usage in percent         NULL
- * ram_total            total memory size in GB         NULL
- * ram_used             used memory in GB               NULL
- * run_command          custom shell command            command
- * swap_free            free swap in GB                 NULL
- * swap_perc            swap usage in percent           NULL
- * swap_total           total swap size in GB           NULL
- * swap_used            used swap in GB                 NULL
- * temp                 temperature in degree celsius   sensor file
- * uid                  UID of current user             NULL
- * uptime               system uptime                   NULL
- * username             username of current user        NULL
- * vol_perc             OSS/ALSA volume in percent      "/dev/mixer"
- * wifi_perc            WiFi signal in percent          interface name
- * wifi_essid           WiFi ESSID                      interface name
+ * battery_perc        battery percentage              battery name (BAT0)
+ *                                                     NULL on OpenBSD/FreeBSD
+ * battery_state       battery charging state          battery name (BAT0)
+ *                                                     NULL on OpenBSD/FreeBSD
+ * battery_remaining   battery remaining HH:MM         battery name (BAT0)
+ *                                                     NULL on OpenBSD/FreeBSD
+ * cpu_perc            cpu usage in percent            NULL
+ * cpu_freq            cpu frequency in MHz            NULL
+ * datetime            date and time                   format string (%F %T)
+ * disk_free           free disk space in GB           mountpoint path (/)
+ * disk_perc           disk usage in percent           mountpoint path (/)
+ * disk_total          total disk space in GB          mountpoint path (/")
+ * disk_used           used disk space in GB           mountpoint path (/)
+ * entropy             available entropy               NULL
+ * gid                 GID of current user             NULL
+ * hostname            hostname                        NULL
+ * ipv4                IPv4 address                    interface name (eth0)
+ * ipv6                IPv6 address                    interface name (eth0)
+ * kernel_release      `uname -r`                      NULL
+ * keyboard_indicators caps/num lock indicators        format string (c?n?)
+ *                                                     see keyboard_indicators.c
+ * keymap              layout (variant) of current     NULL
+ *                     keymap
+ * load_avg            load average                    NULL
+ * netspeed_rx         receive network speed           interface name (wlan0)
+ * netspeed_tx         transfer network speed          interface name (wlan0)
+ * num_files           number of files in a directory  path
+ *                                                     (/home/foo/Inbox/cur)
+ * ram_free            free memory in GB               NULL
+ * ram_perc            memory usage in percent         NULL
+ * ram_total           total memory size in GB         NULL
+ * ram_used            used memory in GB               NULL
+ * run_command         custom shell command            command (echo foo)
+ * separator           string to echo                  NULL
+ * swap_free           free swap in GB                 NULL
+ * swap_perc           swap usage in percent           NULL
+ * swap_total          total swap size in GB           NULL
+ * swap_used           used swap in GB                 NULL
+ * temp                temperature in degree celsius   sensor file
+ *                                                     (/sys/class/thermal/...)
+ *                                                     NULL on OpenBSD
+ *                                                     thermal zone on FreeBSD
+ *                                                     (tz0, tz1, etc.)
+ * uid                 UID of current user             NULL
+ * uptime              system uptime                   NULL
+ * username            username of current user        NULL
+ * vol_perc            OSS/ALSA volume in percent      mixer file (/dev/mixer)
+ * wifi_perc           WiFi signal in percent          interface name (wlan0)
+ * wifi_essid          WiFi ESSID                      interface name (wlan0)
  */
 static const struct arg args[] = {
 	/* function format          argument */
-	{ cpu_perc, "[CPU %3s%%] ", NULL    },
-	{ ram_perc, "[RAM %2s%%] ", NULL    },
-	{ datetime, "[ %s ]",       "%F %T" },
+	{ datetime, "%s",           "%F %T" },
 };