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.

40 lines
1.0KB

  1. .TH TUBES 1 tubes-1.4.2
  2. .SH NAME
  3. tubes \- irc pipes
  4. .SH SYNOPSIS
  5. .B tubes
  6. .RB [ \-S ]
  7. .RB [ \-h
  8. .IR host ]
  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 host are represented by two FIFO buffers in /tmp.
  15. These buffers are named for the host tubes is connected to, with ".in" or
  16. ".out" appended to it for incoming or outgoing messages respectively.
  17. .SH OPTIONS
  18. .TP
  19. .B \-S
  20. Use SSL (changes port to 6697)
  21. .TP
  22. .BI \-h " host"
  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) - this option should be specified
  27. after
  28. .B \-S
  29. if SSL is also desired
  30. .SH FILES
  31. The incoming and outgoing FIFO buffers are stored in /tmp and are named for
  32. the server tubes is connected to with .in or .out appended to the end.
  33. ~/.tubes.err is used to store an error string if tubes exits with -1.
  34. .SH EXIT STATUS
  35. Returns 1 on error, 0 on success.
  36. .SH AUTHOR
  37. Copyright \(co 2016 Thomas Mannay <audiobarrier@openmailbox.org>.