diff --git a/man/ffs.1 b/man/ffs.1 index f95641a..dfeb1e7 100644 --- a/man/ffs.1 +++ b/man/ffs.1 @@ -7,12 +7,27 @@ ffs - the file filesystem .SH SYNOPSIS .PP -ffs [\f[I]FLAGS\f[R]/\f[I]OPTIONS\f[R]] [\f[I]INPUT\f[R]] +ffs [\f[I]FLAGS\f[R]] [\f[I]OPTIONS\f[R]] [\f[I]INPUT\f[R]] +.PD 0 +.P +.PD +ffs \f[I]--completions\f[R] \f[I]SHELL\f[R] +.PD 0 +.P +.PD +ffs [\f[I]-h\f[R]|\f[I]--help\f[R]] +.PD 0 +.P +.PD +ffs [\f[I]-V\f[R]|\f[I]--version\f[R]] .SH DESCRIPTION .PP -ffs---short for the file filesystem---lets you mount semi-structured -data as a filesystem, allowing you to work with modern formats using -familiar shell tools. +\f[I]ffs\f[R]---the \f[I]f\f[R]ile \f[I]f\f[R]ile\f[I]s\f[R]ystem---lets +you mount semi-structured data as a filesystem, allowing you to work +with modern formats using familiar shell tools. +.PP +\f[I]ffs\f[R] uses filesystems in userspace (FUSE); you must have these +installed on your system to use \f[I]ffs\f[R]. .SS Flags .TP -d, --debug @@ -139,6 +154,13 @@ When filenames are present, extensions will be used to infer the format being used. You can specify the source and target formats explicitly with \f[I]--source\f[R] and \f[I]--target\f[R], respectively. +.SH SEE ALSO +.PP +fuse(4), fusermount(3), mount(8), umount(8) +.PP +To learn more about FUSE (Filesystem in Userspace), check out libfuse +(Linux) and macFUSE (macOS) +. .SH BUGS .PP See . diff --git a/man/ffs.1.md b/man/ffs.1.md index 3386029..c7c679e 100644 --- a/man/ffs.1.md +++ b/man/ffs.1.md @@ -7,14 +7,21 @@ ffs - the file filesystem # SYNOPSIS -| ffs \[*FLAGS*/*OPTIONS*\] \[*INPUT*\] +| ffs \[*FLAGS*\] \[*OPTIONS*\] \[*INPUT*\] +| ffs *--completions* *SHELL* +| ffs \[*-h*|*--help*\] +| ffs \[*-V*|*--version*\] + # DESCRIPTION -ffs---short for the file filesystem---lets you mount semi-structured +*ffs*---the *f*ile *f*ile*s*ystem---lets you mount semi-structured data as a filesystem, allowing you to work with modern formats using familiar shell tools. +*ffs* uses filesystems in userspace (FUSE); you must have these +installed on your system to use *ffs*. + ## Flags -d, --debug @@ -156,6 +163,16 @@ When filenames are present, extensions will be used to infer the format being used. You can specify the source and target formats explicitly with *--source* and *--target*, respectively. +# SEE ALSO + +fuse(4), fusermount(3), mount(8), umount(8) + +To learn more about FUSE (Filesystem in Userspace), check out libfuse +(Linux) +[https://github.com/libfuse/libfuse](https://github.com/libfuse/libfuse) +and macFUSE (macOS) +[https://osxfuse.github.io/](https://osxfuse.github.io/). + # BUGS See