Changeset View
Standalone View
usr.sbin/fstyp/fstyp.8
Show All 21 Lines | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd January 14, 2015 | .Dd May 17, 2015 | ||||
.Dt FSTYP 8 | .Dt FSTYP 8 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm fstyp | .Nm fstyp | ||||
.Nd determine filesystem type | .Nd determine filesystem type | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
.Nm | .Nm | ||||
.Op Fl l | .Op Fl l | ||||
.Op Fl s | .Op Fl s | ||||
.Op Fl u | |||||
.Ar special | .Ar special | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
The | The | ||||
.Nm | .Nm | ||||
utility is used to determine the filesystem type on a given device. | utility is used to determine the filesystem type on a given device. | ||||
It can recognize ISO-9660, Ext2, FAT, NTFS, and UFS filesystems. | It can recognize ISO-9660, Ext2, FAT, NTFS, and UFS filesystems. | ||||
When the | |||||
wblock: This sentence is not needed (see below). | |||||
.Fl u | |||||
flag is specified, | |||||
.Nm | |||||
Done Inline ActionsThe parts about ZFS conflict between these two sentences, and the second one is kind of confusing. Better to tell the user why: When the wblock: The parts about ZFS conflict between these two sentences, and the second one is kind of… | |||||
also recognizes certain additional metadata formats that cannot be | |||||
Done Inline ActionsThis sentence is not needed. wblock: This sentence is not needed. | |||||
Not Done Inline ActionsI agree - I'd drop the "The output of ... manually with mount(8)" sentence, and add something like wblock@ suggested - "When the -u flag is specified, fstyp also recognizes certain metadata formats that cannot be handled using mount(8), eg. ZFS pools and GELI providers". trasz: I agree - I'd drop the "The output of ... manually with mount(8)" sentence, and add something… | |||||
handled using | |||||
.Xr mount 8 , | |||||
such as ZFS pools and | |||||
.Xr geli 8 | |||||
provides. | |||||
Not Done Inline Actionss/provides/providers asomers: s/provides/providers | |||||
.Pp | |||||
Done Inline ActionsZFS should probably not be mentioned here. wblock: ZFS should probably not be mentioned here.
Add a sentence that says the normal output is meant… | |||||
The filesystem name is printed to the standard output | The filesystem name is printed to the standard output | ||||
as, respectively, | as, respectively: | ||||
.Li cd9660 , | .Bl -item -offset indent -compact | ||||
.Li ext2fs , | .It | ||||
.Li msdosfs , | cd9660 | ||||
.Li ntfs , | .It | ||||
or | ext2fs | ||||
.Li ufs . | .It | ||||
geli | |||||
.It | |||||
msdosfs | |||||
.It | |||||
ntfs | |||||
.It | |||||
ufs | |||||
.It | |||||
zfs | |||||
.El | |||||
.Pp | .Pp | ||||
Because | Because | ||||
.Nm | .Nm | ||||
is built specifically to detect filesystem types, it differs from | is built specifically to detect filesystem types, it differs from | ||||
.Xr file 1 | .Xr file 1 | ||||
in several ways. | in several ways. | ||||
The output is machine-parsable, filesystem labels are supported, | The output is machine-parsable, filesystem labels are supported, | ||||
the utility runs sandboxed using | the utility runs sandboxed using | ||||
.Xr capsicum 4 , | .Xr capsicum 4 , | ||||
and does not try to recognize any file format other than filesystems. | and does not try to recognize any file format other than filesystems. | ||||
.Pp | .Pp | ||||
These options are available: | These options are available: | ||||
.Bl -tag -width ".Fl l" | .Bl -tag -width ".Fl l" | ||||
.It Fl l | .It Fl l | ||||
In addition to filesystem type, print filesystem label if available. | In addition to filesystem type, print filesystem label if available. | ||||
.It Fl s | .It Fl s | ||||
Ignore file type. | Ignore file type. | ||||
By default, | By default, | ||||
.Nm | .Nm | ||||
only works on regular files and disk-like device nodes. | only works on regular files and disk-like device nodes. | ||||
Trying to read other file types might have unexpected consequences or hang | Trying to read other file types might have unexpected consequences or hang | ||||
indefinitely. | indefinitely. | ||||
.It Fl u | |||||
Include filesystems and devices that cannot be mounted directly by | |||||
Done Inline ActionsHow about "Include filesystems such as ZFS and GELI that cannot be mounted directly using mount(8)"? trasz: How about "Include filesystems such as ZFS and GELI that cannot be mounted directly using mount… | |||||
Done Inline ActionsGELI is not a filesystem, though. Might be better to be less specific: Include filesystems and devices that cannot be mounted directly by wblock: GELI is not a filesystem, though. Might be better to be less specific:
Include filesystems… | |||||
Not Done Inline ActionsRemove "special"? trasz: Remove "special"? | |||||
.Xr mount 8 . | |||||
.El | .El | ||||
.Sh EXIT STATUS | .Sh EXIT STATUS | ||||
The | The | ||||
.Nm | .Nm | ||||
utility exits 0 on success, and >0 if an error occurs or the filesystem | utility exits 0 on success, and >0 if an error occurs or the filesystem | ||||
type is not recognized. | type is not recognized. | ||||
.Sh SEE ALSO | .Sh SEE ALSO | ||||
.Xr file 1 , | .Xr file 1 , | ||||
.Xr capsicum 4 , | .Xr capsicum 4 , | ||||
.Xr autofs 8 , | |||||
.Xr geli 8 , | |||||
.Xr glabel 8 , | .Xr glabel 8 , | ||||
.Xr mount 8 | .Xr mount 8 , | ||||
Not Done Inline Actionsgeli comes before glabel (sort by alpha within the category number). wblock: geli comes before glabel (sort by alpha within the category number). | |||||
.Xr zpool 8 | |||||
.Sh HISTORY | .Sh HISTORY | ||||
The | The | ||||
.Nm | .Nm | ||||
command appeared in | command appeared in | ||||
.Fx 11.0 . | .Fx 11.0 . | ||||
.Sh AUTHORS | .Sh AUTHORS | ||||
The | The | ||||
.Nm | .Nm | ||||
utility was developed by | utility was developed by | ||||
.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org | .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org | ||||
under sponsorship from the FreeBSD Foundation. | under sponsorship from the FreeBSD Foundation. | ||||
Support for ZFS and GELI were added by | |||||
Done Inline Actions"support" is singular, so s/were/was/. wblock: "support" is singular, so s/were/was/. | |||||
Not Done Inline ActionsThat reads oddly to me. How is: "Support for ZFS and GELI were added by" allanjude: That reads oddly to me. How is: "Support for ZFS and GELI were added by" | |||||
wblockUnsubmitted Not Done Inline Actions"Support" is still singular, so "were" doesn't work: "Support ... were added by". But it can be rearranged: wblock: "Support" is still singular, so "were" doesn't work: "Support ... were added by".
But it can… | |||||
Not Done Inline ActionsOr even "Allan Jude added ZFS and GELI support." emaste: Or even "Allan Jude added ZFS and GELI support." | |||||
.An Allan Jude Aq Mt allanjude@FreeBSD.org | |||||
Done Inline Actionsplease fix this eadler: please fix this |
This sentence is not needed (see below).