xref: /onnv-gate/usr/src/cmd/Adm/ttysrch (revision 0:68f95e015346)
1*0Sstevel@tonic-gate#
2*0Sstevel@tonic-gate# Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
3*0Sstevel@tonic-gate# Use is subject to license terms.
4*0Sstevel@tonic-gate#
5*0Sstevel@tonic-gate# CDDL HEADER START
6*0Sstevel@tonic-gate#
7*0Sstevel@tonic-gate# The contents of this file are subject to the terms of the
8*0Sstevel@tonic-gate# Common Development and Distribution License, Version 1.0 only
9*0Sstevel@tonic-gate# (the "License").  You may not use this file except in compliance
10*0Sstevel@tonic-gate# with the License.
11*0Sstevel@tonic-gate#
12*0Sstevel@tonic-gate# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
13*0Sstevel@tonic-gate# or http://www.opensolaris.org/os/licensing.
14*0Sstevel@tonic-gate# See the License for the specific language governing permissions
15*0Sstevel@tonic-gate# and limitations under the License.
16*0Sstevel@tonic-gate#
17*0Sstevel@tonic-gate# When distributing Covered Code, include this CDDL HEADER in each
18*0Sstevel@tonic-gate# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
19*0Sstevel@tonic-gate# If applicable, add the following below this CDDL HEADER, with the
20*0Sstevel@tonic-gate# fields enclosed by brackets "[]" replaced with your own identifying
21*0Sstevel@tonic-gate# information: Portions Copyright [yyyy] [name of copyright owner]
22*0Sstevel@tonic-gate#
23*0Sstevel@tonic-gate# CDDL HEADER END
24*0Sstevel@tonic-gate#
25*0Sstevel@tonic-gate#ident	"%Z%%M%	%I%	%E% SMI"
26*0Sstevel@tonic-gate#
27*0Sstevel@tonic-gate#	This file is used by ttyname(3C) to minimize search time
28*0Sstevel@tonic-gate#	during attempts to determine the name of a terminal device.
29*0Sstevel@tonic-gate#
30*0Sstevel@tonic-gate#	This is done by providing the names of directories which
31*0Sstevel@tonic-gate#	are most likely to contain device entries for terminal
32*0Sstevel@tonic-gate#	devices. These directories will be searched in the order
33*0Sstevel@tonic-gate#	listed prior to an exhaustive search of the rest of /dev.
34*0Sstevel@tonic-gate#
35*0Sstevel@tonic-gate#	Each line contains the name of a directory (which must
36*0Sstevel@tonic-gate#	begin with "/dev") and (optionally) a set of flags which
37*0Sstevel@tonic-gate#	modify the criteria used to determine a match. By default,
38*0Sstevel@tonic-gate#	an exact match requires that the major/minor device number
39*0Sstevel@tonic-gate#	(the M flag), the file system identifier (the F flag), and
40*0Sstevel@tonic-gate#	the inode number (the I flag) all match.  Normally, a partial
41*0Sstevel@tonic-gate#	match on the major/minor device and the file system identifier
42*0Sstevel@tonic-gate#	is accepted only after exhausting all entries under /dev.
43*0Sstevel@tonic-gate#	By specifying only the M and F flags, an exact match will
44*0Sstevel@tonic-gate#	be accepted regardless of the value of the inode number as
45*0Sstevel@tonic-gate#	soon as it is found.  This is especially useful for cloned
46*0Sstevel@tonic-gate#	devices, which generally will not match inode numbers.
47*0Sstevel@tonic-gate#
48*0Sstevel@tonic-gate#	For additional information see ttysrch(4).
49*0Sstevel@tonic-gate#
50*0Sstevel@tonic-gate# EXAMPLE:
51*0Sstevel@tonic-gate#
52*0Sstevel@tonic-gate#	/dev/slan	MF
53*0Sstevel@tonic-gate#
54*0Sstevel@tonic-gate#	This would improve performance for Starlan network connections
55*0Sstevel@tonic-gate#	if all Starlan network clone device entries were contained
56*0Sstevel@tonic-gate#	in the /dev/slan directory.
57*0Sstevel@tonic-gate#
58*0Sstevel@tonic-gate/dev/pts
59*0Sstevel@tonic-gate/dev/term
60*0Sstevel@tonic-gate/dev/zcons
61