games/mix: implement Knuth's specification for comments

[plan9front.git] / sys / man / 4 / cwfs

diff --git a/sys/man/4/cwfs b/sys/man/4/cwfs
index 6bf6c7b27ec985b3084be30dee1e3f0a630d0730..7d0c69cfa0e52500d6a839ea390e2f2a95aa0315 100644 (file)
--- a/sys/man/4/cwfs
+++ b/sys/man/4/cwfs
@@ -1,18 +1,26 @@
 .TH CWFS 4
 .SH NAME
-cwfs \- cached-worm file server, dump
+cwfs, \
+cwfs64, \
+cwfs64x, \
+fs64 - cached-worm file server, dump
 .SH SYNOPSIS
 .B cwfs
 [
-.B -cf
+.B -csC
+] [
+.B -n
+.I service
 ] [
 .B -a
 .I announce-string
 ] ... [
 .B -m
 .I device-map
-]
+] [
+.B -f
 .I config-device
+]
 .SH DESCRIPTION
 .I Cwfs
 is a cached-worm file server that runs
@@ -46,11 +54,21 @@ in order to be compatible with some existing file systems, notably
 These parameters can be changed by recompilation.
 .PP
 .I Cwfs
-expects to find the configuration block on
-.IR config-device .
+places its server 9P connection in
+.BI /srv/ name\f1
+and its command pipe in
+.BI /srv/ name\f1 .cmd,
+where
+.I name
+is the service name.
 .PP
 Options are:
-.TF -m
+.TP
+.B -f
+specify
+.IR config-device
+other than the default
+.LR /dev/sdC0/cwfs .
 .TP
 .B -a
 announce on
@@ -58,7 +76,7 @@ announce on
 instead of
 .LR tcp!*!9fs .
 .TP
-.B -c
+.B -C
 use a newer, faster, and incompatible cache-device layout.
 To convert an old file system's cache to the new layout,
 dump the file system, note the last superblock number,
@@ -67,18 +85,28 @@ halt
 restart
 .I cwfs
 with
-.BR -cf ,
+.BR -cC ,
 .I recover
 the file system, and start
 .I cwfs
 with
-.B -c
+.B -C
 thereafter.
 .TP
-.B -f
+.B -c
 enter the file server's configuration mode
 before starting normal operation.
 .TP
+.B -n
+overrides the 
+.I service
+name of the file server's configuration.
+.TP
+.B -s
+Post file descriptor zero in
+.BI /srv/ service
+and read and write protocol messages on file descriptor one.
+.TP
 .B -m
 the file
 .I device-map
@@ -152,8 +180,7 @@ on a combination of disks and
 write-once-read-many (WORM) magneto-optical disks.
 .TP
 .B other
-is a simple disk-based file system similar to
-.IR kfs (4) .
+is a simple disk-based file system not backed by worm.
 .TP
 .B main
 is a worm-based file system with a disk-based
@@ -209,7 +236,7 @@ of March 1, 1992
 will be named
 .B /1992/0301/
 in the dump file system.
-.SS "Changes from fs(4)"
+.SS "Changes from fs"
 .IR fs (4)'s
 IP configuration is ignored and the underlying system's is used.
 .PP
@@ -224,6 +251,18 @@ and
 (see
 .IR auth/wrkey ).
 .PP
+Files can be used directly as wren devices by giving
+a file name rooted at
+.I /
+or using double or single quotes. Such a file name
+can be appended to the
+.L w
+device instead of specifying
+.L target
+and
+.L lun
+numbers.
+.PP
 .IR fs (4)'s
 device names
 .L h
@@ -263,6 +302,15 @@ number and byte order; if either is wrong, it will issue a warning.
 If the label cannot be read,
 .I cwfs
 will attempt to write a new label.
+.PP
+The original file server reserved the rest of the machines RAM for
+io buffers. Where
+.I cwfs
+running under the Plan 9 kernel reserves a settable percentage
+of the remaining user pages. The percentage is read from the
+environment variable
+.B fsmempercent
+which when not set is assumed to be 25% (default).
 .SH EXAMPLES
 Place the root of the
 .B dump
@@ -288,7 +336,6 @@ ls -lp /n/dump/1992/02??/mips/bin/vc | uniq
 .IR yesterday (1),
 .IR fs (3),
 .IR sd (3),
-.IR fossil (4),
 .IR fs (4),
 .IR srv (4),
 .IR fs (8),
@@ -310,8 +357,3 @@ deciding which to serve by sniffing the first packet on each connection.
 .PP
 File system block size and disk address size (32- or 64-bit) are fixed
 at compilation time, and this is not easily changed.
-.PP
-.I Cwfs
-is probably not the right choice of file server for new file systems.
-It's intended to cope with existing file systems on optical jukeboxes
-or images thereof.