Pipe fitting
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

37 lines
1005B

  1. .TH TUBES 1 tubes-1.2.1
  2. .SH NAME
  3. tubes \- irc pipes
  4. .SH SYNOPSIS
  5. .B tubes
  6. .RB [ \-S ]
  7. .RB [ \-s
  8. .IR server ]
  9. .RB [ \-p
  10. .IR port ]
  11. .SH DESCRIPTION
  12. .B tubes
  13. is a small daemon that provides a minimalistic interface for irc bots.
  14. Messages to and from the server are represented by two FIFO buffers in /tmp.
  15. For the default server (freenode) these would be chat.freenode.net.in and
  16. chat.freenode.net.out for incoming and outgoing messages respectively.
  17. .SH OPTIONS
  18. .TP
  19. .B \-S
  20. Use SSL (changes default port to 6697)
  21. .TP
  22. .BI \-s " server"
  23. Use a host other than the default (chat.freenode.net)
  24. .TP
  25. .BI \-p " port"
  26. Use a port other than the default (6667)
  27. .SH FILES
  28. The incoming and outgoing FIFO buffers are stored in /tmp and are named for
  29. the server tubes is connected to with .in or .out appended to the end.
  30. ~/.tubes.err is used to store an error string if tubes exits with -1.
  31. .SH RETURN VALUE
  32. Returns -1 on error, 0 on success.
  33. .SH AUTHOR
  34. Copyright \(co 2016 Thomas Mannay <audiobarrier@openmailbox.org>.