From 42b03b4e7166f53277260bc3ac7d7d343c9a7bd6 Mon Sep 17 00:00:00 2001 From: Siraaj Khandkar Date: Thu, 30 Aug 2018 12:52:35 -0400 Subject: [PATCH] Update README --- README.md | 36 +++++++++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 947e6ed..834d6ab 100644 --- a/README.md +++ b/README.md @@ -10,22 +10,34 @@ Experimental system-monitor and status (bar) reporter I use with Usage ----- -`make build && make install` +### Build -`make install` copies everything from `./bin` to `$HOME/bin` +`make build` + +### Install + +To copy everything from `./bin` to `$HOME/bin`: + +`make install` + +### Use In my `~/.xinitrc` I have something like the following: ```sh ( $BIN/khatus \ - --wifi_interface 'wlp3s0' \ + --wifi_interface 'wlp3s0' \ + --interval_bluetooth 5 \ + --interval_net_wifi 5 \ + --interval_disk_space 5 \ | stdbuf -o L tee \ >(stdbuf -o L "$BIN"/khatus_bar \ -v Opt_Mpd_Song_Max_Chars=10 \ - -v Opt_Net_Interfaces_To_Show=wlp3s0 \ -v Opt_Pulseaudio_Sink=0 \ - -f <(./bin/khatus_gen_make_status_bar \ - -v Status_Bar='@energy,@memory,@processes,@cpu,@disk,@net,@bluetooth,@backlight,@volume,@mpd,@weather,@datetime' \ + -v GC_Interval=1800 \ + -f <("$BIN"/khatus_gen_bar_make_status \ + -v Status_Fmt=' E=%s%% M=%d%% P=[%s %sr %sd %st %si %sz] C=[%s %s°C %srpm] D=[%s%% %s▲ %s▼] W=[%s %s▲ %s▼] B=%s *=%s%% (%s) [%s] %s°F %s ' \ + -v Status_Args='@energy_percent,@memory_percent,@processes_count_all,@processes_count_r,@processes_count_d,@processes_count_t,@processes_count_i,@processes_count_z,@cpu_loadavg,@cpu_temp,@cpu_fan_speed,@disk_space,@disk_io_w,@disk_io_r,@net_wifi:wlp3s0,@net_io_w:wlp3s0,@net_io_r:wlp3s0,@bluetooth_power,@backlight_percent,@volume_pa_sink:0,@mpd,@weather_temp_f,@datetime' \ ) \ | "$BIN"/khatus_actuate_status_bar_to_xsetroot_name \ ) \ @@ -35,8 +47,14 @@ In my `~/.xinitrc` I have something like the following: >(stdbuf -o L "$BIN"/khatus_monitor_errors \ | "$BIN"/khatus_actuate_alert_to_notify_send \ ) \ + >(stdbuf -o L "$BIN"/khatus_monitor_devices \ + | "$BIN"/khatus_actuate_alert_to_notify_send \ + ) \ + >(stdbuf -o L "$BIN"/khatus_actuate_device_add_to_automount \ + | "$BIN"/khatus_actuate_alert_to_notify_send \ + ) \ ) \ -2> >($BIN/twrap.sh >> $HOME/var/log/khatus/main.log) \ +2> >($BIN/twrap >> $KHATUS_LOGS_DIR/main.log) \ 1> /dev/null \ & ``` @@ -232,8 +250,8 @@ Redesign notes intervals at runtime (which seems like a better idea than the above in-memory DB one). -Ideas ------ +Idea grab bag +------------- - track devices: - alert when never before seen device is plugged-in -- 2.20.1