summaryrefslogtreecommitdiff
path: root/man/XtFindFile.man
diff options
context:
space:
mode:
authorKaleb Keithley <kaleb@freedesktop.org>2003-11-17 19:03:42 +0000
committerKaleb Keithley <kaleb@freedesktop.org>2003-11-17 19:03:42 +0000
commita6bdd56c5b098599942e4091ae7e2af2d4631b44 (patch)
treee0a23167aca0fb1127f4cd78edf458b633b31eac /man/XtFindFile.man
parent6a13c9e08bb042c81ae904c44a38a50d785c824e (diff)
merge XFree86 4.3.0.1 to -CURRENT
Diffstat (limited to 'man/XtFindFile.man')
-rw-r--r--man/XtFindFile.man25
1 files changed, 14 insertions, 11 deletions
diff --git a/man/XtFindFile.man b/man/XtFindFile.man
index 982af1e..90c6c46 100644
--- a/man/XtFindFile.man
+++ b/man/XtFindFile.man
@@ -1,4 +1,4 @@
-.\" $Xorg: XtFindF.man,v 1.4 2001/03/16 17:53:52 pookie Exp $
+.\" $Xorg: XtFindF.man,v 1.3 2000/08/17 19:42:00 cpqbld Exp $
.\"
.\" Copyright (c) 1993, 1994 X Consortium
.\"
@@ -24,6 +24,9 @@
.\" be used in advertising or otherwise to promote the sale, use or other
.\" dealing in this Software without prior written authorization from the
.\" X Consortium.
+.\"
+.\" $XFree86: xc/doc/man/Xt/XtFindF.man,v 1.4 2002/10/12 16:06:41 herrb Exp $
+.\"
.ds tk X Toolkit
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xI Intrinsics
@@ -123,11 +126,11 @@
.el .sp 10p
..
.ny0
-.TH XtFindFile 3Xt "Release 6.6" "X Version 11" "XT FUNCTIONS"
+.TH XtFindFile 3Xt __xorgversion__ "XT FUNCTIONS"
.SH NAME
XtFindFile \- search for a file using substitutions in the path list
.SH SYNTAX
-String XtFindFile(\fIpath\fP, \fIsubstitutions\fP, \fInum_substitutions\fP,\
+String XtFindFile(\fIpath\fP, \fIsubstitutions\fP, \fInum_substitutions\fP,
\fIpredicate\fP)
.br
String \fIpath\fP;
@@ -156,7 +159,7 @@ single colon. The character sequence ``%%'' specifies a percent
character that does not introduce a substitution; the sequence is
replaced by a single percent character. If a percent character is
followed by any other character,
-.PN XtFindFile
+.ZN XtFindFile
looks through the
specified \fIsubstitutions\fP for that character in the \fImatch\fP field and if
found replaces the percent and match characters with the string in the
@@ -164,29 +167,29 @@ corresponding \fIsubstitution\fP field. A \fIsubstitution\fP field entry of NUL
is equivalent to a pointer to an empty string. If the operating
system does not interpret multiple embedded name separators in the
path (i.e., ``/'' in POSIX) the same way as a single separator,
-.PN XtFindFile
+.ZN XtFindFile
will collapse multiple separators into a single one after performing
all string substitutions. Except for collapsing embedded separators,
the contents of the string substitutions are not interpreted by
-.PN XtFindFile
+.ZN XtFindFile
and may therefore contain any operating-system-dependent
characters, including additional name separators. Each resulting
string is passed to the predicate procedure until a string is found for
which the procedure returns
-.PN True ;
+.ZN True ;
this string is the return value for
-.PN XtFindFile .
+.ZN XtFindFile .
If no string yields a
-.PN True
+.ZN True
return from the predicate,
-.PN XtFindFile
+.ZN XtFindFile
returns NULL.
.LP
If the \fIpredicate\fP parameter is NULL, an internal procedure that checks
if the file exists, is readable, and is not a directory will be used.
.LP
It is the responsibility of the caller to free the returned string using
-.PN XtFree
+.ZN XtFree
when it is no longer needed.
.SH "SEE ALSO"
.br