debian: correctly build an i3status-common package, split up manpages

10 files changed, 380 insertions, 40 deletions

diff --git a/debian/control b/debian/control
index 68993a1..f2f1bf5 100644
--- a/debian/control
+++ b/debian/control
@@ -7,11 +7,20 @@ Build-Depends: debhelper (>= 5)
 Standards-Version: 3.8.2
 Homepage: http://i3.zekjur.net/i3status
 
+Package: i3status-common
+Architecture: all
+Priority: optional
+Section: utils
+Depends: ${misc:Depends}
+Description: Common files for i3status and i3status-wmii
+ This package contains the configuration file and documentation for i3status
+ and i3status-wmii.
+
 Package: i3status
 Architecture: any
 Priority: optional
 Section: utils
-Depends: ${shlibs:Depends}, ${misc:Depends}
+Depends: ${shlibs:Depends}, ${misc:Depends}, i3status-common
 Recommends: dzen2
 Description: Generates a status line for dzen2
  i3status is a program running in background feeding dzen2 with information
@@ -22,7 +31,7 @@ Package: i3status-wmii
 Architecture: any
 Priority: optional
 Section: utils
-Depends: ${shlibs:Depends}, ${misc:Depends}
+Depends: ${shlibs:Depends}, ${misc:Depends}, i3status-common
 Recommends: wmii
 Description: Generates a status line for wmii
  i3status is a program running in background, filling up wmii's status bar
