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.

41 lines
1.0KB

  1. .TH TUBES 1 tubes-1.0.0
  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. .RB [ \-v ]
  12. .SH DESCRIPTION
  13. .B tubes
  14. is a small daemon that provides a minimalistic interface for irc bots.
  15. Messages to and from the server are represented by two FIFO buffers in /tmp.
  16. For the default server (freenode) these would be chat.freenode.net.in and
  17. chat.freenode.net.out for incoming and outgoing messages respectively.
  18. .SH OPTIONS
  19. .TP
  20. .B \-S
  21. Use SSL
  22. .TP
  23. .BI \-s " server"
  24. Use a host other than the default (chat.freenode.net)
  25. .TP
  26. .BI \-p " port"
  27. Use a port other than the default (6667)
  28. .TP
  29. .B \-v
  30. Prints version information and exits
  31. .SH FILES
  32. The incoming and outgoing FIFO buffers are stored in /tmp and are named for
  33. the server tubes is connected to with .in or .out appended to the end.
  34. ~/.tubes.err is used to store a string explaining why tubes has exited, if any.
  35. .SH RETURN VALUE
  36. Returns -1 when something has gone wrong or 0 on success.
  37. .SH AUTHOR
  38. Copyright \(co 2016 Thomas Mannay <audiobarrier@openmailbox.org>.