freebsd-src/sbin/comcontrol/comcontrol.8

.\" $FreeBSD$
.Dd May 15, 1994
.Dt COMCONTROL 8
.Os
.Sh NAME
.Nm comcontrol
.Nd control a special tty device
.Sh SYNOPSIS
.Nm
.Ar special_device
.Op dtrwait Ar number
.Op drainwait Ar number
.Sh DESCRIPTION
The
.Nm
utility is used to examine and modify some of the special characteristics
of the specified tty device.
If no arguments other than the device (or "-" for stdin)
are specified,
it prints the settings of all controllable characteristics.
This usage requires only read access on the device.
Only the superuser can change the settings.
.Pp
The following options are available:
.Bl -tag -width indent
.It Cm dtrwait Ar number
Set the time to wait after dropping DTR
to the given number.
The units are hundredths of a second.
The default is 300 hundredths, i.e., 3 seconds.
This option needed mainly to set proper recover time after
modem reset.
.It Cm drainwait Ar number
Set the time to wait for output drain
to the given number.
The units are seconds.
The default is 5 minutes, 0 means
waiting forever.
This option needed mainly to specify upper limit of minutes
to prevent modem hanging.
.El
.Pp
The standard way to use
.Nm
is to put invocations of it in the
.Pa /etc/rc.d/serial
startup script.
.Sh FILES
.Bl -tag -width /dev/ttyd? -compact
.It Pa /dev/ttyd?
dialin devices, hardwired terminals
.It Pa /dev/cuad?
dialout devices
.El
.Sh SEE ALSO
.Xr stty 1 ,
.Xr sio 4
.Sh HISTORY
Originally part of cgd's com package patches, version 0.2.1, to
.Bx 386 0.1 .
Once controlled bidirectional capabilities.
Little is left to control now
that these capabilities are standard.
.Sh AUTHORS
.An Christopher G. Demetriou
$Id$ -> $FreeBSD$ 1999-08-28 01:22:10 +01:00			`.\" $FreeBSD$`
From Bde: o Rewrote lots of it to be more like stty.1. The old one was too verbose and the complicated options no longer exist. 1994-05-30 04:50:01 +01:00			`.Dd May 15, 1994`
Man page added. 1993-12-10 19:27:16 +00:00			`.Dt COMCONTROL 8`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 12:04:34 +01:00			`.Os`
Man page added. 1993-12-10 19:27:16 +00:00			`.Sh NAME`
			`.Nm comcontrol`
What the commit log for rev 1.16 neglected to mention was that the delta touched the Name Description (Nd). It introduced a grammar error and did not fix the extraneous punctuation (Nd lines are not terminated with a period). 2000-07-03 13:01:06 +01:00			`.Nd control a special tty device`
Man page added. 1993-12-10 19:27:16 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00			`.Nm`
Remove the use of a dash in the usage, since this isn't in keeping with other utilities which offer similar functionality. This change was discussed with ache, who brought in the ability to use a dash to represent stdin in comcontrol. 2000-07-03 14:29:04 +01:00			`.Ar special_device`
Print options only supported by device, back out printing options separately Pointed-by: bde 2000-05-01 13:14:30 +01:00			`.Op dtrwait Ar number`
			`.Op drainwait Ar number`
Man page added. 1993-12-10 19:27:16 +00:00			`.Sh DESCRIPTION`
The .Nm utility 2002-07-06 20:34:18 +01:00			`The`
			`.Nm`
			`utility is used to examine and modify some of the special characteristics`
Allow "-" for working with STDIN Allow printing of each option separately when keyword specified without a number 2000-04-30 19:06:04 +01:00			`of the specified tty device.`
			`If no arguments other than the device (or "-" for stdin)`
			`are specified,`
From Bde: o Rewrote lots of it to be more like stty.1. The old one was too verbose and the complicated options no longer exist. 1994-05-30 04:50:01 +01:00			`it prints the settings of all controllable characteristics.`
			`This usage requires only read access on the device.`
			`Only the superuser can change the settings.`
			`.Pp`
			`The following options are available:`
