opnsense-src/share/man/man5
Doug Rabson 1ca2f5d1f7 Add an implementation of the 9P filesystem
This is derived from swills@ fork of the Juniper virtfs with many
changes by me including bug fixes, style improvements, clearer layering
and more consistent logging. The filesystem is renamed to p9fs to better
reflect its function and to prevent possible future confusion with
virtio-fs.

Several updates and fixes from Juniper have been integrated into this
version by Val Packett and these contributions along with the original
Juniper authors are credited below.

To use this with bhyve, add 'virtio_p9fs_load=YES' to loader.conf. The
bhyve virtio-9p device allows access from the guest to files on the host
by mapping a 'sharename' to a host path. It is possible to use p9fs as a
root filesystem by adding this to /boot/loader.conf:

	vfs.root.mountfrom="p9fs:sharename"

for non-root filesystems add something like this to /etc/fstab:

	sharename /mnt p9fs rw 0 0

In both examples, substitute the share name used on the bhyve command
line.

The 9P filesystem protocol relies on stateful file opens which map
protocol-level FIDs to host file descriptors. The FreeBSD vnode
interface doesn't really support this and we use heuristics to guess the
right FID to use for file operations.  This can be confused by privilege
lowering and does not guarantee that the FID created for a given file
open is always used for file operations, even if the calling process is
using the file descriptor from the original open call. Improving this
would involve changes to the vnode interface which is out-of-scope for
this import.

Differential Revision: https://reviews.freebsd.org/D41844
Reviewed by: kib, emaste, dch
MFC after: 3 months
Co-authored-by: Val Packett <val@packett.cool>
Co-authored-by: Ka Ho Ng <kahon@juniper.net>
Co-authored-by: joyu <joyul@juniper.net>
Co-authored-by: Kumara Babu Narayanaswamy <bkumara@juniper.net>
2025-06-20 09:54:02 +02:00
..
a.out.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
acct.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
ar.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
autofs.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
bluetooth.device.conf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
bluetooth.hosts.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
bluetooth.protocols.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
boot.config.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
cd9660.5 etdump.1: Polish + xref cd9660(5) 2025-03-23 21:40:28 -04:00
core.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
devfs.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
devfs.conf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
devfs.rules.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
device.hints.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
dir.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
disktab.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
elf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
ethers.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
eui64.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
ext2fs.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
fbtab.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
fdescfs.5 Canonicalize the name of the FreeBSD Foundation 2025-02-19 09:58:47 -05:00
forward.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
freebsd-update.conf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
fs.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
fstab.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
fusefs.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
group.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
hesiod.conf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
hosts.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
hosts.equiv.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
hosts.lpd.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
intro.5 intro.5: Crossreference ascii(7) 2025-03-28 21:32:41 -04:00
libmap.conf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
lindebugfs.5 manuals: Fix "unusual .Xr" warnings with a script 2024-11-04 12:13:13 -04:00
link.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
linprocfs.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
linsysfs.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
mailer.conf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
make.conf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
Makefile Add an implementation of the 9P filesystem 2025-06-20 09:54:02 +02:00
Makefile.depend Remove $FreeBSD$: one-line sh pattern 2023-08-16 11:55:03 -06:00
moduli.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
motd.5 motd.5: Mention /etc/motd + alignment polish 2025-02-26 19:53:38 -05:00
mount.conf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
mqueuefs.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
msdosfs.5 msdosfs manuals: Improve visibility and linking 2025-04-19 20:44:27 -04:00
networks.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
nsmb.conf.5 smbfs manuals: describe consistently 2024-06-12 15:46:25 -06:00
nsswitch.conf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
nullfs.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
os-release.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
p9fs.5 Add an implementation of the 9P filesystem 2025-06-20 09:54:02 +02:00
passwd.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
pbm.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
periodic.conf.5 periodic/daily/801.trim-zfs: Add a daily zfs trim script 2024-04-16 13:54:20 -06:00
pf.conf.5 pf.conf.5: fix ≤ 2025-02-18 18:40:26 +01:00
pf.os.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
phones.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
portindex.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
procfs.5 procfs.4: Fix the description of credential info in the "status" file 2024-07-02 09:19:29 -04:00
protocols.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
quota.user.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
rc.conf.5 rc: Document rtadvd_flags 2025-01-14 14:14:24 +00:00
rctl.conf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
regdomain.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
remote.5 Use 115200 bps by default for serial communication 2023-08-17 13:31:38 -04:00
resolver.5 resolver.5: Fix example Google DNS server address 2024-11-03 10:04:46 -05:00
services.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
shells.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
smbfs.5 ports/filesystems: Fix fallout 2025-02-26 20:14:37 -05:00
src.conf.5 src.conf.5: LOADER_BIOS_TEXTONLY default change 2024-10-30 22:16:59 -06:00
stab.5 Remove $FreeBSD$: one-line nroff pattern 2023-08-16 11:55:15 -06:00
style.Makefile.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
style.mdoc.5 style.mdoc.5: Improve description compatability 2025-04-21 23:15:09 -04:00
sysctl.conf.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00
tarfs.5 tarfs: Fix typo. 2024-08-01 18:15:57 +02:00
tmpfs.5 Canonicalize the name of the FreeBSD Foundation 2025-02-19 09:58:47 -05:00
unionfs.5 Remove $FreeBSD$: two-line nroff pattern 2023-08-16 11:55:10 -06:00