Files
plan9port/man/man9/clunk.9p
Dmitri Vereshchagin 10564b1175 tmac/tmac.an: define .MR in a groff compatible way
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.
2025-07-27 09:58:50 -04:00

56 lines
888 B
Plaintext

.TH CLUNK 9P
.SH NAME
clunk \- forget about a fid
.SH SYNOPSIS
.ta \w'\fLTclunk 'u
.IR size [4]
.B Tclunk
.IR tag [2]
.IR fid [4]
.br
.IR size [4]
.B Rclunk
.IR tag [2]
.SH DESCRIPTION
The
.B clunk
request informs the file server
that the current file represented by
.I fid
is no longer needed by the client.
The actual file is not removed on the server unless the fid had been opened with
.BR ORCLOSE .
.PP
Once a fid has been clunked,
the same fid can be reused in a new
.B walk
or
.B attach
request.
.PP
Even if the
.B clunk
returns an error, the
.I fid
is no longer valid.
.SH ENTRY POINTS
.B Clunk
transactions are
generated by
.I fsclose
and
.I fsunmount
(see
.MR 9pclient 3 )
and indirectly by other actions such as failed
.I fsopen
calls.
.\"
.\" A
.\" .B clunk
.\" message is generated by
.\" .I close
.\" and indirectly by other actions such as failed
.\" .I open
.\" calls.