opnsense-src/share/man/man4/pt.4

.\" Copyright (c) 1995
.\"	Peter Dufault,  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd March 2, 1995
.Dt PT 4
.Os
.Sh NAME
.Nm pt
.Nd SCSI processor type driver
.Sh SYNOPSIS
.Cd device pt
.Sh DESCRIPTION
The
.Nm
driver provides support for a
.Tn SCSI
processor type device.
These are usually scanners and other devices using the
.Tn SCSI
link as a communication interface with device
specific commands embedded in the data stream.
.Pp
A
.Tn SCSI
adapter must be separately configured into the system
before this driver can be used.
.Pp
This device supports
.Xr read 2
and
.Xr write 2 ,
and the
.Xr ioctl 2
calls described below.
.Sh IOCTLS
.Bl -tag -width 012345678901234
The following
.Xr ioctl 2
calls are supported by the
.Nm
driver.  They are defined in the header file
.In sys/ptio.h .
.Pp
.It PTIOCGETTIMEOUT
This ioctl allows userland applications to fetch the current
.Nm
driver read and write timeout.
The value returned is in seconds.
.It PTIOCSETTIMEOUT
This ioctl allows userland applications to set the current
.Nm
driver read and write timeouts.
The value should be in seconds.
.El
.Sh FILES
.Bl -tag -width /dev/ptQQQ -compact
.It Pa /dev/pt Ns Ar N
the
.Ar N Ns th processor device.
.El
.Sh SEE ALSO
.Xr scsi 4
.Sh HISTORY
The
.Nm
driver appeared in
.Fx 2.1 .
After prodding, add a BSD style copyright to those man pages I think I probably originally wrote. Also take my name OUT of the ddb man page.. I did NOT port it from mach. 1996-10-18 16:22:31 -04:00			`.\" Copyright (c) 1995`
			`.\" Peter Dufault, All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\"`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-27 20:22:10 -04:00			`.\" $FreeBSD$`
add missing cvs Id lines. 1997-03-06 21:50:01 -05:00			`.\"`
This time add the real man pages for "pt" and "worm". 1995-03-04 15:56:39 -05:00			`.Dd March 2, 1995`
			`.Dt PT 4`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 11:31:11 -04:00			`.Os`
This time add the real man pages for "pt" and "worm". 1995-03-04 15:56:39 -05:00			`.Sh NAME`
			`.Nm pt`
Use -mdoc macros correctly. st(4) still needs work. 1996-01-17 16:57:57 -05:00			`.Nd SCSI processor type driver`
This time add the real man pages for "pt" and "worm". 1995-03-04 15:56:39 -05:00			`.Sh SYNOPSIS`
Second round of config related changes to the manpages. device blah0 -> device blah for PCI devices and busses. 2000-01-23 11:13:26 -05:00			`.Cd device pt`
This time add the real man pages for "pt" and "worm". 1995-03-04 15:56:39 -05:00			`.Sh DESCRIPTION`
			`The`
Use -mdoc macros correctly. st(4) still needs work. 1996-01-17 16:57:57 -05:00			`.Nm`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 15:41:16 -04:00			`driver provides support for a`
Use -mdoc macros correctly. st(4) still needs work. 1996-01-17 16:57:57 -05:00			`.Tn SCSI`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 19:53:39 -04:00			`processor type device.`
			`These are usually scanners and other devices using the`
Use -mdoc macros correctly. st(4) still needs work. 1996-01-17 16:57:57 -05:00			`.Tn SCSI`
			`link as a communication interface with device`
This time add the real man pages for "pt" and "worm". 1995-03-04 15:56:39 -05:00			`specific commands embedded in the data stream.`
			`.Pp`
Use -mdoc macros correctly. st(4) still needs work. 1996-01-17 16:57:57 -05:00			`A`
			`.Tn SCSI`
			`adapter must be separately configured into the system`
This time add the real man pages for "pt" and "worm". 1995-03-04 15:56:39 -05:00			`before this driver can be used.`
			`.Pp`
Fix short timeout problems with the pt(4) driver: - increase the default timeout from 10 seconds to 60 seconds - add a new kernel option, SCSI_PT_DEFAULT_TIMEOUT, that lets users specify the default timeout for the pt driver to use - add two new ioctls, one to get the timeout for a given pt device, the other to set the timeout for a given pt device. The idea is that userland applications using the device can set the timeout to suit their purposes. The ioctls are defined in a new header file, sys/ptio.h PR: 10266 Reviewed by: gibbs, joerg 1999-08-19 23:48:11 -04:00			`This device supports`
This time add the real man pages for "pt" and "worm". 1995-03-04 15:56:39 -05:00			`.Xr read 2`
			`and`
			`.Xr write 2 ,`
