Skip to content

Commit

Permalink
man filesystems: move driver pages to section four
Browse files Browse the repository at this point in the history
Filesystem manual pages describe drivers, not formats;
except for fs, which describes the structures of ffs/ufs,
not how to use it in the system.

Reported by: emaste
Reviewed by: des, imp, meena (previous version)
Pull Request: #1077
  • Loading branch information
concussious authored and bsdimp committed May 16, 2024
1 parent a6d8be4 commit 1687d77
Show file tree
Hide file tree
Showing 22 changed files with 40 additions and 43 deletions.
23 changes: 23 additions & 0 deletions share/man/man4/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ MAN= aac.4 \
cc_vegas.4 \
${_ccd.4} \
ccr.4 \
cd9660.4 \
cd.4 \
cdce.4 \
cdceem.4 \
Expand Down Expand Up @@ -127,6 +128,7 @@ MAN= aac.4 \
dcons_crom.4 \
ddb.4 \
devctl.4 \
devfs.4 \
disc.4 \
disk.4 \
divert.4 \
Expand All @@ -147,18 +149,22 @@ MAN= aac.4 \
etherswitch.4 \
eventtimers.4 \
exca.4 \
ext2fs.4 \
e6060sw.4 \
fd.4 \
fdc.4 \
fdescfs.4 \
fdt.4 \
fdt_pinctrl.4 \
fdtbus.4 \
ffclock.4 \
ffs.4 \
filemon.4 \
firewire.4 \
${_ftgpio.4} \
${_ftwd.4} \
full.4 \
fusefs.4 \
fwe.4 \
fwip.4 \
fwohci.4 \
Expand Down Expand Up @@ -275,6 +281,9 @@ MAN= aac.4 \
le.4 \
led.4 \
lge.4 \
lindebugfs.4 \
linprocfs.4 \
linsysfs.4 \
${_linux.4} \
liquidio.4 \
lm75.4 \
Expand Down Expand Up @@ -321,7 +330,9 @@ MAN= aac.4 \
mpr.4 \
mps.4 \
mpt.4 \
mqueuefs.4 \
mrsas.4 \
msdosfs.4 \
msk.4 \
mtio.4 \
multicast.4 \
Expand Down Expand Up @@ -404,6 +415,7 @@ MAN= aac.4 \
${_nda.4} \
${_if_ntb.4} \
null.4 \
nullfs.4 \
numa.4 \
nvd.4 \
${_nvdimm.4} \
Expand Down Expand Up @@ -446,6 +458,7 @@ MAN= aac.4 \
ppc.4 \
ppi.4 \
procdesc.4 \
procfs.4 \
proto.4 \
ps4dshock.4 \
psm.4 \
Expand Down Expand Up @@ -504,6 +517,7 @@ MAN= aac.4 \
sk.4 \
${_smartpqi.4} \
smb.4 \
smbfs.4 \
smbios.4 \
smbus.4 \
smp.4 \
Expand Down Expand Up @@ -548,6 +562,7 @@ MAN= aac.4 \
syscons.4 \
sysmouse.4 \
tap.4 \
tarfs.4 \
targ.4 \
tcp.4 \
tcp_bbr.4 \
Expand All @@ -557,6 +572,7 @@ MAN= aac.4 \
textdump.4 \
ti.4 \
timecounters.4 \
tmpfs.4 \
${_tpm.4} \
tslog.4 \
tty.4 \
Expand All @@ -565,6 +581,7 @@ MAN= aac.4 \
tws.4 \
udp.4 \
udplite.4 \
unionfs.4 \
ure.4 \
vale.4 \
vga.4 \
Expand Down Expand Up @@ -670,6 +687,7 @@ MLINKS+=em.4 if_em.4 \
MLINKS+=enc.4 if_enc.4
MLINKS+=epair.4 if_epair.4
MLINKS+=et.4 if_et.4
MLINKS+=ext2fs.4 ext4fs.4 \
MLINKS+=fd.4 stderr.4 \
fd.4 stdin.4 \
fd.4 stdout.4
Expand Down Expand Up @@ -719,6 +737,7 @@ MLINKS+=mfi.4 mfi_linux.4 \
mfi.4 mfip.4
MLINKS+=mlx5en.4 mce.4
MLINKS+=mos.4 if_mos.4
MLINKS+=msdosfs.4 msdos.4
MLINKS+=msk.4 if_msk.4
MLINKS+=mwl.4 if_mwl.4
MLINKS+=mxge.4 if_mxge.4
Expand Down Expand Up @@ -914,6 +933,10 @@ SUBDIR+= man4.${__arch}
.endif
.endfor