diff --git a/debian/i3status-common.files b/debian/i3status-common.files
new file mode 100644
index 0000000..17f6cce
--- /dev/null
+++ b/debian/i3status-common.files
@@ -0,0 +1 @@
+etc/i3status.conf
diff --git a/debian/i3status-wmii.1 b/debian/i3status-wmii.1
new file mode 100644
index 0000000..9e8ba40
--- /dev/null
+++ b/debian/i3status-wmii.1
@@ -0,0 +1,158 @@
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+
+.TH i3status 1 "MAY 2009" Linux "User Manuals"
+
+.SH NAME
+i3status \- Generates a status line for wmii
+.SH SYNOPSIS
+.B i3status
+.RB [\|\-c
+.IR configfile \|]
+
+.SH DESCRIPTION
+
+.B i3status
+is a small program (around 500 SLOC) for filling wmii's status bar via its 9P
+pseudo filesystem. It is designed to be very efficient by issuing a very
+small number of systemcalls (as the bar should be updated every second or at
+your specified interval). This ensures that even under high load, your status bar
+is updated correctly and it saves a little bit of battery life by not spawning
+new processes every second like shell scripts do.
+
+.SH CONFIGURATION
+.TP
+.B wlan
+Specifies the name of your WLAN interface (e.g. wlan0 or ath0 or eth1). Don't
+specify if you don't have a WLAN interface or if it should not be displayed.
+
+.TP
+.B eth
+Specifies the name of your ethernet interface (e.g. eth0). Don't specify if you
+don't have an ethernet interface or if it should not be displayed.
+
+.TP
+.B wmii_path
+Specifies the path to the rbar-folder of your mounted wmii pseudo file system
+(e.g. /mnt/wmii/rbar/). It has to be terminated by a slash.
+
+.TP
+.B time_format
+Format for the time/date to be displayed. See strftime(3) or date(1). Don't
+specify it if you don't want the time to be shown.
+
+.TP
+.B battery
+The number of the battery you want to display. This option can be specified
+multiple times to display multiple batteries. Don't specify it if you don't
+have a battery. To get the number of the specific battery, see
+/sys/class/power_supply/BAT*
+
+If you want i3status to use the last full capacity instead of the design capacity
+of the battery, specify the f-flag, like this:
+
+.Vb 10
+# Use the last full capacity
+battery 0,f
+.Ve
+
+.TP
+.B run_watch
+You can specify this directive multiple times. Each line first has a name (one
+word, separated by space) followed by a path (can contain wildcards, given to
+glob(3)). The path is the path to a PID-file which contains just the process ID
+of a process. i3status will then check if the process is still running and
+displays "yes" or "no" depending on the status. This is useful for displaying
+if your VPN is running, or dhclient for DHCP and so on...
+
+.TP
+.B order
+Followed by a comma separated list of the modules (run, wlan, eth, battery,
+load, time) this directive specifies the order of the information which should
+be displayed. An order is accomplished by prefixing the files in wmii's /rbar
+directory with a number, that is 0VPN, 1DHCP, 2time and so on..
+
+.TP
+.B color
+If specified, color mode is on. This affects WLAN which will be displayed red
+if WLAN is down and the run_watch system which will display the status in
+red/green.
+
+.TP
+.B get_ethspeed
+Get current speed of the ethernet interface using the same mechanism as
+ethtool. You need to start i3status with root privileges to use this.
+
+.TP
+.B get_cpu_temperature
+Gets the temperature of the first thermal zone or the specified thermal zone
+(if any). Use it to display your CPU temperature.
+
+.TP
+.B normcolors
+Specifies the colors for background/border in the same format (html colorcodes)
+as wmii's configuration (just the last two values), that is #222222 #333333 for
+example. Text color will be determined automatically (red/green/#888888),
+depending on context.
+
+.TP
+.B interval
+Specifies the interval in which the status bar will be updated. If you got a
+very slow system or feel you don't need so much information, you may want to
+increase it.
+
+.SH FILES
+.TP
+.B /etc/i3status.conf
+System-wide configuration file.
+
+.SH EXAMPLE CONFIGURATION
+.PP
+.Vb 10
+\&wlan wlan0
+\&eth eth0
+\&wmii_path /mnt/wmii/rbar/
+\&time_format %d.%m.%Y %H:%M:%S
+\&battery 0
+\&battery 1,f
+\&run_watch DHCP /var/run/dhclient*.pid
+\&run_watch VPN /var/run/vpnc*.pid
+\&order run,wlan,eth,battery,load,time
+\&normcolors #000000 #333333
+\&color
+\&get_cpu_temperature
+.Ve
+
+.SH MOUNTING WMII'S PSEUDO FILESYSTEM
+As of now (February 2009, Linux 2.6.28) you can mount wmii's 9P pseudo filesystem using:
+.PP
+.Vb 3
+mount -t 9p -o rw,trans=unix,uname=michael,dfltuid=1000,dfltgid=50,name=michael,noauto,noextend /tmp/ns.michael.:0/wmii /mnt/wmii 
+# Perhaps you need to load module 9pnet_fd if that does not work
+modprobe 9pnet_fd
+.Ve
+
+.SH BUGS
+Sometimes, i3status crashes when the wlan interface vanishes (killswitch). I
+haven't yet found the bug, as it is not reproducible. If you can reproduce
+this, please fix it and send me a patch.
+
+.SH SEE ALSO
+.BR strftime (3),
+.BR date (1),
+.BR glob (3)
+
+.SH AUTHORS
+Michael Stapelberg <michael+i3status at stapelberg dot de>
+
+Thorsten Toepper <atsutane at freethoughts dot de>
+
+.SH WEBSITE
+See http://i3.zekjur.net/i3status for the newest release.
diff --git a/debian/i3status-wmii.init b/debian/i3status-wmii.init
index 9b5ea6d..dcfe84e 100755
--- a/debian/i3status-wmii.init
+++ b/debian/i3status-wmii.init
@@ -1,13 +1,13 @@
 #!/bin/sh
 #
 ### BEGIN INIT INFO
-# Provides:          i3status
+# Provides:          i3status-wmii
 # Required-Start:
 # Required-Stop:
 # Default-Start:     2 3 4 5
 # Default-Stop:      0 1 6
-# Short-Description: Generates a status line for dzen2 or wmii
-# Description:       Generates a status line for dzen2 or wmii
+# Short-Description: Generates a status line for wmii
+# Description:       Generates a status line for wmii
 ### END INIT INFO
 
 # For the pidfile, you must be root. i3status itself runs as user just fine
@@ -16,17 +16,17 @@
 . /lib/lsb/init-functions
 
 case "$1" in
-start)	log_daemon_msg "Starting wmii status bar filler" "i3status"
-	start-stop-daemon --start --background --quiet --make-pidfile --pidfile /var/run/i3status.pid --name i3status --startas /usr/bin/i3status
+start)	log_daemon_msg "Starting wmii status bar filler" "i3status-wmii"
+	start-stop-daemon --start --background --quiet --make-pidfile --pidfile /var/run/i3status-wmii.pid --name i3status-wmii --startas /usr/bin/i3status-wmii
 	log_end_msg $?
 	;;
