sterm.man

   1 .\" vim: ft=groff
   2 .\" Manpage for sterm.
   3 .TH sterm 1 "16 September 2016" "16102015"
   4 .SH NAME
   5 sterm \- simple serial terminal
   6 .SH SYNOPSIS
   7 sterm [OPTION]... DEVICE
   8 .SH DESCRIPTION
   9 .PP
  10 sterm is simple program for communication over serial line. It can be
  11 used in scripts or directly as interactive terminal. It also allows to
  12 control DTR and RTS signals with command line options.
  13 .PP
  14 In interactive mode all keys (including '^C') are sent trough the
  15 serial connection. To exit the program there is a special key
  16 sequence: '<Enter>~.'
  17 .SH OPTIONS
  18 .TP
  19 \fB\-b <duration>\fR
  20 Send break signal of given DURATION after opening the DEVICE. See
  21 tcsendbreak(3) for definition of duration.
  22 .TP
  23 \fB\-c\fR
  24 Enter command mode. See COMMAND MODE section below.
  25 .TP
  26 \fB\-d[PULSE]\fR
  27 Make pulse on DTR. The PULSE parameter (see below) specifies the
  28 length of the pulse and its polarity.
  29 .TP
  30 \fB\-e\fR
  31 Ignore '~.' escape sequence. Be aware that this locks your terminal to
  32 sterm, the only way to exit sterm is to kill it from other
  33 terminal. This can be desirable in scripts, specially if you are
  34 sending binary data through serial connection.
  35 .TP
  36 \fB\-n\fR
  37 Don't switch user's terminal to raw mode. This is useful if you want
  38 to use '^C' to exit sterm or to use line buffering/editing features of
  39 TTYs.
  40 .TP
  41 \fB\-r[PULSE]\fR
  42 Make pulse on RTS. The PULSE parameter (see below) specifies the
  43 length of the pulse and its polarity.
  44 .TP
  45 \fB\-s <baudrate>\fR
  46 Set serial like baudrate to the given value. Here are few common
  47 values: 4800, 9600, 19200, 115200. For full list of supported
  48 baudrates see source files or test what is acceptable.
  49 .TP
  50 \fB\-t <ms>\fR
  51 Enforce minimum delay of MS milliseconds between transmitting any two
  52 characters to the serial line. This is useful when talking to devices,
  53 which loose characters sent at full speed, e.g. after copy&paste
  54 operation.
  55
  56 .TP
  57 \fB\-v\fR
  58 Be verbose.
  59 .SH PULSE
  60
  61 Options \fB\-d\fR and \fB\-r\fR take an optional argument PULSE that
  62 specifies pulse length and polarity. PULSE can be one of the
  63 following:
  64
  65 a number
  66 .RS
  67 Absolute value of the number specifies the length of the pulse in
  68 milliseconds and sign, which can be either '+' or '-', corresponds to
  69 positive or negative polarity.
  70 .RE
  71
  72 \'+' or '-'
  73 .RS
  74 This corresponds to +1 and -1.
  75 .RE
  76
  77 empty
  78 .RS
  79 This corresponds -1.
  80 .RE
  81
  82 .SH COMMAND MODE
  83 Command mode allows you to generate arbitrary combinations of pulses
  84 on DTR and RTS signals. The commands are read from standard input and
  85 are white-space separated. The following commands are understood.
  86
  87 .I dtr PULSE
  88 .RS
  89 Generate a pulse on DTR. The PULSE argument is described in PULSE
  90 section.
  91 .RE
  92 .I rts PULSE
  93 .RS
  94 Generate a pulse on RTS. The PULSE argument is described in PULSE
  95 section.
  96 .RE
  97 .I break DURATION
  98 .RS
  99 Send break signal of given duration. See
 100 .BR tcsendbreak (3).
 101 .RE
 102 .I exit
 103 .RS
 104 Exit sterm.
 105 .RE
 106 .I go
 107 .RS
 108 Exit command mode and enter normal sterm operation.
 109 .RE
 110
 111 Any other input in the command mode raises an error and causes the
 112 program to exit.
 113
 114 .SH BUGS
 115 No known bugs.
 116
 117 .SH SEE ALSO
 118 .BR minicom (1),
 119 .BR cu (1),
 120 .BR gtkterm (1).
 121 .SH AUTHOR
 122 Michal Sojka (sojkam1@fel.cvut.cz)