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 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 is to kill it from other
  33 terminal. This can be desirable in scripts, specially if you are
  34 sending binary data trough serial terminal.
  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
  50 .TP
  51 \fB\-v\fR
  52 Be verbose.
  53 .SH PULSE
  54
  55 Options \fB\-d\fR and \fB\-r\fR take an optional argument PULSE that
  56 specifies pulse length and polarity. PULSE can be one of the
  57 following:
  58
  59 a number
  60 .RS
  61 Absolute value of the number specifies the length of the pulse in
  62 milliseconds and sign, which can be either '+' or '-', corresponds to
  63 positive or negative polarity.
  64 .RE
  65
  66 \'+' or '-'
  67 .RS
  68 This corresponds to +1 and -1.
  69 .RE
  70
  71 empty
  72 .RS
  73 This corresponds -1.
  74 .RE
  75
  76 .SH COMMAND MODE
  77 Command mode allows you to generate arbitrary combinations of pulses
  78 on DTR and RTS signals. The commands are read from standard input and
  79 are white-space separated. The following commands are understood.
  80
  81 .I dtr PULSE
  82 .RS
  83 Generate a pulse on DTR. The PULSE argument is described in PULSE
  84 section.
  85 .RE
  86 .I rts PULSE
  87 .RS
  88 Generate a pulse on RTS. The PULSE argument is described in PULSE
  89 section.
  90 .RE
  91 .I break DURATION
  92 .RS
  93 Send break signal of given duration. See
  94 .BR tcsendbreak (3).
  95 .RE
  96 .I exit
  97 .RS
  98 Exit sterm.
  99 .RE
 100 .I go
 101 .RS
 102 Exit command mode and enter normal sterm operation.
 103 .RE
 104
 105 Any other input in the command mode raises an error and causes the
 106 program to exit.
 107
 108 .SH BUGS
 109 No known bugs.
 110
 111 .SH SEE ALSO
 112 .BR minicom (1),
 113 .BR cu (1),
 114 .BR gtkterm (1).
 115 .SH AUTHOR
 116 Michal Sojka (sojkam1@fel.cvut.cz)