From: Andrew Ruthven <andrew@etc.gen.nz>
Date: Sat, 19 Apr 2008 03:43:28 +0000 (+1200)
Subject: Write man pages for mythtv_recording_now and mythtv_recording_soon.
X-Git-Tag: 0.7.4~6
X-Git-Url: http://git.etc.gen.nz/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9080df08fa47fd79eb6d812501b54de0cf846030;p=mythtv-status.git

Write man pages for mythtv_recording_now and mythtv_recording_soon.
---

diff --git a/debian/rules b/debian/rules
index ab5c236..eec6dfd 100755
--- a/debian/rules
+++ b/debian/rules
@@ -38,7 +38,7 @@ binary-indep: install
 # Make sure we start after mythtv-backend
 	dh_installinit -- defaults 51
 	dh_installcron
-	dh_installman debian/mythtv-status.1
+	dh_installman debian/mythtv-status.1 man/*
 	dh_compress
 	dh_fixperms
 	dh_perl
diff --git a/man/mythtv_recording_now.1 b/man/mythtv_recording_now.1
new file mode 100644
index 0000000..76fc352
--- /dev/null
+++ b/man/mythtv_recording_now.1
@@ -0,0 +1,45 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH MYTHTV-RECORDING-NOW 1 "2008-04-19"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+mythtv_recording_now \- test whether a MythTV backend is recording now
+.SH SYNOPSIS
+.B mythtv_recording_now
+.SH DESCRIPTION
+.B mythtv_recording_now
+checks to see if a MythTV backend is recording now.
+It checks the host which is configured in 
+.I /etc/default/mythtv-status
+with the HOST setting.
+.SH OPTIONS
+None
+.SH "EXIT STATUS"
+.TP
+.B 0
+MythTV backend is recording
+.TP
+.B 1
+MythTV backend is not recording
+.SH FILES
+.B /etc/default/mythtv-status
+Config file
+.SH SEE ALSO
+.BR mythtv-status (1),
+.BR mythtv_recording_soon (1).
+.SH AUTHOR
+mythtv_recording_now and this manpage were written by Andrew Ruthven
+<andrew@etc.gen.nz>.
diff --git a/man/mythtv_recording_soon.1 b/man/mythtv_recording_soon.1
new file mode 100644
index 0000000..afebc0a
--- /dev/null
+++ b/man/mythtv_recording_soon.1
@@ -0,0 +1,51 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH MYTHTV-RECORDING-SOON 1 "2008-04-19"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+mythtv_recording_soon \- test whether a MythTV backend will be recording soon
+.SH SYNOPSIS
+.B mythtv_recording_soon
+[
+.I time in seconds
+]
+.SH DESCRIPTION
+.B mythtv_recording_soon
+checks to see if a MythTV backend is currently recording, or will be recording
+soon.  It checks the host which is configured in 
+.I /etc/default/mythtv-status
+with the HOST setting.
+.PP
+.I time in seconds
+is how long "soon" is considered to be.  It defaults to 600 (10 minutes).
+.SH OPTIONS
+None
+.SH "EXIT STATUS"
+.TP
+.B 0
+MythTV backend is recording now, or will be recording soon
+.TP
+.B 1
+MythTV backend is not recording now and won't be recording soon
+.SH FILES
+.B /etc/default/mythtv-status
+Config file
+.SH SEE ALSO
+.BR mythtv-status (1),
+.BR mythtv_recording_now (1).
+.SH AUTHOR
+mythtv_recording_soon and this manpage were written by Andrew Ruthven
+<andrew@etc.gen.nz>.