Xinqi Bao's Git

Merge branch 'master' into master
[slstatus.git] / README.md
index d2de582..93b7b12 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,12 +17,13 @@ The following information is included:
 - Username/GID/UID
 - Hostname
 - IP addresses
+- Kernel version
 - Load averages
 - Memory status (free memory, percentage, total memory and used memory)
 - Swap status (free swap, percentage, total swap and used swap)
 - Temperature
 - Uptime
-- Volume percentage (ALSA)
+- Volume percentage (OSS/ALSA)
 - WiFi signal percentage and ESSID
 
 Multiple entries per function (e.g. multiple batteries) are supported and everything can be reordered and customized via a C header file (similar to other suckless programs).
@@ -49,6 +50,16 @@ If you use any other status bar or window manager you will have to figure it out
 
        slstatus -o | other_status_bar &
 
+### Specific function quirks
+
+- Volume percentage
+
+If there is no `/dev/mixer` on your system and you use ALSA, it means you have to load the OSS compatibility module by issuing:
+
+```
+# modprobe snd-pcm-oss
+```
+
 ## Contributing
 
 Hunt FIXME's in the code or do WTF you want! If it is useful, I will merge.