path: root/media-tv/mythtv-status/files/mythtv-status.1

.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MYTHTV-STATUS 1"
.TH MYTHTV-STATUS 1 "2012-07-07" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
mythtv\-status \- Display the status of a MythTV backend
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& mythtv\-status [options]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This script queries a MythTV backend and reports on the status of it,
any upcoming recordings and any which are happening right now.
.PP
The intention is to warn you if there is a program being recorded or
about to be recorded.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-c, \-\-colour\fR" 4
.IX Item "-c, --colour"
Use colour when showing the status of the encoder(s).
.IP "\fB\-d, \-\-description\fR" 4
.IX Item "-d, --description"
Display the description for the scheduled recordings.
.IP "\fB\-\-disk\-space\-warn\fR" 4
.IX Item "--disk-space-warn"
The threshold (in percent) of used disk space that we should show
the disk space in red (if using colour) or send an email if we're
in email mode with email only on warnings.
.IP "\fB\-\-encoder\-details\fR" 4
.IX Item "--encoder-details"
Display the input \s-1ID\s0 and channel name against the recording details.
.IP "\fB\-\-encoder\-skip\-idle\fR" 4
.IX Item "--encoder-skip-idle"
Suppress displaying idle encoders in the Encoders block.
.IP "\fB\-e, \-\-episode\fR" 4
.IX Item "-e, --episode"
Display the episode (subtitle) for the scheduled recordings.
.IP "\fB\-\-email <address>[ \-\-email <address> ...]\fR" 4
.IX Item "--email <address>[ --email <address> ...]"
Send the output to the listed email addresses.  By default the encoder status,
currently recording shows and time till next recording is surpressed from
the email.
.Sp
To turn the additional blocks on you can use \fB\-\-encoders\fR, \fB\-\-recording\-now\fR
and/or \fB\-\-next\-recording\fR.
.IP "\fB\-\-email\-only\-on\-alert\fR" 4
.IX Item "--email-only-on-alert"
Only send an email out (if \-\-email is present) if there is an alert
(i.e., schedule conflict or low disk space).
.IP "\fB\-?, \-\-help\fR" 4
.IX Item "-?, --help"
Display help.
.IP "\fB\-\-file <file>\fR" 4
.IX Item "--file <file>"
Load \s-1XML\s0 from the file specified instead of querying a MythTV backend.
Handy for debugging things.
.IP "\fB\-\-save\-file <file>\fR" 4
.IX Item "--save-file <file>"
Save the \s-1XML\s0 we received from the MythTV backend.
Handy for debugging things.
.IP "\fB\-\-guide\-days\-warn <days>\fR" 4
.IX Item "--guide-days-warn <days>"
Warn if the number of days of guide data present is equal to or below
this level.  Default is 2 days.
.IP "\fB\-h \s-1HOST\s0, \-\-host=HOST\fR" 4
.IX Item "-h HOST, --host=HOST"
The host to check, defaults to localhost.
.IP "\fB\-\-nostatus\fR, \fB\-\-noencoders\fR, \fB\-\-norecording\-now\fR, \fB\-\-noscheduled\-recordings\fR, \fB\-\-noschedule\-conflicts\fR, \fB\-\-nonext\-recording\fR, \fB\-\-nototal\-disk\-space\fR, \fB\-\-nodisk\-space\fR, \fB\-\-noguide\-data\fR, \fB\-\-noauto\-expire\fR" 4
.IX Item "--nostatus, --noencoders, --norecording-now, --noscheduled-recordings, --noschedule-conflicts, --nonext-recording, --nototal-disk-space, --nodisk-space, --noguide-data, --noauto-expire"
Suppress displaying blocks of the output if they would normally be displayed.
.IP "\fB\-p \s-1PORT\s0, \-\-port=PORT\fR" 4
.IX Item "-p PORT, --port=PORT"
The port to use when connecting to MythTV, defaults to 6544.
.IP "\fB\-\-oneliner\-bullets\fR" 4
.IX Item "--oneliner-bullets"
Insert asterisks (*) before each of the oneliners to stop some
email clients from thinking the oneliner block is a paragraph and
trying to word wrap them.
.IP "\fB\-\-auto\-expire\fR" 4
.IX Item "--auto-expire"
Display the shows due to auto expire (output is normally suppressed).
.IP "\fB\-\-auto\-expire\-count\fR" 4
.IX Item "--auto-expire-count"
How many of the auto expire shows to display, defaults to 10.
.IP "\fB\-\-recording\-in\-warn\fR" 4
.IX Item "--recording-in-warn"
If the \*(L"Next Recording In\*(R" time is less than this amount, display it
in red.  This in seconds, and defaults to 3600 (1 hour).
.IP "\fB\-\-verbose\fR" 4
.IX Item "--verbose"
Have slightly more verbose output.  This includes any warnings that might
be generated while parsing the \s-1XML\s0.
.IP "\fB\-v, \-\-version\fR" 4
.IX Item "-v, --version"
Show the version of mythtv-status and then exit.
.SH "OUTPUT"
.IX Header "OUTPUT"
The output of this script is broken up into several chunks they are:
.IP "Status" 4
.IX Item "Status"
Some general info about the backend, currently just the timestamp of when
this program was run.
.IP "Guide Data" 4
.IX Item "Guide Data"
The number of days of guide data is present.  By default it is only shown
if the number of days is below the warning level.  To show it regardless
of the warning level use \-\-guide\-data.
.IP "Encoders" 4
.IX Item "Encoders"
Each encoder that the backend knows about are listed, with the hostname
they are on, the encoder \s-1ID\s0 (in brackets) and the current status.
.IP "Recording Now" 4
.IX Item "Recording Now"
Any programs which are being recorded right now.
.IP "Scheduled Recordings" 4
.IX Item "Scheduled Recordings"
Up to 10 programs which are scheduled to be recorded today and tomorrow.
.IP "Schedule Conflicts" 4
.IX Item "Schedule Conflicts"
Any upcoming schedule conflicts (not just limited to today or tomorrow).
.IP "Shows due to Auto Expire" 4
.IX Item "Shows due to Auto Expire"
The shows which will be deleted and the order they'll be deleted if the
auto expirer kicks in.
.IP "Total Disk Space" 4
.IX Item "Total Disk Space"
The amount of disk space in total, and used by MythTV.
.IP "Next Recording In" 4
.IX Item "Next Recording In"
If there are no recordings currently happening, then the amount of time until
the next recording is displayed.
.IP "Disk Space" 4
.IX Item "Disk Space"
Details about each storage group that MythTV knows about.  By default this
only shows storage groups that are above the warning level.  Use
\&\fB\-\-disk\-space\fR to turn on display of all storage groups.
.SH "RETURN CODES"
.IX Header "RETURN CODES"
mythtv-status provides some return codes.
.IP "0" 4
Standard return code
.IP "1" 4
.IX Item "1"
A warning is generated
.SH "AUTHOR"
.IX Header "AUTHOR"
Andrew Ruthven, andrew@etc.gen.nz
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2007\-2009 Andrew Ruthven <andrew@etc.gen.nz>
This code is hereby licensed for public consumption under the \s-1GNU\s0 \s-1GPL\s0 v3.