usr/src/man/man3gen/pathfind.3gen

   1 '\" te
   2 .\"  Copyright 1989 AT&T Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PATHFIND 3GEN "Mar 10, 1999"
   7 .SH NAME
   8 pathfind \- search for named file in named directories
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR ... ] \fIfile\fR ... \fB-lgen\fR [ \fIlibrary\fR ... ]
  13 #include <libgen.h>
  14
  15 \fBchar *\fR\fBpathfind\fR(\fBconst char *\fR\fIpath\fR, \fBconst char *\fR\fIname\fR, \fBconst char *\fR\fImode\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBpathfind()\fR function searches the directories named in \fIpath\fR for
  22 the file \fIname\fR. The directories named in \fIpath\fR are separated by
  23 colons (:). The \fImode\fR argument is a string of option letters chosen from
  24 the set \fB[rwxfbcdpugks]:\fR
  25 .sp
  26
  27 .sp
  28 .TS
  29 box;
  30 c | c
  31 l | l .
  32 Letter  Meaning
  33 _
  34 \fBr\fR readable
  35 _
  36 \fBw\fR writable
  37 _
  38 \fBx\fR executable
  39 _
  40 \fBf\fR normal file
  41 _
  42 \fBb\fR block special
  43 _
  44 \fBc\fR character special
  45 _
  46 \fBd\fR directory
  47 _
  48 \fBp\fR FIFO (pipe)
  49 _
  50 \fBu\fR set user ID bit
  51 _
  52 \fBg\fR set group ID bit
  53 _
  54 \fBk\fR sticky bit
  55 _
  56 \fBs\fR size non-zero
  57 .TE
  58
  59 .sp
  60 .LP
  61 Options read, write, and execute are checked relative to the real (not the
  62 effective) user \fBID\fR and group \fBID\fR of the current process.
  63 .sp
  64 .LP
  65 If \fIname\fR begins with a slash, it is treated as an absolute path name, and
  66 \fIpath\fR is ignored.
  67 .sp
  68 .LP
  69 An empty \fIpath\fR member is treated as the current directory. A slash
  70 (\fB/\fR) character is not prepended at the occurrence of the first match;
  71 rather, the unadorned \fIname\fR is returned.
  72 .SH EXAMPLES
  73 .LP
  74 \fBExample 1 \fRExample of finding the \fBls\fR command using the PATH
  75 environment variable.
  76 .sp
  77 .LP
  78 To find the \fBls\fR command using the \fBPATH\fR environment variable:
  79
  80 .sp
  81 .LP
  82 pathfind (getenv ("PATH"), "ls", "rx")
  83
  84 .SH RETURN VALUES
  85 .sp
  86 .LP
  87 The \fBpathfind()\fR function returns a \fB(char *)\fR value containing static,
  88 thread-specific data that will be overwritten upon the next call from the same
  89 thread.
  90 .sp
  91 .LP
  92 If the file \fIname\fR with all characteristics specified by \fImode\fR is
  93 found in any of the directories specified by \fIpath\fR, then \fBpathfind()\fR
  94 returns a pointer to a string containing the member of \fIpath\fR, followed by
  95 a slash character (\fB/\fR), followed by \fIname\fR.
  96 .sp
  97 .LP
  98 If no match is found, \fBpathname()\fR returns a null pointer, \fB((char *)
  99 0)\fR.
 100 .SH ATTRIBUTES
 101 .sp
 102 .LP
 103 See \fBattributes\fR(5) for descriptions of the following attributes:
 104 .sp
 105
 106 .sp
 107 .TS
 108 box;
 109 c | c
 110 l | l .
 111 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 112 _
 113 MT-Level        MT-Safe
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBsh\fR(1), \fBtest\fR(1), \fBaccess\fR(2), \fBmknod\fR(2), \fBstat\fR(2),
 120 \fBgetenv\fR(3C), \fBattributes\fR(5)
 121 .SH NOTES
 122 .sp
 123 .LP
 124 The string pointed to by the returned pointer is stored in an area that is
 125 reused on subsequent calls to \fBpathfind()\fR. The string should not be
 126 deallocated by the caller.
 127 .sp
 128 .LP
 129 When compiling multithreaded applications, the \fB_REENTRANT\fR flag must be
 130 defined on the compile line.  This flag should only be used in
 131 multithreadedapplications.