Permalink
Browse files

Added tmux-ping documentation

  • Loading branch information...
1 parent b011f08 commit baaa187ec4bb3b2e16d688fba40a13a2871a71c3 @lmartinking committed Mar 24, 2011
Showing with 45 additions and 3 deletions.
  1. +45 −3 README
View
@@ -4,13 +4,38 @@ tmux-applets
* tmux-cpu-freq - show cpu frequencies as coloured boxes
+ * tmux-ping - show results of pinging a host as coloured boxes
+
+
+Installation
+------------
+
+Edit the Makefile to your needs. You may wish to change the INSTALL_DIR
+and CFLAGS if you wish...
+
+Then run:
+ $ make
+ $ make install
+
+
+Usage in tmux
+-------------
+
+In ~/.tmux.conf, edit your status line:
+
+ set-status-right "#(/path/to/applet <arguments>) #(/path/to/applet2 <arguments>)"
+
+For example, in my configuration I have:
+
+ set-status-right "#(/home/lucas/bin/tmux-cpu-freq 6) "
+ set-status-interval 1
+
tmux-cpu-freq
-------------
- Usage (in ~/.tmux.conf):
- set-status-right "#(/path/to/tmux-cpu-freq <number-of-cpus>)"
- set-status-interval 1
+ Usage:
+ tmux-cpu-freq [<number-of-cpus>]
Or, you can edit NUMBER_CPUS in tmux-cpu-freq.c before compiling it.
@@ -19,3 +44,20 @@ and adjusting MAX_LEVEL_COLOURS if need be.
The reason this configuration is static is since tmux must run the applet
every frequency interval, thus speed is paramount.
+
+
+tmux-ping
+---------
+
+ Usage:
+ tmux-ping <host>
+
+You can change the colours by editing COLOUR_OKAY and COLOUR_ERROR in
+tmux-ping.c
+
+
+Contact
+-------
+
+Bug reports, etc can be sent to < lmartinking@gmail.com >, or you can use
+the github page at: < https://github.com/lmartinking/tmux-applets/issues >

0 comments on commit baaa187

Please sign in to comment.