Bug 192562 - zfs(5): missing manpage
Summary: zfs(5): missing manpage
Status: Closed Overcome By Events
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-bugs (Nobody)
URL: https://reviews.freebsd.org/D3207
Keywords:
Depends on:
Blocks: 108980
  Show dependency treegraph
 
Reported: 2014-08-10 20:32 UTC by Enji Cooper
Modified: 2024-08-23 13:22 UTC (History)
5 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Enji Cooper freebsd_committer freebsd_triage 2014-08-10 20:32:46 UTC
Many of the filesystems in FreeBSD have a section 5 manpage for them (see msdosfs(5), tmpfs(5), etc), which describes what kernel options are required in order to load the filesystem, how it can be managed (via fstab(5), mount(8), etc). zfs(5) doesn't exist though.
Comment 1 Dru Lavigne freebsd_committer freebsd_triage 2015-07-25 20:17:23 UTC
Adding Sean to cc as he has some ideas for zfs(5).
Comment 2 Sean Chittenden freebsd_committer freebsd_triage 2015-07-26 15:20:32 UTC
Diff available for review here:

https://reviews.freebsd.org/D3207

After commentary, I will attach the final version.
Comment 3 Mark Linimon freebsd_committer freebsd_triage 2021-06-11 23:49:36 UTC
^Triage: remove dru@ from Cc: list.
Comment 4 Graham Perrin freebsd_committer freebsd_triage 2022-06-29 18:07:05 UTC
(In reply to Enji Cooper from comment #0)

> … Many of the filesystems in FreeBSD have a section 5 manpage …

Section 7 for ffs: 

<https://www.freebsd.org/cgi/man.cgi?query=ffs&sektion=7&manpath=FreeBSD>

Sections 8 (and 4) for zfs (and tuning thereof) in ZFS: 

<https://openzfs.github.io/openzfs-docs/man/8/zfs.8.html>
<https://openzfs.github.io/openzfs-docs/man/4/zfs.4.html>
Comment 5 Alexander Ziaee freebsd_triage 2024-05-15 04:55:30 UTC
Update: We are moving all the filesystem manuals to section four in
https://github.com/freebsd/freebsd-src/pull/1077
feedback and suggestions are desired in that thread :)

Filesystem pages in section five don't describe file formats, they describe the kernel interface of the filesystem driver.

ZFS is actually demonstrating what we're trying to do: there's zfs(4) for that, and then z$whatever(8) for the tooling and z$whatever(7) for concept overviews.
Comment 6 Alexander Ziaee freebsd_triage 2024-08-22 21:39:53 UTC
Since we have moved filesystem manuals to section 4, and zfs(4) exists, this can be closed.