]> git.etc.gen.nz Git - mythtv-status.git/commitdiff
Add a section to the perldoc which describes what is in the output.
authorAndrew Ruthven <andrew@cerberus.etc.gen.nz>
Tue, 30 Oct 2007 22:10:30 +0000 (11:10 +1300)
committerAndrew Ruthven <andrew@cerberus.etc.gen.nz>
Tue, 30 Oct 2007 22:10:30 +0000 (11:10 +1300)
bin/mythtv-status

index 7f9671a1e09b3f2eac1fd2d74df07ff3821baf40..a5cc18a712557fdc82cf07119d14a4cb45d206f6 100755 (executable)
@@ -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