-stop)	log_daemon_msg "Stopping wmii status bar filler" "i3status"
-	start-stop-daemon --stop --quiet --pidfile /var/run/i3status.pid --name i3status
+stop)	log_daemon_msg "Stopping wmii status bar filler" "i3status-wmii"
+	start-stop-daemon --stop --quiet --pidfile /var/run/i3status-wmii.pid --name i3status-wmii
 	log_end_msg $?
 	;;
-restart|reload|force-reload)	log_daemon_msg "Restarting wmii status bar filler" "i3status"
-	start-stop-daemon --stop --retry 5 --quiet --pidfile /var/run/i3status.pid --name i3status
-	start-stop-daemon --start --background --quiet --make-pidfile --pidfile /var/run/i3status.pid --name i3status --startas /usr/bin/i3status
+restart|reload|force-reload)	log_daemon_msg "Restarting wmii status bar filler" "i3status-wmii"
+	start-stop-daemon --stop --retry 5 --quiet --pidfile /var/run/i3status-wmii.pid --name i3status-wmii
+	start-stop-daemon --start --background --quiet --make-pidfile --pidfile /var/run/i3status-wmii.pid --name i3status-wmii --startas /usr/bin/i3status-wmii
 	;;
 *)	log_action_msg "Usage: $0 {start|stop|restart|reload|force-reload}"
 	exit 2
