.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "App::Termcast 3pm"
.TH App::Termcast 3pm "2022-06-08" "perl v5.34.0" "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"
App::Termcast \- broadcast your terminal sessions for remote viewing
.SH "VERSION"
.IX Header "VERSION"
version 0.13
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  my $tc = App::Termcast\->new(user => \*(Aqfoo\*(Aq);
\&  $tc\->run(\*(Aqbash\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
App::Termcast is a client for the <http://termcast.org/> service, which allows
broadcasting of a terminal session for remote viewing.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "host"
.IX Subsection "host"
Server to connect to (defaults to noway.ratry.ru, the host for the termcast.org
service).
.SS "port"
.IX Subsection "port"
Port to use on the termcast server (defaults to 31337).
.SS "user"
.IX Subsection "user"
Username to use (defaults to the local username).
.SS "password"
.IX Subsection "password"
Password for the given user. The password is set the first time that username
connects, and must be the same every subsequent time. It is sent in plaintext
as part of the connection process, so don't use an important password here.
Defaults to 'asdf' since really, a password isn't all that important unless
you're worried about being impersonated.
.SS "bell_on_watcher"
.IX Subsection "bell_on_watcher"
Whether or not to send a bell to the terminal when a watcher connects or
disconnects. Defaults to false.
.SS "timeout"
.IX Subsection "timeout"
How long in seconds to use for the timeout to the termcast server. Defaults to
5.
.SH "METHODS"
.IX Header "METHODS"
.SS "establishment_message"
.IX Subsection "establishment_message"
Returns the string sent to the termcast server when connecting (typically
containing the username and password)
.SS "termsize_message"
.IX Subsection "termsize_message"
Returns the string sent to the termcast server whenever the terminal size
changes.
.ie n .SS "write_to_termcast $BUF"
.el .SS "write_to_termcast \f(CW$BUF\fP"
.IX Subsection "write_to_termcast $BUF"
Sends \f(CW$BUF\fR to the termcast server.
.ie n .SS "run @ARGV"
.el .SS "run \f(CW@ARGV\fP"
.IX Subsection "run @ARGV"
Runs the given command in the local terminal as though via \f(CW\*(C`system\*(C'\fR, but
streams all output from that command to the termcast server. The command may be
an interactive program (in fact, this is the most useful case).
.SH "TODO"
.IX Header "TODO"
Use MooseX::SimpleConfig to make configuration easier.
.SH "BUGS"
.IX Header "BUGS"
No known bugs.
.PP
Please report any bugs to GitHub Issues at
<https://github.com/doy/app\-termcast/issues>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<http://termcast.org/>
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find this documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc App::Termcast
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
MetaCPAN
.Sp
<https://metacpan.org/release/App\-Termcast>
.IP "\(bu" 4
Github
.Sp
<https://github.com/doy/app\-termcast>
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=App\-Termcast>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/App\-Termcast>
.SH "AUTHOR"
.IX Header "AUTHOR"
Jesse Luehrs <doy@tozt.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2014 by Jesse Luehrs.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.