sbase/readlink.1

.Dd 2015-10-08
.Dt READLINK 1
.Os sbase
.Sh NAME
.Nm readlink
.Nd print symbolic link target or canonical file name
.Sh SYNOPSIS
.Nm
.Op Fl e | Fl f | Fl m
.Op Fl n
.Ar path
.Sh DESCRIPTION
.Nm
writes the target of
.Ar path ,
if it is a symbolic link, to stdout.
If not,
.Nm
exits with a non-zero return value.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl e | Fl f | Fl m
Canonicalize
.Ar name ,
which needn't be a symlink,
by recursively following every symlink in its path components.
All | All but the last | No path components must exist.
.It Fl n
Do not print the terminating newline.
.El
.Sh SEE ALSO
.Xr readlink 2 ,
.Xr realpath 3
Use ISO-date-format in manpages The one specified by mdoc is hard to read for non-native speakers from countries which read the date day-first (like Germany, Greece, North-Korea, Swamp,...). This is also consistent with how we generally specify dates at suckless.org. 2015-10-08 11:15:08 -04:00			`.Dd 2015-10-08`
remove sbase-VERSION from man page, fix sponge.1 date 2015-01-31 08:20:02 -05:00			`.Dt READLINK 1`
Add .Os sbase and sed replace to .Os sbase $(VERSION) in make install 2015-01-31 14:37:03 -05:00			`.Os sbase`
readlink.1: convert to mandoc 2015-01-30 17:34:36 -05:00			`.Sh NAME`
			`.Nm readlink`
Edit readlink.1 and document missing flags 2015-01-31 18:43:43 -05:00			`.Nd print symbolic link target or canonical file name`
readlink.1: convert to mandoc 2015-01-30 17:34:36 -05:00			`.Sh SYNOPSIS`
			`.Nm`
Audit readlink(1) 1) Properly document e, f and m-flags in the manpage. 2) Clear up the code for the m-flag-handling. Add idiomatic '/'-path-traversal as already seen in mkdir(1). 3) Unwrap the SWAP_BUF()-macro. 4) BUGFIX: Actually handle the f-flag properly. Only resolve the dirname and append the basename later. 5) Use fputs() instead of printf("%s", ...). 2015-03-20 17:09:47 -04:00			`.Op Fl e \| Fl f \| Fl m`
			`.Op Fl n`
			`.Ar path`
readlink.1: convert to mandoc 2015-01-30 17:34:36 -05:00			`.Sh DESCRIPTION`
			`.Nm`
Audit readlink(1) 1) Properly document e, f and m-flags in the manpage. 2) Clear up the code for the m-flag-handling. Add idiomatic '/'-path-traversal as already seen in mkdir(1). 3) Unwrap the SWAP_BUF()-macro. 4) BUGFIX: Actually handle the f-flag properly. Only resolve the dirname and append the basename later. 5) Use fputs() instead of printf("%s", ...). 2015-03-20 17:09:47 -04:00			`writes the target of`
			`.Ar path ,`
			`if it is a symbolic link, to stdout.`
			`If not,`
readlink.1: convert to mandoc 2015-01-30 17:34:36 -05:00			`.Nm`
Audit readlink(1) 1) Properly document e, f and m-flags in the manpage. 2) Clear up the code for the m-flag-handling. Add idiomatic '/'-path-traversal as already seen in mkdir(1). 3) Unwrap the SWAP_BUF()-macro. 4) BUGFIX: Actually handle the f-flag properly. Only resolve the dirname and append the basename later. 5) Use fputs() instead of printf("%s", ...). 2015-03-20 17:09:47 -04:00			`exits with a non-zero return value.`
readlink.1: convert to mandoc 2015-01-30 17:34:36 -05:00			`.Sh OPTIONS`
			`.Bl -tag -width Ds`
Audit readlink(1) 1) Properly document e, f and m-flags in the manpage. 2) Clear up the code for the m-flag-handling. Add idiomatic '/'-path-traversal as already seen in mkdir(1). 3) Unwrap the SWAP_BUF()-macro. 4) BUGFIX: Actually handle the f-flag properly. Only resolve the dirname and append the basename later. 5) Use fputs() instead of printf("%s", ...). 2015-03-20 17:09:47 -04:00			`.It Fl e \| Fl f \| Fl m`
Edit readlink.1 and document missing flags 2015-01-31 18:43:43 -05:00			`Canonicalize`
			`.Ar name ,`
Audit readlink(1) 1) Properly document e, f and m-flags in the manpage. 2) Clear up the code for the m-flag-handling. Add idiomatic '/'-path-traversal as already seen in mkdir(1). 3) Unwrap the SWAP_BUF()-macro. 4) BUGFIX: Actually handle the f-flag properly. Only resolve the dirname and append the basename later. 5) Use fputs() instead of printf("%s", ...). 2015-03-20 17:09:47 -04:00			`which needn't be a symlink,`
			`by recursively following every symlink in its path components.`
			`All \| All but the last \| No path components must exist.`
readlink.1: convert to mandoc 2015-01-30 17:34:36 -05:00			`.It Fl n`
Audit readlink(1) 1) Properly document e, f and m-flags in the manpage. 2) Clear up the code for the m-flag-handling. Add idiomatic '/'-path-traversal as already seen in mkdir(1). 3) Unwrap the SWAP_BUF()-macro. 4) BUGFIX: Actually handle the f-flag properly. Only resolve the dirname and append the basename later. 5) Use fputs() instead of printf("%s", ...). 2015-03-20 17:09:47 -04:00			`Do not print the terminating newline.`
readlink.1: convert to mandoc 2015-01-30 17:34:36 -05:00			`.El`
			`.Sh SEE ALSO`
			`.Xr readlink 2 ,`
			`.Xr realpath 3`