pk
/
slstatus
mirror of https://github.com/pikami/slstatus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pikami's slstatus fork
165 Commits 2 Branches 0 Tags 566 KiB
C 95.7%
Makefile 3.4%
Roff 0.9%
Go to file
Aaron Marcher 1ad9f2504d hostname() null terminaiton subtraction *is* needed 2016-09-14 11:04:24 +02:00
.gitignore added config.def.h handling and fixed typo 2016-03-04 18:36:47 +01:00
CONTRIBUTING.md Formatting commit :( 2016-08-16 11:41:43 +02:00
CONTRIBUTORS.md Added myself to CONTRIBUTORS.md by drkh5h's request 2016-08-21 12:04:01 +03:00
LICENSE this project is now licensed under the ISC license 2016-08-15 16:10:42 +02:00
Makefile what kind of weed is that? 2016-09-05 02:17:30 +03:00
README.md battery_state() function added 2016-09-13 22:03:36 +02:00
TODO.md brought back update interval 2016-09-09 19:26:06 +02:00
concat.h used ccat() from concat.h for string concatenation 2016-09-08 04:31:49 +03:00
config.def.h battery_state() function added 2016-09-13 22:03:36 +02:00
config.mk bringed back the old config.mk 2016-09-05 01:40:47 +03:00
slstatus.c hostname() null terminaiton subtraction *is* needed 2016-09-14 11:04:24 +02:00
slstatus.png added my fancy icon 2016-09-09 21:12:13 +02:00
strlcat.h added bounds checking via secure strl*() routines 2016-08-21 00:00:23 +03:00
strlcpy.h added bounds checking via secure strl*() routines 2016-08-21 00:00:23 +03:00

README.md

slstatus

slstatus is a suckless and lightweight status monitor for window managers that use WM_NAME as statusbar (e.g. DWM). It is written in pure C without any system calls and only reads from files most of the time. It is meant to be a better alternative to Bash scripts (inefficient) and Conky (bloated for this use).

If you write a bash script that shows system information in WM_NAME, it executes a huge amount of external commands (top, free etc.) every few seconds. This results in high system resource usage. slstatus solves this problem by only using C libraries and/or reading from files in sysfs/procfs.

Looking at the LOC (lines of code) of the Conky project, very interesting: 28.346 lines C++, 219 lines Python and 110 lines Lua. slstatus currently has about 800 lines of clean documented C code and even includes additional possibilities as it can be customized and extended very easily. Configure it by customizing the config.h (C header file) which is secure and fast as no config files are parsed at runtime.

The following information is included:

  • Battery percentage/state
  • CPU usage (in percent)
  • Custom shell commands
  • Date and time
  • Disk[s] status (free storage, percentage, total storage and used storage)
  • Available entropy
  • username/gid/uid
  • Hostname
  • IP addresses
  • Load average
  • Memory status (free memory, percentage, total memory and used memory)
  • Temperature
  • Uptime
  • Volume percentage + mute status (alsa)
  • WiFi signal percentage and essid

Multiple entries per function are supported and everything can be reordered and customized via the C header file config.h (similar to DWM).

Usage

Installation

Before you continue, please be sure that a C compiler (preferrably gcc), GNU make and alsa-lib (for volume percentage) are installed. Then copy config.def.h to config.h and customize it to fit your needs. Recompile and install it after modifications:

$ make clean all
# make install

Starting

Write the following code to your ~/.xinitrc (or any other initialization script):

slstatus &

Contributing

In TODO.md there is a list of things that have to be done.

People who contributed are listed in CONTRIBUTORS.md.

For detailed information about coding style and restrictions see CONTRIBUTING.md

License

See LICENSE.