diff options
Diffstat (limited to 'man/2')
| -rw-r--r-- | man/2/drawmux | 2 | ||||
| -rw-r--r-- | man/2/registries | 6 | ||||
| -rw-r--r-- | man/2/secstore | 33 | ||||
| -rw-r--r-- | man/2/security-login | 2 | ||||
| -rw-r--r-- | man/2/srv | 2 | ||||
| -rw-r--r-- | man/2/styx | 13 | ||||
| -rw-r--r-- | man/2/styxconv | 13 | ||||
| -rw-r--r-- | man/2/styxflush | 10 | ||||
| -rw-r--r-- | man/2/styxpersist | 12 | ||||
| -rw-r--r-- | man/2/styxservers | 16 | ||||
| -rw-r--r-- | man/2/sys-0intro | 4 | ||||
| -rw-r--r-- | man/2/sys-bind | 2 | ||||
| -rw-r--r-- | man/2/sys-export | 4 | ||||
| -rw-r--r-- | man/2/sys-fauth | 2 | ||||
| -rw-r--r-- | man/2/sys-file2chan | 2 | ||||
| -rw-r--r-- | man/2/sys-fversion | 6 | ||||
| -rw-r--r-- | man/2/sys-iounit | 2 | ||||
| -rw-r--r-- | man/2/sys-pipe | 4 | ||||
| -rw-r--r-- | man/2/virgil | 2 |
19 files changed, 70 insertions, 67 deletions
diff --git a/man/2/drawmux b/man/2/drawmux index 0da1b9e3..3c3989db 100644 --- a/man/2/drawmux +++ b/man/2/drawmux @@ -52,7 +52,7 @@ and the log (base 2) of the number of bits per pixel for windows created on that The remote viewer must then use .B Sys->export (see -.IR sys-dial (2)) +.IR sys-export (2)) to export its .BR /dev/draw , which diff --git a/man/2/registries b/man/2/registries index 526e1c13..f390b1ab 100644 --- a/man/2/registries +++ b/man/2/registries @@ -108,7 +108,7 @@ It has the following members and operations: .TP .B addr A string that represents where the service can be reached: it is often a -.IR sys-dial (2) +.IR dial (2) address string, but might be a name in the name space; the interpretation is internal to .BR Registries . .TP @@ -148,7 +148,7 @@ It provides the following members: .TP .B fd A file descriptor that can be read and written to exchange data with the service. -The meaning of the data depends on the service (eg, it might be a Styx connection +The meaning of the data depends on the service (eg, it might be a 9P connection or a SOAP implementation). Typically an attribute of the service description hints at the protocol. .TP @@ -222,7 +222,7 @@ Connect to the registry at the location determined by the service description if .I svc is nil, the default is to try -.IR sys-dial (2) +.IR dial (2) to .BR net!$registry!registry , the symbolic name of the default registry for the current host. diff --git a/man/2/secstore b/man/2/secstore index 2a14b67a..d6395955 100644 --- a/man/2/secstore +++ b/man/2/secstore @@ -3,6 +3,7 @@ secstore \- fetch data from Plan 9's secure storage service .SH SYNOPSIS .EX +include "dial.m"; include "secstore.m"; secstore := load Secstore Secstore->PATH; @@ -12,19 +13,19 @@ init: fn(); privacy: fn(): int; cansecstore: fn(addr: string, user: string): int; mkseckey: fn(pass: string): array of byte; -dial: fn(addr: string): ref Sys->Connection; -auth: fn(conn: ref Sys->Connection, user: string, seckey: array of byte): +dial: fn(addr: string): ref Dial->Connection; +auth: fn(conn: ref Dial->Connection, user: string, seckey: array of byte): (string, string); connect: fn(addr: string, user: string, seckey: array of byte): - (ref Sys->Connection, string, string); -sendpin: fn(conn: ref Sys->Connection, pin: string): int; -files: fn(conn: ref Sys->Connection): + (ref Dial->Connection, string, string); +sendpin: fn(conn: ref Dial->Connection, pin: string): int; +files: fn(conn: ref Dial->Connection): list of (string, int, string, string, array of byte); -getfile: fn(conn: ref Sys->Connection, name: string, +getfile: fn(conn: ref Dial->Connection, name: string, maxsize: int): array of byte; -.\"putfile: fn(conn: ref Sys->Connection, name: string, data: array of byte,): int; -remove: fn(conn: ref Sys->Connection, file: string): int; -bye: fn(conn: ref Sys->Connection); +.\"putfile: fn(conn: ref Dial->Connection, name: string, data: array of byte,): int; +remove: fn(conn: ref Dial->Connection, file: string): int; +bye: fn(conn: ref Dial->Connection); mkfilekey: fn(pass: string): array of byte; decrypt: fn(data: array of byte, filekey: array of byte): array of byte; @@ -43,16 +44,16 @@ that can then be used to fetch and decrypt data files, such as the file containing the initial keys for an instance of .IR factotum (4). The module's functions hold the file descriptors for the connection in a -.BR Sys->Connection +.BR Dial->Connection value, as returned by -.IR sys-dial (2). +.IR dial (2). The .I addr parameter that gives the network address of the .I secstore service is also as defined in -.IR sys-dial (2). +.IR dial (2). A nil value defaults to .BR "net!$auth!secstore" , for translation in the usual way by @@ -94,9 +95,9 @@ dials the at network address .I addr (as defined by -.IR sys-dial (2)) -and returns a reference to the resulting -.BR Sys->Connection . +.IR dial (2)) +and returns a reference to the resulting +.BR Dial->Connection . It returns nil on an error and sets the error string. .PP .B Auth @@ -106,7 +107,7 @@ of the service. The parameter .I conn refers to the -.B Sys->Connection +.B Dial->Connection value representing the connection. .I User names a user registered with the service. diff --git a/man/2/security-login b/man/2/security-login index cc831319..43a727e7 100644 --- a/man/2/security-login +++ b/man/2/security-login @@ -44,7 +44,7 @@ CA. .PP .B Login connects, using -.IR sys-dial (2), +.IR dial (2), to the signer at network address .IR addr , which is any form accepted by @@ -34,7 +34,7 @@ and .IR dns (6) if available. Other Inferno applications normally give network addresses to the functions of -.IR sys-dial (2), +.IR dial (2), and they are then translated automatically, using the services of .IR cs (8). .PP @@ -1,6 +1,6 @@ .TH STYX 2 .SH NAME -Styx: Rmsg, Tmsg, dir2text, istmsg, packdir, packdirsize, readmsg, qid2text, unpackdir \- interface to Styx file protocol +Styx: Rmsg, Tmsg, dir2text, istmsg, packdir, packdirsize, readmsg, qid2text, unpackdir \- interface to 9P (Styx) file protocol .SH SYNOPSIS .EX include "styx.m"; @@ -118,13 +118,14 @@ MAXRPC: con \fIimplementation-defined\f5; .EE .SH DESCRIPTION .B Styx -provides a Limbo interface to send and receive messages of the Styx file service protocol, -described by Section 5 of this manual (a thorough reading of which -is advised before using this module). +provides a Limbo interface to send and receive messages of the 9P file service protocol, +described by Section 5 of this manual, a thorough reading of which +is advised before using this module. +(The protocol was previously called `Styx' in Inferno, hence the module's name.) .B Init must be called before using any other function in the module. .PP -A Styx client transmits requests to a server as `T-messages' +A 9P client transmits requests to a server as `T-messages' and receives replies in matching `R-messages'. A T-message is here represented by values of the type .BR Tmsg , @@ -232,7 +233,7 @@ Return a printable string showing the contents of for tracing or debugging. .TP .IB t .mtype() -Return the Styx message type of the message. +Return the 9P message type of the message. .PP An R-message is represented by .BR Rmsg . diff --git a/man/2/styxconv b/man/2/styxconv index 9180ad96..296c6abb 100644 --- a/man/2/styxconv +++ b/man/2/styxconv @@ -1,6 +1,6 @@ .TH STYXCONV 2 .SH NAME -styxconv \- convert between old and new Styx +styxconv \- convert between old 1995 Styx and current Styx (9P) .SH SYNOPSIS .EX include "styxconv.m"; @@ -12,9 +12,10 @@ styxconv: fn(client: ref Sys->FD, server: ref Sys->FD); .EE .SH DESCRIPTION .B Styxconv -converts between the previous version of the Styx protocol, +converts between the obsolete 1995 version of the Styx protocol, as used for instance in Inferno's Third Edition and earlier, -and the current version of the protocol, +and the current file service protocol, +previously also called `Styx' but based on 9P2000 and defined by .IR intro (5). .PP @@ -25,10 +26,10 @@ The function .B styxconv takes two file descriptors: .I client -should be a connection to a styx client requiring +should be a connection to a client requiring one version of the protocol; .I server -should be a connection to a styx server serving +should be a connection to a server serving the other version of the protocol. There are two conversion modules: .B PATHNEW2OLD @@ -74,4 +75,4 @@ cvstyx(fd: ref Sys->FD): ref Sys->FD .IR sys-pipe (2), .IR intro (5) .SH BUGS -There is no provision for 9p2000 authentication. +There is no provision for 9P2000 authentication. diff --git a/man/2/styxflush b/man/2/styxflush index b03c5883..845e8973 100644 --- a/man/2/styxflush +++ b/man/2/styxflush @@ -1,6 +1,6 @@ .TH STYXFLUSH 2 .SH NAME -styxflush \- handler for styx flush protocol +styxflush \- handler for 9P (Styx) flush protocol .SH SYNOPSIS .EX include "sys.m"; @@ -16,17 +16,17 @@ rmsg: fn(m: ref Styx->Rmsg): int; Einterrupted: con "interrupted"; .EE .SH DESCRIPTION -Getting the semantics of the Styx +Getting the semantics of the 9P .IR flush (5) protocol correct when handling requests concurrently is surprisingly hard to do. .I Styxflush -is designed to help get it right. It deals with Styx -messages for a single styx session \- if a server needs to +is designed to help get it right. It deals with 9P +messages for a single 9P session \- if a server needs to deal with multiple sessions, then multiple instances of .I styxflush should be loaded. It assumes there is a loop in a central process -which both reads T-messages and sends their R-message replies. +that both reads T-messages and sends their R-message replies. .I Styxflush handles the flushing of requests that are being run outside the central process. diff --git a/man/2/styxpersist b/man/2/styxpersist index 60f370bf..817a96fe 100644 --- a/man/2/styxpersist +++ b/man/2/styxpersist @@ -1,20 +1,20 @@ .TH STYXPERSIST 2 .SH NAME -styxpersist \- persistent Styx connection +styxpersist \- persistent 9P (Styx) connection .SH SYNOPSIS .EX include "sys.m"; include "styxpersist.m"; styxpersist := load Styxpersist Styxpersist->PATH; -init: fn(clientfd: ref Sys->FD, usefac: int, keyspec: string) - : (chan of chan of ref Sys->FD, string); +init: fn(clientfd: ref Sys->FD, usefac: int, keyspec: string): + (chan of chan of ref Sys->FD, string); .EE .SH DESCRIPTION .I Styxpersist -tries to maintain a persistent Styx connection for its client. +tries to maintain a persistent 9P (Styx) connection for its client. .B Init -starts a process to serve Styx for the client on +starts a process to serve 9P for the client on .IR clientfd . If .I usefac @@ -77,4 +77,4 @@ Plan 9 style. If a client uses an external factotum with different keys, may be unable to re-authenticate. .SH "SEE ALSO" .IR mount (1), -.IR sys-dial (2) +.IR dial (2) diff --git a/man/2/styxservers b/man/2/styxservers index 3ba77131..5e4d0334 100644 --- a/man/2/styxservers +++ b/man/2/styxservers @@ -1,7 +1,7 @@ .TH STYXSERVERS 2 .SH NAME styxservers \- -Styx server implementation assistance +9P (Styx) server implementation assistance .SH SYNOPSIS .EX include "sys.m"; @@ -14,7 +14,7 @@ Styxserver, Fid, Navigator: import styxservers; Styxserver: adt { fd: ref Sys->FD; # file server end of connection t: ref Navigator; # name space navigator for this server - msize: int; # negotiated Styx message size + msize: int; # negotiated 9P message size new: fn(fd: ref Sys->FD, t: ref Navigator, rootpath: big) :(chan of ref Tmsg, ref Styxserver); @@ -103,7 +103,7 @@ openok: fn(uname: string, omode, openmode: fn(o: int): int; .EE .SH DESCRIPTION -When writing a Styx file server, there are some +When writing a file server, there are some commonly performed tasks that are fiddly or tedious to implement each time. .B Styxservers @@ -119,7 +119,7 @@ left to the file server program itself. Familiarity with Section 5 of the manual which defines the protocol (see .IR intro (5)), -and with the representation of Styx messages in Limbo +and with the representation of 9P messages in Limbo (see .IR styx (2)), is a prerequisite for use of this module. @@ -322,7 +322,7 @@ reference which can be used to access that navigator; and the file descriptor .IB srv .fd -that is the file server's end of the connection to the Styx client. +that is the file server's end of the connection to the 9P client. Both values are initially provided by the file serving application, but can be accessed through the .B Styxserver @@ -345,7 +345,7 @@ It returns a tuple, say .RI ( c ", " srv ), and spawns a new process, which uses .IR styx (2) -to read and parse Styx messages read +to read and parse 9P messages read from .IR fd , and send them down @@ -892,14 +892,14 @@ with OTRUNC and ORCLOSE flags removed. If .I on is true (non-zero), -will trace Styx requests and replies, on standard error. +will trace 9P requests and replies, on standard error. This option must be set before creating a .BR Styxserver , to ensure that it preserves its standard error descriptor. .SS Constants .B Styxservers defines a number of constants applicable to the writing -of Styx servers, including: +of 9P servers, including: .TP .BR Einuse\fP,\fP\ Ebadfid\fP,\fP\ Eopen\fP,\fP\ Enotfound\fP,\fP\ Enotdir\fP,\fP\ Eperm\fP,\fP\ Ebadarg\fP,\fP\ Eexists These provide standard strings for commonly used error conditions, diff --git a/man/2/sys-0intro b/man/2/sys-0intro index a9d912e9..fd132e58 100644 --- a/man/2/sys-0intro +++ b/man/2/sys-0intro @@ -210,8 +210,8 @@ will be honoured for a file depends entirely on the underlying file server Record locking in the underlying file system is not supported by Inferno. Processes can coordinate their file operations by other mechanisms. .PP -Atomicity is guaranteed for byte counts smaller than the -.I Styx +Atomicity is guaranteed for byte counts no larger than the +.I 9P message size; see .IR read (5). diff --git a/man/2/sys-bind b/man/2/sys-bind index b03379c0..bfec4b2c 100644 --- a/man/2/sys-bind +++ b/man/2/sys-bind @@ -54,7 +54,7 @@ The argument to .B mount is a file descriptor of an open pipe or network connection -to a file server ready to receive Styx messages. +to a file server ready to receive 9P messages. The .I old file must be a directory. diff --git a/man/2/sys-export b/man/2/sys-export index dc2bff50..3872d5dc 100644 --- a/man/2/sys-export +++ b/man/2/sys-export @@ -11,7 +11,7 @@ export: fn(fd: ref FD, dir: string, flag: int): int; .SH DESCRIPTION .B Export receives and replies -to Styx requests from a client on a connection represented by +to 9P requests from a client on a connection represented by .IR fd , for file operations on the part of the current file name space rooted at @@ -40,7 +40,7 @@ of a returned by .B listen (see -.IR sys-dial (2)). +.IR dial (2)). Before calling .BR export , the connection on diff --git a/man/2/sys-fauth b/man/2/sys-fauth index 8e06d6ac..15ec8c44 100644 --- a/man/2/sys-fauth +++ b/man/2/sys-fauth @@ -11,7 +11,7 @@ fauth: fn(fd: ref FD, aname: string): ref FD; .SH DESCRIPTION .B Fauth provides a means for the current user to authenticate to access -resources available through the Styx connection represented by +resources available through the 9P connection represented by .IR fd . The return value is a file descriptor, conventionally called .IR afd , diff --git a/man/2/sys-file2chan b/man/2/sys-file2chan index 33ff29bd..a3f18275 100644 --- a/man/2/sys-file2chan +++ b/man/2/sys-file2chan @@ -49,7 +49,7 @@ the contents of the .B Tread and .B Twrite -Styx messages received by the system on the server's behalf; see +9P messages received by the system on the server's behalf; see .IR intro (5). .PP When the client invokes the diff --git a/man/2/sys-fversion b/man/2/sys-fversion index 200a4f04..94a43139 100644 --- a/man/2/sys-fversion +++ b/man/2/sys-fversion @@ -1,6 +1,6 @@ .TH SYS-FVERSION 2 .SH NAME -fversion \- initialize Styx connection and negotiate version +fversion \- initialize 9P connection and negotiate version .SH SYNOPSIS .EX include "sys.m"; @@ -10,13 +10,13 @@ fversion: fn(fd: ref FD, bufsize: int, version: string): (int, string); .EE .SH DESCRIPTION .B Fversion -initialises the Styx connection represented by +initialises the 9P connection represented by .I fd and negotiates the maximum message size and the version of the protocol to be used. .PP The .I bufsize -determines the size of the I/O buffer used to stage Styx requests to the server, +determines the size of the I/O buffer used to stage 9P requests to the server, subject to the constraints of the server itself. The .I version diff --git a/man/2/sys-iounit b/man/2/sys-iounit index 0f8ef118..b4727411 100644 --- a/man/2/sys-iounit +++ b/man/2/sys-iounit @@ -9,7 +9,7 @@ sys := load Sys Sys->PATH; iounit: fn(fd: ref FD): int; .EE .SH DESCRIPTION -Reads and writes of files are transmitted using the Styx protocol (see +Reads and writes of files are transmitted using the 9P protocol (see .IR intro (5)) and in general, operations involving large amounts of data must be broken into smaller pieces by the operating system. diff --git a/man/2/sys-pipe b/man/2/sys-pipe index 6fb3a25e..bc43e060 100644 --- a/man/2/sys-pipe +++ b/man/2/sys-pipe @@ -33,12 +33,12 @@ communication by cooperating processes. Pipes are still useful, however, to connect applications that do not (or cannot) share such channels, or when a system interface requires a file descriptor. -For instance, a process that serves the Styx protocol can +For instance, a process that serves the 9P protocol can pass the file descriptor for one end of a pipe to .B Sys->mount (see .IR sys-bind (2)), -and read and write Styx messages on the other end of the pipe. +and read and write 9P messages on the other end of the pipe. .SH DIAGNOSTICS Returns 0 on success; -1 on failure. .SH "SEE ALSO" diff --git a/man/2/virgil b/man/2/virgil index 5a7cd347..778ce7b1 100644 --- a/man/2/virgil +++ b/man/2/virgil @@ -39,7 +39,7 @@ It accepts and returns the first answer it receives. .SH SOURCE .B /appl/lib/virgil.b .SH SEE ALSO -.IR sys-dial (2), +.IR dial (2), .IR cs (8), .IR register (8), .IR virgild (8) |