From: Andrew Ruthven <andrew@cerberus.etc.gen.nz>
Date: Tue, 30 Oct 2007 22:10:30 +0000 (+1300)
Subject: Add a section to the perldoc which describes what is in the output.
X-Git-Tag: 0.2~6
X-Git-Url: http://git.etc.gen.nz/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4424a0864350df5f8bf0a1535b5f736fbf810873;p=mythtv-status.git

Add a section to the perldoc which describes what is in the output.
---

diff --git a/bin/mythtv-status b/bin/mythtv-status
index 7f9671a..a5cc18a 100755
--- a/bin/mythtv-status
+++ b/bin/mythtv-status
@@ -160,6 +160,32 @@ The port to use when connecting to MythTV, defaults to 6544.
 
 =back
 
+=head1 OUTPUT
+
+The output of this script is broken up into several chunks they are:
+
+=over
+
+=item Status
+
+Some general info about the backend, currently just the timestamp of then
+this program was run.
+
+=item Encoders
+
+Each encoder that the backend knows about are listed, with the hostname
+they are on, the encoder ID (in brackets) and the current status.
+
+=item Recording Now
+
+Any programs which are being recorded right now.
+
+=item Scheduled Recordings
+
+Up to 10 programs which are scheduled to be recorded today and tomorrow.
+
+=back
+
 =head1 AUTHOR
 
 Andrew Ruthven, andrew@etc.gen.nz