Add rcsid. Remove unused #includes. Use err(3). 1998-06-30 07:09:37 +01:00			`.Bl -tag -width indent`
From Bde: o Rewrote lots of it to be more like stty.1. The old one was too verbose and the complicated options no longer exist. 1994-05-30 04:50:01 +01:00			`.It Cm dtrwait Ar number`
			`Set the time to wait after dropping DTR`
			`to the given number.`
			`The units are hundredths of a second.`
			`The default is 300 hundredths, i.e., 3 seconds.`
Fight agaist hanging modems: add new drainwait option. Reviewed by: Bruce 1995-01-05 00:03:06 +00:00			`This option needed mainly to set proper recover time after`
			`modem reset.`
			`.It Cm drainwait Ar number`
			`Set the time to wait for output drain`
			`to the given number.`
			`The units are seconds.`
Allow "-" for working with STDIN Allow printing of each option separately when keyword specified without a number 2000-04-30 19:06:04 +01:00			`The default is 5 minutes, 0 means`
			`waiting forever.`
Fight agaist hanging modems: add new drainwait option. Reviewed by: Bruce 1995-01-05 00:03:06 +00:00			`This option needed mainly to specify upper limit of minutes`
			`to prevent modem hanging.`
From Bde: o Rewrote lots of it to be more like stty.1. The old one was too verbose and the complicated options no longer exist. 1994-05-30 04:50:01 +01:00			`.El`
Man page added. 1993-12-10 19:27:16 +00:00			`.Pp`
			`The standard way to use`
Add rcsid. Remove unused #includes. Use err(3). 1998-06-30 07:09:37 +01:00			`.Nm`
Man page added. 1993-12-10 19:27:16 +00:00			`is to put invocations of it in the`
/etc/rc.serial -> /etc/rc.d/serial. 2003-12-23 07:16:38 +00:00			`.Pa /etc/rc.d/serial`
Man page added. 1993-12-10 19:27:16 +00:00			`startup script.`
			`.Sh FILES`
Add rcsid. Remove unused #includes. Use err(3). 1998-06-30 07:09:37 +01:00			`.Bl -tag -width /dev/ttyd? -compact`
FILES entry corrected 1994-05-03 19:50:13 +01:00			`.It Pa /dev/ttyd?`
rc.local -> rc.serial cua0? -> cuaa? 1994-12-05 19:52:29 +00:00			`dialin devices, hardwired terminals`
Reflect the cuaa->cuad namechange in documentation. Might as well do them all while I'm at it :-) Submitted by: Steve Kargl <sgk@troutmask.apl.washington.edu> 2004-11-13 00:09:19 +00:00			`.It Pa /dev/cuad?`
Add rcsid. Remove unused #includes. Use err(3). 1998-06-30 07:09:37 +01:00			`dialout devices`
Prepare for mdoc(7)NG. 2000-12-18 15:16:24 +00:00			`.El`
Sort sections. 2005-01-18 10:09:38 +00:00			`.Sh SEE ALSO`
			`.Xr stty 1 ,`
			`.Xr sio 4`
Man page added. 1993-12-10 19:27:16 +00:00			`.Sh HISTORY`
mdoc(7) police: s/BSD/.Bx/ where appropriate. 2001-08-14 11:01:54 +01:00			`Originally part of cgd's com package patches, version 0.2.1, to`
			`.Bx 386 0.1 .`
Mechanically kill hard sentence breaks. 2004-07-02 22:45:06 +01:00			`Once controlled bidirectional capabilities.`
			`Little is left to control now`
From Bde: o Rewrote lots of it to be more like stty.1. The old one was too verbose and the complicated options no longer exist. 1994-05-30 04:50:01 +01:00			`that these capabilities are standard.`
Sort sections. 2005-01-18 10:09:38 +00:00			`.Sh AUTHORS`
			`.An Christopher G. Demetriou`