2016-09-22 21:57:44 -04:00
|
|
|
.TH TUBES 1 tubes-1.1.1
|
2016-09-18 10:31:33 -04:00
|
|
|
.SH NAME
|
|
|
|
|
tubes \- irc pipes
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B tubes
|
|
|
|
|
.RB [ \-S ]
|
|
|
|
|
.RB [ \-s
|
|
|
|
|
.IR server ]
|
|
|
|
|
.RB [ \-p
|
|
|
|
|
.IR port ]
|
|
|
|
|
.RB [ \-v ]
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.B tubes
|
|
|
|
|
is a small daemon that provides a minimalistic interface for irc bots.
|
|
|
|
|
Messages to and from the server are represented by two FIFO buffers in /tmp.
|
|
|
|
|
For the default server (freenode) these would be chat.freenode.net.in and
|
|
|
|
|
chat.freenode.net.out for incoming and outgoing messages respectively.
|
|
|
|
|
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.TP
|
|
|
|
|
.B \-S
|
2016-09-18 19:08:34 -04:00
|
|
|
Use SSL (changes default port to 6697)
|
2016-09-18 10:31:33 -04:00
|
|
|
.TP
|
|
|
|
|
.BI \-s " server"
|
|
|
|
|
Use a host other than the default (chat.freenode.net)
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-p " port"
|
|
|
|
|
Use a port other than the default (6667)
|
|
|
|
|
.TP
|
|
|
|
|
.B \-v
|
2016-09-22 21:57:44 -04:00
|
|
|
Print version information and exit
|
2016-09-18 10:31:33 -04:00
|
|
|
|
|
|
|
|
.SH FILES
|
|
|
|
|
The incoming and outgoing FIFO buffers are stored in /tmp and are named for
|
|
|
|
|
the server tubes is connected to with .in or .out appended to the end.
|
2016-09-22 21:57:44 -04:00
|
|
|
~/.tubes.err is used to store an error string if tubes exits with -1.
|
2016-09-18 10:31:33 -04:00
|
|
|
.SH RETURN VALUE
|
2016-09-22 21:57:44 -04:00
|
|
|
Returns -1 on error, 0 on success.
|
2016-09-18 10:31:33 -04:00
|
|
|
.SH AUTHOR
|
|
|
|
|
Copyright \(co 2016 Thomas Mannay <audiobarrier@openmailbox.org>.
|
