created mirror

Documentation/Networking/ZTP-usage.txt

@@ -0,0 +1,70 @@
+Brief usage instructions for the current ZTP implementation
+-----------------------------------------------------------
+
+You need the "ztp" module for both server and client operation.
+
+If your system has a BSD-style syslog service, compile with ARCH=syslog.
+The Makefile is set up to work with Debian-packaged Kaffe, so if you
+use some other JRE, you need to edit Java/arch/syslog/arch.mk.
+
+
+The server
+----------
+
+To start up the server:
+  LD_LIBRARY_PATH=arch/syslog kaffe org.gzigzag.Main -ztpserv 5555 cellscrollfile1
+Here 5555 is the port to bind to.
+
+The only way to stop the server currently is killing it (Ctrl-C or
+SIGTERM signal).
+
+The server does not set up the GZZ-client's system list, so if you
+want to view the space generated by the server, you will have to -new
+it.  The ZTP cells are on the rank along d.ztpserver starting from the
+home cell.  ZTP dimensions and cells have a prefix "ztpserver!".
+
+
+The client
+----------
+
+Create a cell with the content "ZTPclient.PUT".  This will be the
+action to invoke when you want to put data into the server.
+
+Create an association list as follows:
+
+    ---> d.1
+   |         serverFQDN   --- server.example   (server machine FQDN)
+   v            |
+  d.2        serverPort   --- 5555             (server port)
+                |
+             userName     --- adm              (username; currently only adm works)
+                |
+             subspaceName --- ALL              (only ALL currently)
+                |
+             subspace     ----                 (a cell)
+
+Connect the subspace you want to put to the "subspace" cell along
+"d.ztp-subspace".  The subspace is currently defined to be the closure
+of the cell connected to the "subspace" cell along "d.ztp-subspace" in
+positive direction with respect to all available dimensions (from
+d.masterdim) except "d.ztp-subspace" and "d.cellcreation".
+
+Before you can do anything, you need to give your space an ID.  Create
+a cell with the content "SETSPACEID" and another cell with the space
+ID you want as the content.  Have your control cursor on the
+SETSPACEID cell and your data cursor on the space ID cell.  Then
+invoke the action (press ENTER).
+
+Note that the space ID should be unique among all spaces.
+
+To put the subspace to the server, have your control cursor on the
+"STPclient.PUT" action cell mentioned above and your data cursor on
+the first item of the alist ("serverFQDN").  Then invoke the action
+(press ENTER).
+
+To get a subspace from the server, have your control cursor on a cell
+that reads "STPclient.GET" (create one if necessary) and your data
+cursor on the first item of the alist ("serverFQDN").  Then invoke the
+action (press ENTER).
+
+