Skip to content

Commit 99c346c

Browse files
committed
better manpage [ci skip]
1 parent e243e80 commit 99c346c

2 files changed

Lines changed: 45 additions & 6 deletions

File tree

man/ffs.1

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,27 @@
77
ffs - the file filesystem
88
.SH SYNOPSIS
99
.PP
10-
ffs [\f[I]FLAGS\f[R]/\f[I]OPTIONS\f[R]] [\f[I]INPUT\f[R]]
10+
ffs [\f[I]FLAGS\f[R]] [\f[I]OPTIONS\f[R]] [\f[I]INPUT\f[R]]
11+
.PD 0
12+
.P
13+
.PD
14+
ffs \f[I]--completions\f[R] \f[I]SHELL\f[R]
15+
.PD 0
16+
.P
17+
.PD
18+
ffs [\f[I]-h\f[R]|\f[I]--help\f[R]]
19+
.PD 0
20+
.P
21+
.PD
22+
ffs [\f[I]-V\f[R]|\f[I]--version\f[R]]
1123
.SH DESCRIPTION
1224
.PP
13-
ffs---short for the file filesystem---lets you mount semi-structured
14-
data as a filesystem, allowing you to work with modern formats using
15-
familiar shell tools.
25+
\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
26+
you mount semi-structured data as a filesystem, allowing you to work
27+
with modern formats using familiar shell tools.
28+
.PP
29+
\f[I]ffs\f[R] uses filesystems in userspace (FUSE); you must have these
30+
installed on your system to use \f[I]ffs\f[R].
1631
.SS Flags
1732
.TP
1833
-d, --debug
@@ -139,6 +154,13 @@ When filenames are present, extensions will be used to infer the format
139154
being used.
140155
You can specify the source and target formats explicitly with
141156
\f[I]--source\f[R] and \f[I]--target\f[R], respectively.
157+
.SH SEE ALSO
158+
.PP
159+
fuse(4), fusermount(3), mount(8), umount(8)
160+
.PP
161+
To learn more about FUSE (Filesystem in Userspace), check out libfuse
162+
(Linux) <https://github.com/libfuse/libfuse> and macFUSE (macOS)
163+
<https://osxfuse.github.io/>.
142164
.SH BUGS
143165
.PP
144166
See <https://github.com/mgree/ffs/issues>.

man/ffs.1.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,21 @@ ffs - the file filesystem
77

88
# SYNOPSIS
99

10-
| ffs \[*FLAGS*/*OPTIONS*\] \[*INPUT*\]
10+
| ffs \[*FLAGS*\] \[*OPTIONS*\] \[*INPUT*\]
11+
| ffs *--completions* *SHELL*
12+
| ffs \[*-h*|*--help*\]
13+
| ffs \[*-V*|*--version*\]
14+
1115

1216
# DESCRIPTION
1317

14-
ffs---short for the file filesystem---lets you mount semi-structured
18+
*ffs*---the *f*ile *f*ile*s*ystem---lets you mount semi-structured
1519
data as a filesystem, allowing you to work with modern formats using
1620
familiar shell tools.
1721

22+
*ffs* uses filesystems in userspace (FUSE); you must have these
23+
installed on your system to use *ffs*.
24+
1825
## Flags
1926

2027
-d, --debug
@@ -156,6 +163,16 @@ When filenames are present, extensions will be used to infer the
156163
format being used. You can specify the source and target formats
157164
explicitly with *--source* and *--target*, respectively.
158165

166+
# SEE ALSO
167+
168+
fuse(4), fusermount(3), mount(8), umount(8)
169+
170+
To learn more about FUSE (Filesystem in Userspace), check out libfuse
171+
(Linux)
172+
[https://github.com/libfuse/libfuse](https://github.com/libfuse/libfuse)
173+
and macFUSE (macOS)
174+
[https://osxfuse.github.io/](https://osxfuse.github.io/).
175+
159176
# BUGS
160177

161178
See

0 commit comments

Comments
 (0)