10564b1175
groff 1.23.0 added .MR to its -man macro package. The NEWS file states
that the inclusion of the macro "was prompted by its introduction to
Plan 9 from User Space's troff in August 2020." From d32deab it seems
that the name for Plan 9 from User Space's implementation was suggested
by groff maintainer G. Brandon Robinson.
Not sure if the intention was to make these definitions compatible, but
it would be nice if they were.
Currently, Plan 9 from User Space's .MR expects its second argument to
be parenthesized. groff's .MR does not. This results in extra
parentheses appearing in manual references when viewing Plan 9 from User
Space's manual pages on a system using groff.
35 lines
701 B
Groff
35 lines
701 B
Groff
.TH CLEANNAME 3
|
|
.SH NAME
|
|
cleanname \- clean a path name
|
|
.SH SYNOPSIS
|
|
.B #include <u.h>
|
|
.br
|
|
.B #include <libc.h>
|
|
.sp
|
|
.B
|
|
char* cleanname(char *filename)
|
|
.SH DESCRIPTION
|
|
.I Cleanname
|
|
takes a
|
|
.I filename
|
|
and by lexical processing only returns the shortest string that names the same (possibly
|
|
hypothetical) file.
|
|
It eliminates multiple and trailing slashes, and it lexically interprets
|
|
.B .
|
|
and
|
|
.B ..
|
|
directory components in the name.
|
|
The string is overwritten in place.
|
|
.PP
|
|
The shortest string
|
|
.I cleanname
|
|
can return is two bytes: the null-terminated string
|
|
\f(CW"."\f1.
|
|
Therefore
|
|
.I filename
|
|
must contain room for at least two bytes.
|
|
.SH SOURCE
|
|
.B \*9/src/lib9/cleanname.c
|
|
.SH SEE ALSO
|
|
.MR cleanname 1
|