author | Olivier Brunel
<jjk@jjacky.com> 2023-02-28 19:54:33 UTC |
committer | Olivier Brunel
<jjk@jjacky.com> 2023-03-02 17:41:11 UTC |
parent | cb5f2a9ff6b99f035d11105bb237c5c4b2f344c1 |
doc/rm_rfat.3.md | +3 | -0 |
doc/salsat.3.md | +4 | -1 |
doc/sareadlinkat.3.md | +7 | -4 |
diff --git a/doc/rm_rfat.3.md b/doc/rm_rfat.3.md index d42affb..68ae11c 100644 --- a/doc/rm_rfat.3.md +++ b/doc/rm_rfat.3.md @@ -9,6 +9,7 @@ rmstarat, rmstar\_tmpat, rmstar\_in\_tmpat - remove the full content of a direct # SYNOPSIS + #include <fcntl.h> /* AT_FDCWD */ #include <limb/djbunix.h> ```pre hl @@ -30,6 +31,8 @@ It is the equivalent to [rm_rf](3) function except when `name` specifies a relative path, the directory to be opened is then determined relative to the directory associated with the file descriptor `fd` instead of the current working directory. +If passed the special value *AT_FDCWD* in the `fd` parameter, the current +working directory is used. The `rm_rf_tmpat`() function is similar except that it will use the given stralloc `sa` as heap-allocated temporary space. diff --git a/doc/salsat.3.md b/doc/salsat.3.md index 709c966..a5aa1ca 100644 --- a/doc/salsat.3.md +++ b/doc/salsat.3.md @@ -7,6 +7,7 @@ salsat, salst, salstat - append directory listing into an stralloc # SYNOPSIS + #include <fcntl.h> /* AT_FDCWD */ #include <limb/djbunix.h> ```pre hl @@ -25,6 +26,8 @@ It is the equivalent to [sals](3) function except when `name` specifies a relative path, the directory to be opened is then determined relative to the directory associated with the file descriptor `fd` instead of the current working directory. +If passed the special value *AT_FDCWD* in the `fd` parameter, the current +working directory is used. If not NULL, `maxlen` will be set to the length of the longest file name added. (It will be 0 in case of empty directory.) @@ -32,7 +35,7 @@ If not NULL, `maxlen` will be set to the length of the longest file name added. `salst`() is a macro to [sals](3) with a slightly different interface, namely the stralloc `sa` as first argument. -Similarly, `salstat`() is a macro to [salsat](3) with a slightly different +Similarly, `salstat`() is a macro to `salsat`() with a slightly different interface as well. # RETURN VALUE diff --git a/doc/sareadlinkat.3.md b/doc/sareadlinkat.3.md index 780b7de..4e665e3 100644 --- a/doc/sareadlinkat.3.md +++ b/doc/sareadlinkat.3.md @@ -7,6 +7,7 @@ sareadlinkat - read the content of a symbolic link # SYNOPSIS + #include <fcntl.h> /* AT_FDCWD */ #include <limb/djbunix.h> ```pre hl @@ -18,11 +19,13 @@ int sareadlinkat(stralloc *<em>sa</em>, int <em>fd</em>, const char * restrict < The `sareadlinkat`() function places the content of the symbolic link referred to by `file` in the stralloc `sa`. -The symbolic link whose content is read is relative to the directory associated -with the file descriptor `fd`. If passed the special value `AT_FDCWD` in the -`fd` parameter, the current working directory is used. +For more details, refer to [readlinkat](3). -For more details, refer to [`readlinkat`](3). +It is equivalent to [sareadlink](3) except when `file` specifies a relative +path, the symbolic link whose content is read is then determined relative to +the directory associated with the file descriptor `fd`. +If passed the special value *AT_FDCWD* in the `fd` parameter, the current +working directory is used. # RETURN VALUE