xref: /onnv-gate/usr/src/cmd/Adm/ttysrch (revision 7688:2757e6e1bb2a)
10Sstevel@tonic-gate#
2*7688SAaron.Zang@Sun.COM# Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
30Sstevel@tonic-gate# Use is subject to license terms.
40Sstevel@tonic-gate#
50Sstevel@tonic-gate# CDDL HEADER START
60Sstevel@tonic-gate#
70Sstevel@tonic-gate# The contents of this file are subject to the terms of the
8*7688SAaron.Zang@Sun.COM# Common Development and Distribution License (the "License").
9*7688SAaron.Zang@Sun.COM# You may not use this file except in compliance with the License.
100Sstevel@tonic-gate#
110Sstevel@tonic-gate# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
120Sstevel@tonic-gate# or http://www.opensolaris.org/os/licensing.
130Sstevel@tonic-gate# See the License for the specific language governing permissions
140Sstevel@tonic-gate# and limitations under the License.
150Sstevel@tonic-gate#
160Sstevel@tonic-gate# When distributing Covered Code, include this CDDL HEADER in each
170Sstevel@tonic-gate# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
180Sstevel@tonic-gate# If applicable, add the following below this CDDL HEADER, with the
190Sstevel@tonic-gate# fields enclosed by brackets "[]" replaced with your own identifying
200Sstevel@tonic-gate# information: Portions Copyright [yyyy] [name of copyright owner]
210Sstevel@tonic-gate#
220Sstevel@tonic-gate# CDDL HEADER END
230Sstevel@tonic-gate#
240Sstevel@tonic-gate#	This file is used by ttyname(3C) to minimize search time
250Sstevel@tonic-gate#	during attempts to determine the name of a terminal device.
260Sstevel@tonic-gate#
270Sstevel@tonic-gate#	This is done by providing the names of directories which
280Sstevel@tonic-gate#	are most likely to contain device entries for terminal
290Sstevel@tonic-gate#	devices. These directories will be searched in the order
300Sstevel@tonic-gate#	listed prior to an exhaustive search of the rest of /dev.
310Sstevel@tonic-gate#
320Sstevel@tonic-gate#	Each line contains the name of a directory (which must
330Sstevel@tonic-gate#	begin with "/dev") and (optionally) a set of flags which
340Sstevel@tonic-gate#	modify the criteria used to determine a match. By default,
350Sstevel@tonic-gate#	an exact match requires that the major/minor device number
360Sstevel@tonic-gate#	(the M flag), the file system identifier (the F flag), and
370Sstevel@tonic-gate#	the inode number (the I flag) all match.  Normally, a partial
380Sstevel@tonic-gate#	match on the major/minor device and the file system identifier
390Sstevel@tonic-gate#	is accepted only after exhausting all entries under /dev.
400Sstevel@tonic-gate#	By specifying only the M and F flags, an exact match will
410Sstevel@tonic-gate#	be accepted regardless of the value of the inode number as
420Sstevel@tonic-gate#	soon as it is found.  This is especially useful for cloned
430Sstevel@tonic-gate#	devices, which generally will not match inode numbers.
440Sstevel@tonic-gate#
450Sstevel@tonic-gate#	For additional information see ttysrch(4).
460Sstevel@tonic-gate#
470Sstevel@tonic-gate# EXAMPLE:
480Sstevel@tonic-gate#
490Sstevel@tonic-gate#	/dev/slan	MF
500Sstevel@tonic-gate#
510Sstevel@tonic-gate#	This would improve performance for Starlan network connections
520Sstevel@tonic-gate#	if all Starlan network clone device entries were contained
530Sstevel@tonic-gate#	in the /dev/slan directory.
540Sstevel@tonic-gate#
550Sstevel@tonic-gate/dev/pts
56*7688SAaron.Zang@Sun.COM/dev/vt
570Sstevel@tonic-gate/dev/term
580Sstevel@tonic-gate/dev/zcons
59