summaryrefslogtreecommitdiff
path: root/config.def.h
blob: 58e935a8a454b6c707b768fa8d4993eb97dbd615 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/* See LICENSE file for copyright and license details. */

/* interval between updates (in ms) */
const unsigned int interval = 1000;

/* text to show if no value can be retrieved */
static const char unknown_str[] = "n/a";

/* maximum output string length */
#define MAXLEN 2048

/*
 * function             description                     argument (example)
 *
 * battery_perc         battery percentage              battery name (BAT0)
 *                                                      NULL on OpenBSD
 * battery_state        battery charging state          battery name (BAT0)
 *                                                      NULL on OpenBSD
 * battery_remaining    battery remaining HH:MM         battery name (BAT0)
 *                                                      NULL on OpenBSD
 * 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        NULL
 * 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)
 * 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
 * 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 */
	{ datetime, "%s",           "%F %T" },
};