Files
plan9port/man/man4/ramfs.4
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

51 lines
888 B
Groff

.TH RAMFS 4
.SH NAME
ramfs \- memory file system
.SH SYNOPSIS
.B ramfs
[
.B -i
]
[
.B -S
.I service
]
.SH DESCRIPTION
.I Ramfs
starts a 9P file server
keeping all files in memory.
Initially the file tree is empty.
.PP
By default
.I ramfs
posts its service as
.B ramfs
using
.MR 9pserve 4 .
.PP
The
.B -S
flag specifies an alternate service name for ramfs to use.
.PP
The
.B -i
flag tells
.I ramfs
to use file descriptors 0 and 1 for its communication channel
rather than create a pipe.
This makes it possible to use
.I ramfs
as a file server on a remote machine: the file descriptors 0
and 1 will be the network channel from
.I ramfs
to the client machine.
.PP
This program is useful mainly as an example of how
to write a user-level file server.
It can also be used to provide high-performance temporary files.
.SH SOURCE
.B \*9/src/cmd/ramfs.c
.SH "SEE ALSO"
.MR 9p 3 ,
.MR 9pserve 4