.if ${MK_AUTOFS} != "no"
MAN+= autofs.4
.endif

.if ${MK_BLUETOOTH} != "no"
MAN+= ng_bluetooth.4
.endif
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/autofs.5 → share/man/man4/autofs.4
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
.\" SUCH DAMAGE.
.\"
.Dd December 2, 2017
.Dt AUTOFS 5
.Dt AUTOFS 4
.Os
.Sh NAME
.Nm autofs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/cd9660.5 → share/man/man4/cd9660.4
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd April 25, 2023
.Dt CD9660 5
.Dt CD9660 4
.Os
.Sh NAME
.Nm cd9660
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/devfs.5 → share/man/man4/devfs.4
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
.\" SUCH DAMAGE.
.\"
.Dd June 30, 2022
.Dt DEVFS 5
.Dt DEVFS 4
.Os
.Sh NAME
.Nm devfs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/ext2fs.5 → share/man/man4/ext2fs.4
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd December 30, 2018
.Dt EXT2FS 5
.Dt EXT2FS 4
.Os
.Sh NAME
.Nm ext2fs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/fdescfs.5 → share/man/man4/fdescfs.4
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
.\" SUCH DAMAGE.
.\"
.Dd Jul 11, 2023
.Dt FDESCFS 5
.Dt FDESCFS 4
.Os
.Sh NAME
.Nm fdescfs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man7/ffs.7 → share/man/man4/ffs.4
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
.\" SUCH DAMAGE.
.\"
.Dd May 3, 2020
.Dt FFS 7
.Dt FFS 4
.Os
.Sh NAME
.Nm ffs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/fusefs.5 → share/man/man4/fusefs.4
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.Dd July 31, 2019
.Dt FUSEFS 5
.Dt FUSEFS 4
.Os
.Sh NAME
.Nm fusefs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
.\" SUCH DAMAGE.

