Add examples to config.def.h

diff --git a/config.def.h b/config.def.h
index d1cb995838351b0ba1fcd28ae0964469fb5d7071..f94e978ad5dd03ba06f9ecc282af13a964c1ad50 100644 (file)
--- a/config.def.h
+++ b/config.def.h
@@ -10,43 +10,46 @@ static const char unknown_str[] = "n/a";
 #define MAXLEN 2048
 
 /*
- * function             description                     argument
+ * function             description                     argument (example)
  *
- * battery_perc         battery percentage              battery name
- * battery_state        battery charging state          battery name
+ * battery_perc         battery percentage              battery name (BAT0)
+ * battery_state        battery charging state          battery name (BAT0)
  * cpu_perc             cpu usage in percent            NULL
  * cpu_iowait           cpu iowait 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
+ * 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
- * ipv6                 IPv6 address                    interface name
+ * ipv4                 IPv4 address                    interface name (eth0)
+ * ipv6                 IPv6 address                    interface name (eth0)
  * kernel_release       `uname -r`                      NULL
  * keyboard_indicators  caps/num lock indicators        NULL
  * load_avg             load average                    format string
+ *                                                      (%.2f %.2f %.2f)
  * 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
+ * run_command          custom shell command            command (echo foo)
  * 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/...)
  * 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
+ * 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 */