ttycat.1 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. .TH ttycat 1 "Mar 2014" "plc-utils-2.1.6" "Qualcomm Atheros Powerline Toolkit"
  2. .SH NAME
  3. ttycat - Serial Line Output Utility
  4. .SH SYNOPSIS
  5. .BR ttycat
  6. .RI [ options ]
  7. .RI [ file ]
  8. .RI [ file ]
  9. .RI [> stdout ]
  10. .PP
  11. .BR ttycat
  12. .RI [ options ]
  13. .RI [< stdin ]
  14. .RI [> stdout ]
  15. .PP
  16. .SH DESCRIPTION
  17. Copy one or more files to a serial device.
  18. This program is similar to traditional \fBcat\fR utility but expects stdout to be a serial tty device.
  19. It will configure stdout before writing and will restore the original configuration afterwards.
  20. It can be used to send data to the local Atheros UART-enabled powerline device.
  21. If the remote powerline device is not UART-enabled, use program \fBedru\fR to capture and display arriving at the remote host and program \fBedsu\fR to send files in the opposite direction.
  22. .PP
  23. This program is part of the Qualcomm Atheros Powerline Toolkit.
  24. See the \fBAMP\fR man page for an overview and installation instructions.
  25. .SH COMMENTS
  26. This program only supports the \fBLinux\fR and \fBMacOSX\fR platforms, at present.
  27. .SH OPTIONS
  28. .TP
  29. -\fBs \fIspeed\fR
  30. The serial baud rate.
  31. Supported baud rates are \fB0\fR, \fB50\fR, \fB75\fR, \fB110\fR, \fB134\fR, \fB150\fR, \fB200\fR, \fB300\fR, \fB600\fR, \fB1200\fR, \fB1800\fR, \fB2400\fR, \fB4800\fR, \fB9600\fR, \fB19200\fR, \fB38400\fR, \fB57600\fR, \fB115200\fR, \fB230400\fR, \fB460800\fR, \fB500000\fR and \fB921600\fR.
  32. .TP
  33. .RB - ? ,-- help
  34. Print program help summary on stdout.
  35. This option takes precedence over other options on the command line.
  36. .TP
  37. .RB - ? ,-- version
  38. Print program version information on stdout.
  39. This option takes precedence over other options on the command line.
  40. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of the Linux Toolkit you are using.
  41. .SH ARGUMENTS
  42. .TP
  43. .IR file
  44. The name of an input file.
  45. No assumptions are made about the file based on the filename or extension.
  46. Input files are not modified.
  47. .TP
  48. .IR stdout
  49. The name of a serial output device.
  50. A error will occur if the device is not a true tty device according as determined by the \fBisatty\fR function.
  51. Depending on the amount of input data and the baud rate, serial output may take several seconds or several minutes.
  52. .SH EXAMPLES
  53. The following command copies files \fBabc.txt\fR and \fBdef.bin\fR to stdout which must be an active serial device or an error will occur.
  54. .PP
  55. # ttycat abc.txt def.bin > /dev/ttyUSB1
  56. .SH SEE ALSO
  57. .BR amp ( 1 ),
  58. .BR edru ( 1 ),
  59. .BR edsu ( 1 ),
  60. .BR int6kuart ( 1 ),
  61. .SH CREDITS
  62. Charles Maier <cmaier@qca.qualcomm.com>