.Dd August 10, 2022
.Dt LINDEBUGFS 5
.Dt LINDEBUGFS 4
.Os
.Sh NAME
.Nm lindebugfs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/linprocfs.5 → share/man/man4/linprocfs.4
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.\" This file is in the public domain.
.\"
.Dd November 13, 2019
.Dt LINPROCFS 5
.Dt LINPROCFS 4
.Os
.Sh NAME
.Nm linprocfs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/linsysfs.5 → share/man/man4/linsysfs.4
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.\" This file is in the public domain.
.\"
.Dd November 13, 2019
.Dt LINSYSFS 5
.Dt LINSYSFS 4
.Os
.Sh NAME
.Nm linsysfs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/mqueuefs.5 → share/man/man4/mqueuefs.4
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd November 30, 2005
.Dt MQUEUEFS 5
.Dt MQUEUEFS 4
.Os
.Sh NAME
.Nm mqueuefs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/msdosfs.5 → share/man/man4/msdosfs.4
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.\" This file is in the public domain.
.\"
.Dd September 27, 2018
.Dt MSDOSFS 5
.Dt MSDOSFS 4
.Os
.Sh NAME
.Nm msdosfs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/nullfs.5 → share/man/man4/nullfs.4
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd March 15, 2022
.Dt NULLFS 5
.Dt NULLFS 4
.Os
.Sh NAME
.Nm nullfs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/procfs.5 → share/man/man4/procfs.4
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.\" This file is in the public domain.
.\"
.Dd April 10, 2023
.Dt PROCFS 5
.Dt PROCFS 4
.Os
.Sh NAME
.Nm procfs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/smbfs.5 → share/man/man4/smbfs.4
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
.\" SUCH DAMAGE.
.\"
.Dd April 6, 2022
.Dt SMBFS 5
.Dt SMBFS 4
.Os
.Sh NAME
.Nm smbfs
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion share/man/man5/tmpfs.5 → share/man/man4/tmpfs.4
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd September 18, 2023
.Dt TMPFS 5
.Dt TMPFS 4
.Os
.Sh NAME
.Nm tmpfs
Expand Down
2 changes: 1 addition & 1 deletion share/man/man5/unionfs.5 → share/man/man4/unionfs.4
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
.\" SUCH DAMAGE.
.\"
.Dd April 27, 2020
.Dt UNIONFS 5
.Dt UNIONFS 4
.Os
.Sh NAME
.Nm unionfs
Expand Down
22 changes: 0 additions & 22 deletions share/man/man5/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ MAN= acct.5 \
ar.5 \
a.out.5 \
${_boot.config.5} \
cd9660.5 \
core.5 \
devfs.5 \
devfs.conf.5 \
devfs.rules.5 \
device.hints.5 \
Expand All @@ -17,41 +15,31 @@ MAN= acct.5 \
elf.5 \
ethers.5 \
eui64.5 \
ext2fs.5 \
fbtab.5 \
fdescfs.5 \
forward.5 \
fs.5 \
fstab.5 \
fusefs.5 \
group.5 \
hosts.5 \
hosts.equiv.5 \
hosts.lpd.5 \
intro.5 \
libmap.conf.5 \
lindebugfs.5 \
link.5 \
linprocfs.5 \
linsysfs.5 \
mailer.conf.5 \
make.conf.5 \
moduli.5 \
motd.5 \
mount.conf.5 \
mqueuefs.5 \
msdosfs.5 \
networks.5 \
nsmb.conf.5 \
nsswitch.conf.5 \
nullfs.5 \
os-release.5 \
passwd.5 \
pbm.5 \
periodic.conf.5 \
phones.5 \
portindex.5 \
procfs.5 \
protocols.5 \
quota.user.5 \
rc.conf.5 \
Expand All @@ -61,21 +49,15 @@ MAN= acct.5 \
resolver.5 \
services.5 \
shells.5 \
smbfs.5 \
src.conf.5 \
stab.5 \
style.Makefile.5 \
style.mdoc.5 \
sysctl.conf.5 \
tarfs.5 \
tmpfs.5 \
unionfs.5

MLINKS= dir.5 dirent.5
MLINKS+=ext2fs.5 ext4fs.5
MLINKS+=fs.5 inode.5
MLINKS+=hosts.equiv.5 rhosts.5
MLINKS+=msdosfs.5 msdos.5
MLINKS+=passwd.5 master.passwd.5
MLINKS+=passwd.5 pwd.db.5
MLINKS+=passwd.5 spwd.db.5
Expand All @@ -85,10 +67,6 @@ MLINKS+=rc.conf.5 rc.conf.local.5
MLINKS+=resolver.5 resolv.conf.5
MLINKS+=src.conf.5 src-env.conf.5

.if ${MK_AUTOFS} != "no"
MAN+= autofs.5
.endif

.if ${MK_BLUETOOTH} != "no"
MAN+= bluetooth.device.conf.5 \
bluetooth.hosts.5 \
Expand Down
1 change: 0 additions & 1 deletion share/man/man7/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ MAN= arch.7 \
crypto.7 \
development.7 \
environ.7 \
ffs.7 \
firewall.7 \
growfs.7 \
hier.7 \
Expand Down
3 changes: 0 additions & 3 deletions share/man/man7/intro.7
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,6 @@ development introduction to
.Fx
.It Xr environ 7
user environment
.It Xr ffs 7
commonly used filesystem in
.Fx
.It Xr firewall 7
simple firewalls under
.Fx
Expand Down

0 comments on commit 1687d77

Please sign in to comment.