diff --git a/debian/i3status-wmii.manpages b/debian/i3status-wmii.manpages
new file mode 100644
index 0000000..1fd96bb
--- /dev/null
+++ b/debian/i3status-wmii.manpages
@@ -0,0 +1 @@
+debian/i3status-wmii.1
diff --git a/debian/i3status.1 b/debian/i3status.1
new file mode 100644
index 0000000..894f6da
--- /dev/null
+++ b/debian/i3status.1
@@ -0,0 +1,142 @@
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+
+.TH i3status 1 "JUNE 2009" Linux "User Manuals"
+
+.SH NAME
+i3status \- Generates a status line for dzen2
+.SH SYNOPSIS
+.B i3status
+.RB [\|\-c
+.IR configfile \|]
+
+.SH DESCRIPTION
+
+.B i3status
+is a small program (around 500 SLOC) for filling dzen2. It is designed to be
+very efficient by issuing a very small number of systemcalls (as the bar should
+be updated every second or at your specified interval). This ensures that even
+under high load, your status bar is updated correctly and it saves a little bit
+of battery life by not spawning new processes every second like shell scripts do.
+
+.SH CONFIGURATION
+.TP
+.B wlan
+Specifies the name of your WLAN interface (e.g. wlan0 or ath0 or eth1). Don't
+specify if you don't have a WLAN interface or if it should not be displayed.
+
+.TP
+.B eth
+Specifies the name of your ethernet interface (e.g. eth0). Don't specify if you
+don't have an ethernet interface or if it should not be displayed.
+
+.TP
+.B time_format
+Format for the time/date to be displayed. See strftime(3) or date(1). Don't
+specify it if you don't want the time to be shown.
+
+.TP
+.B battery
+The number of the battery you want to display. This option can be specified
+multiple times to display multiple batteries. Don't specify it if you don't
+have a battery. To get the number of the specific battery, see
+/sys/class/power_supply/BAT*
+
+If you want i3status to use the last full capacity instead of the design capacity
+of the battery, specify the f-flag, like this:
+
+.Vb 10
+# Use the last full capacity
+battery 0,f
+.Ve
+
+.TP
+.B run_watch
+You can specify this directive multiple times. Each line first has a name (one
+word, separated by space) followed by a path (can contain wildcards, given to
+glob(3)). The path is the path to a PID-file which contains just the process ID
+of a process. i3status will then check if the process is still running and
+displays "yes" or "no" depending on the status. This is useful for displaying
+if your VPN is running, or dhclient for DHCP and so on...
+
+.TP
+.B order
+Followed by a comma separated list of the modules (run, wlan, eth, battery,
+load, time) this directive specifies the order of the information which should
+be displayed. An order is accomplished by prefixing the files in wmii's /rbar
+directory with a number, that is 0VPN, 1DHCP, 2time and so on..
+
+.TP
+.B color
+If specified, color mode is on. This affects WLAN which will be displayed red
+if WLAN is down and the run_watch system which will display the status in
+red/green.
+
+.TP
+.B get_ethspeed
+Get current speed of the ethernet interface using the same mechanism as
+ethtool. You need to start i3status with root privileges to use this.
+
+.TP
+.B get_cpu_temperature
+Gets the temperature of the first thermal zone or the specified thermal zone
+(if any). Use it to display your CPU temperature.
+
+.TP
+.B normcolors
+Specifies the colors for background/border in the same format (html colorcodes)
+as wmii's configuration (just the last two values), that is #222222 #333333 for
+example. Text color will be determined automatically (red/green/#888888),
+depending on context.
+
+.TP
+.B interval
+Specifies the interval in which the status bar will be updated. If you got a
+very slow system or feel you don't need so much information, you may want to
+increase it.
+
+.SH FILES
+.TP
+.B /etc/i3status.conf
+System-wide configuration file.
+
+.SH EXAMPLE CONFIGURATION
+.PP
+.Vb 10
+\&wlan wlan0
+\&eth eth0
+\&time_format %d.%m.%Y %H:%M:%S
+\&battery 0
+\&battery 1,f
+\&run_watch DHCP /var/run/dhclient*.pid
+\&run_watch VPN /var/run/vpnc*.pid
+\&order run,wlan,eth,battery,load,time
+\&normcolors #000000 #333333
+\&color
+\&get_cpu_temperature
+.Ve
+
+.SH BUGS
+Sometimes, i3status crashes when the wlan interface vanishes (killswitch). I
+haven't yet found the bug, as it is not reproducible. If you can reproduce
+this, please fix it and send me a patch.
+
+.SH SEE ALSO
+.BR strftime (3),
+.BR date (1),
+.BR glob (3)
+
+.SH AUTHORS
+Michael Stapelberg <michael+i3status at stapelberg dot de>
+
+Thorsten Toepper <atsutane at freethoughts dot de>
+
+.SH WEBSITE
+See http://i3.zekjur.net/i3status for the newest release.
diff --git a/debian/i3status.README.Debian b/debian/i3status.README.Debian
new file mode 100644
index 0000000..94b9d6f
--- /dev/null
+++ b/debian/i3status.README.Debian
@@ -0,0 +1,5 @@
+It is recommended to start i3status after starting your window manage, ideally
+using your window manager's configuration file.
+
+Launching i3status in combination with dzen2 could look like this:
+i3status | dzen2 -fg white -ta r -w 1280 -dock
diff --git a/debian/i3status.files b/debian/i3status.files
new file mode 100644
index 0000000..097923b
--- /dev/null
+++ b/debian/i3status.files
@@ -0,0 +1 @@
+usr/*
diff --git a/debian/i3status.manpages b/debian/i3status.manpages
new file mode 100644
index 0000000..7eca7cf
--- /dev/null
+++ b/debian/i3status.manpages
@@ -0,0 +1 @@
+debian/i3status.1
diff --git a/debian/rules b/debian/rules
index 82bdb4b..839c7ea 100755
--- a/debian/rules
+++ b/debian/rules
@@ -35,52 +35,74 @@ install-i3status: build-i3status
 	dh_testroot
 	dh_installdirs
 	$(MAKE) DESTDIR=$(CURDIR)/debian/i3status/ install
+	# Delete files which are in i3status-common
+	rm -rf $(CURDIR)/debian/i3status/etc
+	rm -rf $(CURDIR)/debian/i3status/usr/share/man
 
 install-i3status-wmii: build-i3status-wmii
 	dh_testdir
 	dh_testroot
 	dh_installdirs
 	$(MAKE) DESTDIR=$(CURDIR)/debian/i3status-wmii/ install
+	mv $(CURDIR)/debian/i3status-wmii/usr/bin/i3status $(CURDIR)/debian/i3status-wmii/usr/bin/i3status-wmii
+	mv $(CURDIR)/debian/i3status-wmii/usr/share/man/man1/i3status.1 $(CURDIR)/debian/i3status-wmii/usr/share/man/man1/i3status-wmii.1
+	# Delete files which are in i3status-common
+	rm $(CURDIR)/debian/i3status-wmii/etc/i3status.conf
+	rm -rf $(CURDIR)/debian/i3status-wmii/usr/share/man
 
 binary-indep: build install
+	mkdir -p $(CURDIR)/debian/i3status-common/etc
+	cp $(CURDIR)/i3status.conf $(CURDIR)/debian/i3status-common/etc/i3status.conf
+	dh_testdir
+	dh_testroot
+	dh_installchangelogs -pi3status-common
+	dh_installdocs -pi3status-common
+	dh_installexamples -pi3status-common
+	dh_installinit -pi3status-common
+	dh_link -pi3status-common
+	dh_strip -pi3status-common
+	dh_compress -pi3status-common
+	dh_fixperms -pi3status-common
+	dh_installdeb -pi3status-common
+	dh_shlibdeps -pi3status-common
+	dh_gencontrol -pi3status-common
+	dh_md5sums -pi3status-common
+	dh_builddeb -pi3status-common
 
 binary-arch: binary-i3status binary-i3status-wmii
 
 binary-i3status: build-i3status
 	dh_testdir
 	dh_testroot
-	dh_installchangelogs
-	dh_installdocs
-	dh_installexamples
-	dh_installinit
-	dh_installman
-	dh_link
-	dh_strip
-	dh_compress
-	dh_fixperms
-	dh_installdeb
-	dh_shlibdeps
-	dh_gencontrol
-	dh_md5sums
-	dh_builddeb
+	dh_installchangelogs -pi3status
+	dh_installdocs -pi3status
+	dh_installman -pi3status
+	dh_link -pi3status
+	dh_strip -pi3status
+	dh_compress -pi3status
+	dh_fixperms -pi3status
+	dh_installdeb -pi3status
+	dh_shlibdeps -pi3status
+	dh_gencontrol -pi3status
+	dh_md5sums -pi3status
+	dh_builddeb -pi3status
 
 binary-i3status-wmii: build-i3status-wmii
 	dh_testdir
 	dh_testroot
-	dh_installchangelogs
-	dh_installdocs
-	dh_installexamples
-	dh_installinit
-	dh_installman
-	dh_link
-	dh_strip
-	dh_compress
-	dh_fixperms
-	dh_installdeb
-	dh_shlibdeps
-	dh_gencontrol
-	dh_md5sums
-	dh_builddeb
+	dh_installchangelogs -pi3status-wmii
+	dh_installdocs -pi3status-wmii
+	dh_installinit -pi3status-wmii
+	dh_installman -pi3status-wmii
+	dh_link -pi3status-wmii
+	dh_strip -pi3status-wmii
+	dh_compress -pi3status-wmii
+	dh_fixperms -pi3status-wmii
+	dh_installdeb -pi3status-wmii
+	dh_shlibdeps -pi3status-wmii
+	dh_gencontrol -pi3status-wmii
+	dh_md5sums -pi3status-wmii
+	dh_builddeb -pi3status-wmii
 
 binary: binary-indep binary-arch
 .PHONY: build clean binary-indep binary-arch binary install