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\-c\fR
  20 Enter command mode. See COMMAND MODE section below.
  21 .TP
  22 \fB\-d[PULSE]\fR
  23 Make pulse on DTR. The PULSE parameter (see below) specifies the
  24 length of the pulse and its polarity.
  25 .TP
  26 \fB\-e\fR
  27 Ignore '~.' escape sequence. Be aware that this locks your terminal to
  28 sterm, the only way to exit sterm is is to kill it from other
  29 terminal. This can be desirable in scripts, specially if you are
  30 sending binary data trough serial terminal.
  31 .TP
  32 \fB\-n\fR
  33 Don't switch user's terminal to raw mode. This is useful if you want
  34 to use '^C' to exit sterm or to use line buffering/editing features of
  35 TTYs.
  36 .TP
  37 \fB\-r[PULSE]\fR
  38 Make pulse on RTS. The PULSE parameter (see below) specifies the
  39 length of the pulse and its polarity.
  40 .TP
  41 \fB\-s <baudrate>\fR
  42 Set serial like baudrate to the given value. Here are few common
  43 values: 4800, 9600, 19200, 115200. For full list of supported
  44 baudrates see source files or test what is acceptable.
  45
  46 .SH PULSE
  47
  48 Options \fB\-d\fR and \fB\-r\fR take an optional argument PULSE that
  49 specifies pulse length and polarity. PULSE can be one of the
  50 following:
  51
  52 a number
  53 .RS
  54 Absolute value of the number specifies the length of the pulse in
  55 milliseconds and sign, which can be either '+' or '-', corresponds to
  56 positive or negative polarity.
  57 .RE
  58
  59 \'+' or '-'
  60 .RS
  61 This corresponds to +1 and -1.
  62 .RE
  63
  64 empty
  65 .RS
  66 This corresponds -1.
  67 .RE
  68
  69 .SH COMMAND MODE
  70 Command mode allows you to generate arbitrary combinations of pulses
  71 on DTR and RTS signals. The commands are read from standard input and
  72 are white-space separated. The following commands are understood.
  73
  74 .I dtr PULSE
  75 .RS
  76 Generate a pulse on DTR. The PULSE argument is described in PULSE
  77 section.
  78 .RE
  79 .I rts PULSE
  80 .RS
  81 Generate a pulse on RTS. The PULSE argument is described in PULSE
  82 section.
  83 .RE
  84 .I go
  85 .RS
  86 Exit command mode and enter normal sterm operation.
  87 .RE
  88
  89 Any other input in the command mode raises an error and causes the
  90 program to exit.
  91
  92 .SH BUGS
  93 No known bugs.
  94
  95 .SH AUTHOR
  96 Michal Sojka (sojkam1@fel.cvut.cz)