Fix short timeout problems with the pt(4) driver: - increase the default timeout from 10 seconds to 60 seconds - add a new kernel option, SCSI_PT_DEFAULT_TIMEOUT, that lets users specify the default timeout for the pt driver to use - add two new ioctls, one to get the timeout for a given pt device, the other to set the timeout for a given pt device. The idea is that userland applications using the device can set the timeout to suit their purposes. The ioctls are defined in a new header file, sys/ptio.h PR: 10266 Reviewed by: gibbs, joerg 1999-08-19 23:48:11 -04:00			`and the`
Use -mdoc macros correctly. st(4) still needs work. 1996-01-17 16:57:57 -05:00			`.Xr ioctl 2`
Fix short timeout problems with the pt(4) driver: - increase the default timeout from 10 seconds to 60 seconds - add a new kernel option, SCSI_PT_DEFAULT_TIMEOUT, that lets users specify the default timeout for the pt driver to use - add two new ioctls, one to get the timeout for a given pt device, the other to set the timeout for a given pt device. The idea is that userland applications using the device can set the timeout to suit their purposes. The ioctls are defined in a new header file, sys/ptio.h PR: 10266 Reviewed by: gibbs, joerg 1999-08-19 23:48:11 -04:00			`calls described below.`
Use -mdoc macros correctly. st(4) still needs work. 1996-01-17 16:57:57 -05:00			`.Sh IOCTLS`
Fix short timeout problems with the pt(4) driver: - increase the default timeout from 10 seconds to 60 seconds - add a new kernel option, SCSI_PT_DEFAULT_TIMEOUT, that lets users specify the default timeout for the pt driver to use - add two new ioctls, one to get the timeout for a given pt device, the other to set the timeout for a given pt device. The idea is that userland applications using the device can set the timeout to suit their purposes. The ioctls are defined in a new header file, sys/ptio.h PR: 10266 Reviewed by: gibbs, joerg 1999-08-19 23:48:11 -04:00			`.Bl -tag -width 012345678901234`
			`The following`
			`.Xr ioctl 2`
			`calls are supported by the`
Use -mdoc macros correctly. st(4) still needs work. 1996-01-17 16:57:57 -05:00			`.Nm`
Fix short timeout problems with the pt(4) driver: - increase the default timeout from 10 seconds to 60 seconds - add a new kernel option, SCSI_PT_DEFAULT_TIMEOUT, that lets users specify the default timeout for the pt driver to use - add two new ioctls, one to get the timeout for a given pt device, the other to set the timeout for a given pt device. The idea is that userland applications using the device can set the timeout to suit their purposes. The ioctls are defined in a new header file, sys/ptio.h PR: 10266 Reviewed by: gibbs, joerg 1999-08-19 23:48:11 -04:00			`driver. They are defined in the header file`
mdoc(7): Use the new feature of the .In macro. 2003-09-08 15:57:22 -04:00			`.In sys/ptio.h .`
Fix short timeout problems with the pt(4) driver: - increase the default timeout from 10 seconds to 60 seconds - add a new kernel option, SCSI_PT_DEFAULT_TIMEOUT, that lets users specify the default timeout for the pt driver to use - add two new ioctls, one to get the timeout for a given pt device, the other to set the timeout for a given pt device. The idea is that userland applications using the device can set the timeout to suit their purposes. The ioctls are defined in a new header file, sys/ptio.h PR: 10266 Reviewed by: gibbs, joerg 1999-08-19 23:48:11 -04:00			`.Pp`
			`.It PTIOCGETTIMEOUT`
			`This ioctl allows userland applications to fetch the current`
This time add the real man pages for "pt" and "worm". 1995-03-04 15:56:39 -05:00			`.Nm`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 19:53:39 -04:00			`driver read and write timeout.`
			`The value returned is in seconds.`
Fix short timeout problems with the pt(4) driver: - increase the default timeout from 10 seconds to 60 seconds - add a new kernel option, SCSI_PT_DEFAULT_TIMEOUT, that lets users specify the default timeout for the pt driver to use - add two new ioctls, one to get the timeout for a given pt device, the other to set the timeout for a given pt device. The idea is that userland applications using the device can set the timeout to suit their purposes. The ioctls are defined in a new header file, sys/ptio.h PR: 10266 Reviewed by: gibbs, joerg 1999-08-19 23:48:11 -04:00			`.It PTIOCSETTIMEOUT`
			`This ioctl allows userland applications to set the current`
			`.Nm`
Hiten's patchset for section four manpages, slightly edited by me. 2003-06-28 19:53:39 -04:00			`driver read and write timeouts.`
			`The value should be in seconds.`
Fix short timeout problems with the pt(4) driver: - increase the default timeout from 10 seconds to 60 seconds - add a new kernel option, SCSI_PT_DEFAULT_TIMEOUT, that lets users specify the default timeout for the pt driver to use - add two new ioctls, one to get the timeout for a given pt device, the other to set the timeout for a given pt device. The idea is that userland applications using the device can set the timeout to suit their purposes. The ioctls are defined in a new header file, sys/ptio.h PR: 10266 Reviewed by: gibbs, joerg 1999-08-19 23:48:11 -04:00			`.El`
Use -mdoc macros correctly. st(4) still needs work. 1996-01-17 16:57:57 -05:00			`.Sh FILES`
			`.Bl -tag -width /dev/ptQQQ -compact`
			`.It Pa /dev/pt Ns Ar N`
			`the`
Eliminate mdocNG warnings caused by misplaced or extraneous macro calls. 2001-02-28 12:38:53 -05:00			`.Ar N Ns th processor device.`
Use -mdoc macros correctly. st(4) still needs work. 1996-01-17 16:57:57 -05:00			`.El`
This time add the real man pages for "pt" and "worm". 1995-03-04 15:56:39 -05:00			`.Sh SEE ALSO`
			`.Xr scsi 4`
			`.Sh HISTORY`
			`The`
			`.Nm`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 15:41:16 -04:00			`driver appeared in`
Use the .Fx macro to specify FreeBSD version where appropriate. 1996-08-22 19:51:58 -04:00			`.Fx 2.1 .`