ref: 2e813791d4890adf9173f1acc25e8eab4a4745bf
parent: 4e0e682ebbfd63916d8bf58a4f4795b69d37d108
author: Ori Bernstein <ori@eigenstate.org>
date: Fri Apr 28 13:05:59 EDT 2023
gefs(4), gefs(8): add manpages
--- /dev/null
+++ b/gefs.4.man
@@ -1,0 +1,91 @@
+.TH GEFS 4
+.SH NAME
+gefs \- file server
+.SH SYNOPSIS
+.B gefs
+[
+.B -A
+]
+[
+.B -r
+.I user
+]
+[
+.B -f
+.I file
+]
+[
+.B -m
+.I mem
+]
+[
+.B -n
+.I name
+]
+[
+.B -a
+.I ann
+] ...
+[
+.B -S
+]
+[
+.B -s
+]
+.SH DESCRIPTION
+.I Gefs
+is an experimental file server.
+It attempts to be crash safe, snapshotting, and corruption-detecting,
+without giving up too much performance.
+.PP
+The options are:
+.TP
+.B -A
+Disable auth. Permissions are still checked, but anyone will be able
+to attach as any user.
+.TP
+.BI "-f " file
+Use
+.I file
+as the disk.
+.TP
+.BI "-m " mem
+Allocate
+.I mem
+megabytes to use for cache.
+.TP
+.BI "-n " name
+Use
+.I name
+as the name of the service.
+If unspecified, the default service name is
+.IR gefs .
+.TP
+.BI "-a " ann
+Announce and listen on the specified network address.
+.TP
+.BI "-r " user
+Ream the file system, erasing all of the old data.
+Create a user named
+.I user
+in the
+.I adm
+group.
+After reaming,
+.I gefs
+will exit.
+.TP
+.B -S
+Ignore permissions. Without god, all things are permitted.
+.TP
+.B -s
+Read and write protocol messages on standard file descriptors zero and one.
+.PD
+.SH "SEE ALSO"
+.IR cwfs (4),
+.IR hjfs (4),
+.IR gefs (8),
+.IR prep (8),
+.IR sd (3)
+.SH BUGS
+Yes
--- /dev/null
+++ b/gefs.8.man
@@ -1,0 +1,72 @@
+.TH GEFS 8
+.SH NAME
+gefs \- file server maintenance
+.SH SYNOPSIS
+.PD 0
+.PP
+.B check
+.PP
+.B df
+.PP
+.B halt
+.PP
+.B help
+.PP
+.B perm
+.RB [on |
+.BR off ]
+.PP
+.B snap
+.I -d old | old new
+.PP
+.B sync
+.PP
+.B users
+.SH DESCRIPTION
+The following commands should be written to the console of an
+.IR gefs (4)
+file server.
+.PP
+.I Check
+applies basic consistency checks to the file system.
+.PP
+.I Df
+prints the amount of used space and total space in megabytes,
+as well as the percentage of space occupied.
+.PP
+.I Halt
+syncs all IO to disk and makes the file system read only.
+.PP
+.I Help
+prints a summary of the available commands.
+This table includes additional debug commands that are
+subject to change, and are intentionally undocumented.
+.PP
+.I Perm
+[
+.B on
+|
+.B off
+]
+flips on permission checking.
+This may be useful during file system initialization.
+.PP
+.B Snap
+[
+.I -d old
+|
+.I old new
+]
+manages snapshots. When given the
+.I -d
+flag, it deletes an old snapshot.
+When given 2 arguments, it takes a snapshot of
+.I old
+and gives it the name
+.IR new .
+.PP
+.I Sync
+writes dirty blocks in memory to the disk.
+.SH SEE ALSO
+.IR gefs (4)
+
--- a/mkfile
+++ b/mkfile
@@ -1,5 +1,4 @@
</$objtype/mkfile
-</sys/doc/fonts
TARG=gefs
BIN=/$objtype/bin
@@ -34,3 +33,7 @@
{ echo $FONTS; cat $stem.ms } | pic | tbl | eqn | troff -ms | lp -dstdout > $target%.pdf: %.ps
ps2pdf $stem.ps $stem.pdf
+
+man.install: gefs.4.man gefs.8.man
+ cp gefs.4.man /sys/man/4/gefs
+ cp gefs.8.man /sys/man/8/gefs