--- path.pod 2002/08/03 10:23:41 1.2
+++ path.pod 2002/08/03 21:00:15 1.3
@@ -32,7 +32,7 @@
=head1 NAME
-B<path> - Filesystem Path Manipulation
+B<OSSP path> - Filesystem Path Manipulation
=head1 SYNOPSIS
@@ -50,10 +50,14 @@
=head1 DESCRIPTION
-B<Path> is a filesystem path conversion library. It allows one to
-convert between absolute and relative paths and to resolve symlinks in a
-path. The following Application Programming Interface (API) is provided
-for this:
+B<OSSP path> is a filesystem path manipulation library. It allows one
+to convert between absolute and relative paths and to resolve symbolic
+links in a path.
+
+=head1 APPLICATION PROGRAMMING INTERFACE (API)
+
+The following Application Programming Interface (API) is provided by
+B<OSSP path>:
=over 4
@@ -106,22 +110,24 @@
=item char *B<path_dirname>(char *I<outbuf>, const size_t I<outsize>, const char *I<path>);
-This function extracts the directory filename part from I<path> and stores it
-into the caller supplied buffer at I<outbuf>, but never more than I<outsize>
-bytes are written. The function returns a pointer to I<outbuf> on success,
-and C<NULL> on error.
+This function extracts the directory filename part from I<path> and
+stores it into the caller supplied buffer at I<outbuf>, but never more
+than I<outsize> bytes are written. The function returns a pointer to
+I<outbuf> on success, and C<NULL> on error.
=item char *B<path_basename>(char *I<outbuf>, const size_t I<outsize>, const char *I<path>);
-This function extracts the base filename part from I<path> and stores it into
-the caller supplied buffer at I<outbuf>, but never more than I<outsize> bytes
-are written. The function returns a pointer to I<outbuf> on success, and
-C<NULL> on error.
+This function extracts the base filename part from I<path> and stores
+it into the caller supplied buffer at I<outbuf>, but never more than
+I<outsize> bytes are written. The function returns a pointer to
+I<outbuf> on success, and C<NULL> on error.
=back
=head1 EXAMPLE
+The code
+
char result[MAXPATHLEN];
char *path = path_abs2rel(result, sizeof(result), "/usr/src/sys", "/usr/local/lib");
@@ -179,8 +185,8 @@
path == "../../../sys/kern" /* It's correct but ... */
-That is correct, but a little redundant. If you wish get the simple an-
-swer 'C<kern>', do the following.
+That is correct, but a little redundant. If you wish get the simple
+answer 'C<kern>', do the following.
path = path_abs2rel(r0, sizeof(r0),
path_resolve(r1, sizeof(r1), "/sys/kern"),
@@ -194,12 +200,13 @@
=head1 AUTHORS
-The path_abs2rel() and path_rel2abs() function was originally written in
-December 1997 by I<Shigio Yamaguchi> for his I<PathConvert> project. The
-path_resolve() function is derived from FreeBSD's realpath(3) function
-which was written in February 1994 by I<Jan-Simon Pendry>. The work off
-of this code and the B<Path> library as a whole was written in January
-2000 by I<Ralf S. Engelschall>.
+The path_abs2rel(3) and path_rel2abs(3) function was originally written
+in December 1997 by I<Shigio Yamaguchi> for his I<PathConvert> project.
+The path_resolve(3) function is derived from FreeBSD's realpath(3)
+function which was written in February 1994 by I<Jan-Simon Pendry>.
+The work off of this code and the B<OSSP path> library as a whole was
+written in January 2000 by I<Ralf S. Engelschall> for use in the B<OSSP>
+project.
=cut
|
