Fix my own errors in aquarela(8). Fix reference to 9fs with reference to srv(4), so the link works in html representation. Fix reference to Unix nmbd(8) so programs don't make a manual reference out of it. Updated DESCRIPTION to reflect better understanding. Aquarela won't (that I see) check first if /n/share is already a mtpt, but instead just tries `9fs share'. Completed list of UDP ports used under -n. Alphabetize options table instead of sort by relevance. Fix double-quoting of `foreign' words to single quotes. Surveyed existing manual pages and this seems more common. Same for UNIX into Unix. Reference: /n/sources/patch/applied/man-8-aquarela-ref Date: Thu Jan 31 12:50:41 CET 2008 Signed-off-by: josh@utopian.net --- /sys/man/8/aquarela Thu Jan 31 12:50:31 2008 +++ /sys/man/8/aquarela Thu Jan 31 12:50:28 2008 @@ -28,11 +28,12 @@ access to Plan 9 file servers. It announces and subsequently listens on .B tcp!*!445 -for connections to the individual file hierarchies called ``shares'' by +for connections to the file hierarchies called `shares' by .SM CIFS\c . -Users are authenticated with their Inferno/\c -.SM POP -password. +Users are authenticated with their +.SM APOP +secret (see +.IR auth (8)). Each session is managed by a process running as the authenticated user. Two persistent processes handle listening, session setup, and housekeeping. .PP @@ -45,23 +46,46 @@ .BR share , causes .I aquarela -to serve -.B /n/share. -If that path is not already a mountpoint, a -.IR 9fs (4) +to attempt a +.I 9fs +(in +.IR srv (4)) connection to the file server -.B share -is attempted. +.BR share . If connection succeeds, a file hierarchy rooted at .B /n/share -is finally presented to the client. +is presented to the client. The client request fails otherwise. Requests for the protocol equivalent of .B / -are satisfied with a one-level directory containing only the default share, -.BR local. +are satisfied with a directory containing only the default share, +.BR local . .PP The options are: +.TF -w workgroup +.TP +.B -n +Enable limited +.SM NETBIOS +service. +.I Aquarela +will register with the `master browser' for +.I workgroup +and listen on +.B tcp!*!139 +and +.B udp!*!13[7-9] +for +.SM NETBIOS +name resolution and session requests. +This works in tandem with a complete +.SM NETBIOS +master name server, like that provided by Unix +\fInmbd\fR(8). +.SM NETBIOS +is not required for +.SM CIFS +file service. .TP .BI -u " N Send Unicode. @@ -83,51 +107,28 @@ .BI -w " workgroup Set .I workgroup -(or ``primary domain'') of server. +(or `primary domain') of server. Default .BR PLAN9 . -.TP -.B -n -Enable limited -.SM NETBIOS -service. -.I Aquarela -will register with the ``master browser'' for -.I workgroup -and listen on -.B tcp!*!139 -for name resolution queries. -This works only in tandem with a complete -.SM NETBIOS -master name server, like that provided by -.SM UNIX -.IR nmbd (8). -.SM NETBIOS -is not required for -.SM CIFS -file service. .PD .SH EXAMPLE -To start a +To start .SM CIFS -server on system -.B plan9 -as a member of -.BR WORKGROUP : +service on system +.BR plan9 : .IP .EX -aquarela -u 1 -w WORKGROUP & +% aquarela -u 1 & .EE .PP -To make -.BR plan9 's +To then make the .B dump filesystem available as drive .B Y: on a Windows machine: .IP .EX -net use Y: \\\\plan9.example.com\\dump +C:\\>net use Y: \\\\plan9.example.com\\dump .EE .SH FILES .TP @@ -137,12 +138,13 @@ share .TP .B /sys/log/aquarela -Log file, if it exists +Log file .PD .SH SOURCE .B /sys/src/cmd/aquarela .SH SEE ALSO -.IR 9fs (4), +.IR auth (8), +.IR srv (4), .IR UTF (6) .SH DIAGNOSTICS Log messages are appended to @@ -212,15 +214,14 @@ .I any-smb-name. .TP .BI 0x nn -Debug only messages with this hexadecimal id. +Debug only messages with hexadecimal id +.BI 0x nn. .PD .SH BUGS -The first login attempt from a given Windows login session often fails erroneously - try again. -The server disk space reported by some clients is inaccurate. +The first connection attempt to a share sometimes fails erroneously - try again. +The share disk space reported by some clients is inaccurate. Some clients can't rename directories. Write attempts without sufficient permissions fail (correctly), but appear on client to temporarily succeed. -.PP -The multitude of diagnostics both in the program and in this manual page reflect the in-progress nature of the code. .PP This program should probably be named .IR cifsserver .