xbattmon

commit d71b0875d9e646f8b737e60bc18fe839b46f74db
parent 305732fdbaa696bfdb2a13790d6044aa3450d7a1
Author: sin <sin@2f30.org>
Date:   Sun,  2 Nov 2014 13:23:36 +0000

Add manpage

Diffstat:
M
Makefile
 | 
4
++++
A
xbattmon.1
 | 
44
++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 48 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -1,4 +1,5 @@
 PREFIX = /usr/local
+MANPREFIX = $(PREFIX)/man
 
 CFLAGS = -I/usr/X11R6/include
 LDLIBS = -L/usr/X11R6/lib -lX11 # -lbsd
@@ -16,9 +17,12 @@ xbattmon.o: config.h
 install: all
 	mkdir -p $(DESTDIR)$(PREFIX)/bin
 	cp -f $(BIN) $(DESTDIR)$(PREFIX)/bin
+	mkdir -p $(DESTDIR)$(MANPREFIX)/man1
+	cp -f $(BIN).1 $(DESTDIR)$(MANPREFIX)/man1
 
 uninstall:
 	rm -f $(DESTDIR)$(PREFIX)/bin/$(BIN)
+	rm -f $(DESTDIR)$(MANPREFIX)/man1/$(BIN).1
 
 clean:
 	rm -f $(BIN) $(OBJ)
diff --git a/xbattmon.1 b/xbattmon.1
@@ -0,0 +1,44 @@
+.Dd Oct 22, 2014
+.Dt XBATTMON 1
+.Os
+.Sh NAME
+.Nm xbattmon
+.Nd simple battery monitor
+.Sh SYNOPSIS
+.Nm xbattmon
+.Op Fl c Ar capacity
+.Op Fl i Ar interval
+.Op Fl p Ar bottom | top
+.Op Fl t Ar thickness
+.Sh DESCRIPTION
+.Nm
+is a simple battery monitor.  By default
+.Nm
+will assume a battery capacity of 100%, a poll interval of 5 seconds,
+a bar thickness of 2 pixels and a bottom placement.
+.Sh OPTIONS
+.Bl -tag
+.It Fl c Ar capacity
+Set the maximum battery capacity.
+.It Fl i Ar interval
+Set the battery poll interval in seconds.
+.It Fl p Ar bottom | top
+Set the bar placement.
+.It Fl t Ar thickness
+Set the bar thickness.
+.El
+.Sh CONFIGURATION
+You can tweak the colors
+.Nm
+will use by modifying `config.h' and recompiling the code.
+.Sh RATIONALE
+Some laptops either do not have a battery indicator or sometimes it is
+located on the back of the screen.  People who do not like to use status
+bars might find
+.Nm
+useful.
+.Sh PORTABILITY
+It currently works on OpenBSD and Linux.
+.Sh AUTHORS
+.Nm
+was written by sin <sin@2f30.org>.