kamunix.8 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .\" $Id$
  2. .TH kamunix 8 21.06.2006 kamailio "Kamailio"
  3. .\" Process with
  4. .\" groff -man -Tascii kamunix.8
  5. .\"
  6. .SH NAME
  7. kamunix \- Kamailio UNIX socket wrapper
  8. .SH SYNOPSIS
  9. .B kamunix
  10. .BI path_to_socket
  11. .SH DESCRIPTION
  12. .B kamunix
  13. is a wrapper for sending external commands
  14. .B to Kamailio SIP server
  15. via UNIX sockets interface.
  16. .br
  17. This is a binary alternative to the textual FIFO interface.
  18. .PP
  19. .B kamunix
  20. reads from standard input one
  21. .B Kamailio
  22. command along with its paramters (if any) and prints the response
  23. to standard output.
  24. .SH PARAMETERS
  25. .TP 3
  26. .B path_to_socket
  27. full path of the UNIX socket file used by Kamailio to receive the
  28. external commands
  29. .SH EXAMPLES
  30. .PP
  31. An Kamailio commands consists in one ore more lines: first contains the
  32. command name enclosed between ":", the following lines containing the
  33. command parameters, one per line.
  34. .PP
  35. echo ":uptime:" | kamunix /tmp/kamailio.sock
  36. .SH AUTHORS
  37. see
  38. .B /usr/share/doc/kamailio/AUTHORS
  39. .SH SEE ALSO
  40. .BR kamailio(8), kamailio.cfg(5), kamctl(8)
  41. .PP
  42. Full documentation on Kamailio is available at
  43. .I http://www.kamailio.org/.
  44. .PP
  45. Mailing lists:
  46. .nf
  47. [email protected] - Kamailio user community
  48. .nf
  49. [email protected] - Kamailio development, new features and unstable version