From: Alejandro Colomar Date: Wed, 15 Jan 2025 19:41:01 +0000 (+0100) Subject: man/: Consistently use 'path' for parameters referring to pathnames X-Git-Tag: man-pages-6.15~60 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a239bc4520d6cb8b4d217510c22eddd7c3fd5d10;p=thirdparty%2Fman-pages.git man/: Consistently use 'path' for parameters referring to pathnames And use 'pathname' in the descriptions. 'pathname' is the POSIXly correct term, and 'path' is a reasonable abbreviation for it in parameter names. Cc: "G. Branden Robinson" Signed-off-by: Alejandro Colomar --- diff --git a/man/man2/acct.2 b/man/man2/acct.2 index d2d1be1c4..fe3606c17 100644 --- a/man/man2/acct.2 +++ b/man/man2/acct.2 @@ -12,7 +12,7 @@ Standard C library .nf .B #include .P -.BI "int acct(const char *_Nullable " filename ); +.BI "int acct(const char *_Nullable " path ); .fi .P .RS -4 @@ -34,10 +34,10 @@ Feature Test Macro Requirements for glibc (see The .BR acct () system call enables or disables process accounting. -If called with the name of an existing file as its argument, +If called with the pathname of an existing file as its argument, accounting is turned on, -and records for each terminating process are appended to -.I filename +and records for each terminating process +are appended to the file as it terminates. An argument of NULL causes accounting to be turned off. .SH RETURN VALUE @@ -51,38 +51,40 @@ is set to indicate the error. Write permission is denied for the specified file, or search permission is denied for one of the directories in the path prefix of -.I filename +.I path (see also .BR path_resolution (7)), or -.I filename +.I path is not a regular file. .TP .B EFAULT -.I filename +.I path points outside your accessible address space. .TP .B EIO Error writing to the file -.IR filename . +.IR path . .TP .B EISDIR -.I filename +.I path is a directory. .TP .B ELOOP Too many symbolic links were encountered in resolving -.IR filename . +.IR path . .TP .B ENAMETOOLONG -.I filename +.I path was too long. .TP .B ENFILE The system-wide limit on the total number of open files has been reached. .TP .B ENOENT -The specified file does not exist. +The specified +.I path +does not exist. .TP .B ENOMEM Out of memory. @@ -95,7 +97,7 @@ The kernel configuration parameter controlling this feature is .TP .B ENOTDIR A component used as a directory in -.I filename +.I path is not in fact a directory. .TP .B EPERM @@ -105,7 +107,7 @@ On Linux, the capability is required. .TP .B EROFS -.I filename +.I path refers to a file on a read-only filesystem. .TP .B EUSERS diff --git a/man/man2/utime.2 b/man/man2/utime.2 index 059835526..79a0c4e2c 100644 --- a/man/man2/utime.2 +++ b/man/man2/utime.2 @@ -12,12 +12,12 @@ Standard C library .nf .B #include .P -.BI "int utime(const char *" filename , +.BI "int utime(const char *" path , .BI " const struct utimbuf *_Nullable " times ); .P .B #include .P -.BI "int utimes(const char *" filename , +.BI "int utimes(const char *" path , .BI " const struct timeval " times "[_Nullable 2]);" .fi .SH DESCRIPTION @@ -29,7 +29,7 @@ The .BR utime () system call changes the access and modification times of the inode specified by -.I filename +.I path to the .IR actime " and " modtime fields of @@ -127,11 +127,11 @@ or the capability). .TP .B EFAULT -.I filename +.I path points to an invalid address. .TP .B ENOENT -.I filename +.I path does not exist. .TP .B EPERM diff --git a/man/man3/dbopen.3 b/man/man3/dbopen.3 index 802f43e6f..0ec15e3bb 100644 --- a/man/man3/dbopen.3 +++ b/man/man3/dbopen.3 @@ -17,7 +17,7 @@ Standard C library .B #include .B #include .P -.BI "DB *dbopen(const char *" file ", int " flags ", int " mode \ +.BI "DB *dbopen(const char *" path ", int " flags ", int " mode \ ", DBTYPE " type , .BI " const void *" openinfo ); .fi @@ -45,11 +45,11 @@ and .P .BR dbopen () opens -.I file +.I path for reading and/or writing. Files never intended to be preserved on disk may be created by setting the -.I file +.I path argument to NULL. .P The @@ -193,7 +193,7 @@ A file descriptor referencing the same file will be returned to all processes which call .BR dbopen () with the same -.I file +.I path name. This file descriptor may be safely used as an argument to the .BR fcntl (2) diff --git a/man/man3/dlopen.3 b/man/man3/dlopen.3 index 042525a25..9b40ac513 100644 --- a/man/man3/dlopen.3 +++ b/man/man3/dlopen.3 @@ -14,14 +14,14 @@ Dynamic linking library .nf .B #include .P -.BI "void *dlopen(const char *" filename ", int " flags ); +.BI "void *dlopen(const char *" path ", int " flags ); .BI "int dlclose(void *" handle ); .P .B #define _GNU_SOURCE .br .B #include .P -.BI "void *dlmopen(Lmid_t " lmid ", const char *" filename ", int " flags ); +.BI "void *dlmopen(Lmid_t " lmid ", const char *" path ", int " flags ); .fi .SH DESCRIPTION .SS dlopen() @@ -30,7 +30,7 @@ The function loads the dynamic shared object (shared library) file named by the null-terminated string -.I filename +.I path and returns an opaque "handle" for the loaded object. This handle is employed with other functions in the dlopen API, such as .BR dlsym (3), @@ -40,17 +40,17 @@ and .BR dlclose (). .P If -.I filename +.I path .\" FIXME On Solaris, when handle is NULL, we seem to get back .\" a handle for (something like) the root of the namespace. .\" The point here is that if we do a dlmopen(LM_ID_NEWLM), then -.\" the filename==NULL case returns a different handle than +.\" the path==NULL case returns a different handle than .\" in the initial namespace. But, on glibc, the same handle is .\" returned. This is probably a bug in glibc. .\" is NULL, then the returned handle is for the main program. If -.I filename +.I path contains a slash ("/"), then it is interpreted as a (relative or absolute) pathname. Otherwise, the dynamic linker searches for the object as follows @@ -81,7 +81,7 @@ The cache file (maintained by .BR ldconfig (8)) is checked to see whether it contains an entry for -.IR filename . +.IR path . .IP \[bu] The directories .I /lib @@ -90,7 +90,7 @@ and are searched (in that order). .P If the object specified by -.I filename +.I path has dependencies on other shared objects, then these are also automatically loaded by the dynamic linker using the same rules. @@ -167,7 +167,7 @@ its own symbols in preference to global symbols with the same name contained in objects that have already been loaded. .P If -.I filename +.I path is NULL, then the returned handle is for the main program. When given to .BR dlsym (3), @@ -235,7 +235,7 @@ fails for any reason, it returns NULL. .SS dlmopen() This function performs the same task as .BR dlopen ()\[em]the -.I filename +.I path and .I flags arguments, as well as the return value, are the same, @@ -280,7 +280,7 @@ to reference all of the other shared objects that it requires, since the new namespace is initially empty. .P If -.I filename +.I path is NULL, then the only permitted value for .I lmid is diff --git a/man/man3/futimes.3 b/man/man3/futimes.3 index e342edae3..d8505303a 100644 --- a/man/man3/futimes.3 +++ b/man/man3/futimes.3 @@ -14,7 +14,7 @@ Standard C library .B #include .P .BI "int futimes(int " fd ", const struct timeval " tv [2]); -.BI "int lutimes(const char *" filename ", const struct timeval " tv [2]); +.BI "int lutimes(const char *" path ", const struct timeval " tv [2]); .fi .P .RS -4 @@ -43,7 +43,7 @@ rather than via a pathname. changes the access and modification times of a file in the same way as .BR utimes (2), with the difference that if -.I filename +.I path refers to a symbolic link, then the link is not dereferenced: instead, the timestamps of the symbolic link are changed. .SH RETURN VALUE diff --git a/man/man3/getmntent.3 b/man/man3/getmntent.3 index fecc3f99e..48abdac4a 100644 --- a/man/man3/getmntent.3 +++ b/man/man3/getmntent.3 @@ -15,7 +15,7 @@ Standard C library .B #include .B #include .P -.BI "FILE *setmntent(const char *" filename ", const char *" type ); +.BI "FILE *setmntent(const char *" path ", const char *" type ); .P .BI "struct mntent *getmntent(FILE *" stream ); .P @@ -56,7 +56,7 @@ and the mounted filesystem description file The .BR setmntent () function opens the filesystem description file -.I filename +.I path and returns a file pointer which can be used by .BR getmntent (). The argument diff --git a/man/man3/getutent.3 b/man/man3/getutent.3 index 6bb4d3754..c9f7c4897 100644 --- a/man/man3/getutent.3 +++ b/man/man3/getutent.3 @@ -23,18 +23,18 @@ Standard C library .B void setutent(void); .B void endutent(void); .P -.BI "int utmpname(const char *" file ); +.BI "int utmpname(const char *" path ); .fi .SH DESCRIPTION New applications should use the POSIX.1-specified "utmpx" versions of these functions; see STANDARDS. .P .BR utmpname () -sets the name of the utmp-format file for the other utmp +sets the pathname of the utmp-format file for the other utmp functions to access. If .BR utmpname () -is not used to set the filename +is not used to set the pathname before the other functions are used, they assume .BR _PATH_UTMP , as defined in diff --git a/man/man3/updwtmp.3 b/man/man3/updwtmp.3 index 38099ba1f..08ad76f0b 100644 --- a/man/man3/updwtmp.3 +++ b/man/man3/updwtmp.3 @@ -13,7 +13,7 @@ System utilities library .nf .B #include .P -.BI "void updwtmp(const char *" wtmp_file ", const struct utmp *" ut ); +.BI "void updwtmp(const char *" wtmp_path ", const struct utmp *" ut ); .BI "void logwtmp(const char *" line ", const char *" name \ ", const char *" host ); .fi @@ -58,7 +58,7 @@ glibc provides (since glibc 2.1): .EX .BR "#define _GNU_SOURCE " "/* See feature_test_macros(7) */" .B #include -.BI "void updwtmpx (const char *" wtmpx_file ", const struct utmpx *" utx ); +.BI "void updwtmpx (const char *" wtmpx_path ", const struct utmpx *" utx ); .EE .in .P