diff options
Diffstat (limited to 'docs/TCF Service - File System.html')
| -rw-r--r-- | docs/TCF Service - File System.html | 106 |
1 files changed, 53 insertions, 53 deletions
diff --git a/docs/TCF Service - File System.html b/docs/TCF Service - File System.html index 711b31fe4..dd10042bb 100644 --- a/docs/TCF Service - File System.html +++ b/docs/TCF Service - File System.html @@ -135,7 +135,7 @@ using a slash ('/') as the separator, and that will work as expected.</p> <pre><b><font face="Courier New" size=2 color=#333399> <i><file attributes></i> - <font face=Wingdings>Ø</font> <i><object></i> + ⇒ <i><object></i> </font></b></pre> <p>All attributes are optional. @@ -212,7 +212,7 @@ defined by future versions of this protocol):</p> <h3><a name='CmdOpen'>open</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • open • <i><string: file name></i> • <i><int: mode></i> • <i><file attributes></i> • +C • <i><token></i> • FileSystem • open • <i><string: file name></i> • <i><int: mode></i> • <i><file attributes></i> • </font></b></pre> <p>The command opens or creates a file on a remote system. If mode contains O_CREAT then new file is created, otherwise exsting @@ -222,11 +222,11 @@ the command parameters, a default value is used.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><file handle></i> • +R • <i><token></i> • <i><error report></i> • <i><file handle></i> • <i><file handle></i> - <font face=Wingdings>Ø</font> null - <font face=Wingdings>Ø</font> <i><string></i> + ⇒ null + ⇒ <i><string></i> </font></b></pre> <p>On success, the replay contains open file handle. The handle is encoded as a string of characters. Client should never try @@ -236,7 +236,7 @@ not needed any more. Server should close all files that were left open after cli <h3><a name='CmdClose'>close</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • close • <i><string: file handle></i> • +C • <i><token></i> • FileSystem • close • <i><string: file handle></i> • </font></b></pre> <p>The command closes a handle, which was open by 'open' or 'opendir' commands.</p> @@ -244,13 +244,13 @@ C • <i><token></i> • FileSystem • close • <i><string: file handle></ <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <h3><a name='CmdRead'>read</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • read • <i><string: file handle></i> • <i><int: offset></i> • <i><int: size></i> • +C • <i><token></i> • FileSystem • read • <i><string: file handle></i> • <i><int: offset></i> • <i><int: size></i> • </font></b></pre> <p>The command reads bytes from an open file. @@ -266,7 +266,7 @@ or error. For e.g. device files this may return fewer bytes than requested.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><string: data></i> • <i><error report></i> • <i><boolean: eof></i> • +R • <i><token></i> • <i><string: data></i> • <i><error report></i> • <i><boolean: eof></i> • </font></b></pre> <p><i><string: data></i> is Base64 encoded byte array of file data. Number of bytes is determined by the string length. @@ -275,7 +275,7 @@ R • <i><token></i> • <i><string: data></i> • <i><error report> <h3><a name='CmdWrite'>write</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • write • <i><string: file handle></i> • <i><int: offset></i> • <i><string: data></i> • +C • <i><token></i> • FileSystem • write • <i><string: file handle></i> • <i><int: offset></i> • <i><string: data></i> • </font></b></pre> <p>The command writes bytes into an open file. @@ -287,13 +287,13 @@ and then the data. <i><string: data></i> is Base64 encoded array of data b <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <h3><a name='CmdStat'>stat</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • stat • <i><string: file name></i> • +C • <i><token></i> • FileSystem • stat • <i><string: file name></i> • </font></b></pre> <p>The command retrieves file attributes.</p> @@ -301,13 +301,13 @@ C • <i><token></i> • FileSystem • stat • <i><string: file name></i> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><file attributes></i> • +R • <i><token></i> • <i><error report></i> • <i><file attributes></i> • </font></b></pre> <h3><a name='CmdLStat'>lstat</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • lstat • <i><string: file name></i> • +C • <i><token></i> • FileSystem • lstat • <i><string: file name></i> • </font></b></pre> <p>The command retrieves file attributes. @@ -316,13 +316,13 @@ Unlike 'stat', 'lstat' does not follow symbolic links.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><file attributes></i> • +R • <i><token></i> • <i><error report></i> • <i><file attributes></i> • </font></b></pre> <h3><a name='CmdFStat'>fstat</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • fstat • <i><string: file handle></i> • +C • <i><token></i> • FileSystem • fstat • <i><string: file handle></i> • </font></b></pre> <p>The command retrieves file attributes for an open file (identified by the file handle).</p> @@ -330,13 +330,13 @@ C • <i><token></i> • FileSystem • fstat • <i><string: file handle></ <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><file attributes></i> • +R • <i><token></i> • <i><error report></i> • <i><file attributes></i> • </font></b></pre> <h3><a name='CmdSetStat'>setstat</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • setstat • <i><string: file name></i> • <i><file attributes></i> • +C • <i><token></i> • FileSystem • setstat • <i><string: file name></i> • <i><file attributes></i> • </font></b></pre> <p>The command sets file attributes. @@ -349,13 +349,13 @@ specified attributes.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <h3><a name='CmdFSetStat'>fsetstat</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • fsetstat • <i><string: file handle></i> • <i><file attributes></i> • +C • <i><token></i> • FileSystem • fsetstat • <i><string: file handle></i> • <i><file attributes></i> • </font></b></pre> <p>The command sets file attributes for an open file (identified by the file handle). @@ -365,13 +365,13 @@ permissions or access times, as well as for truncating a file.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <h3><a name='CmdOpenDir'>opendir</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • opendir • <i><string: path></i> • +C • <i><token></i> • FileSystem • opendir • <i><string: path></i> • </font></b></pre> <p>The command opens a directory for reading. @@ -384,13 +384,13 @@ should be closed regardless of whether a read errors have occurred or not.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><file handle></i> • +R • <i><token></i> • <i><error report></i> • <i><file handle></i> • </font></b></pre> <h3><a name='CmdReadDir'>readdir</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • readdir • <i><string: file handle></i> • +C • <i><token></i> • FileSystem • readdir • <i><string: file handle></i> • </font></b></pre> <p>The command returns one @@ -405,19 +405,19 @@ response.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><array of directory entries></i> • <i><error report></i> • <i><boolean: eof></i> • +R • <i><token></i> • <i><array of directory entries></i> • <i><error report></i> • <i><boolean: eof></i> • <i><array of directory entries></i> - <font face=Wingdings>Ø</font> null - <font face=Wingdings>Ø</font> [ ] - <font face=Wingdings>Ø</font> [ <i><directory entry list></i> ] + ⇒ null + ⇒ [ ] + ⇒ [ <i><directory entry list></i> ] <i><directory entry list></i> - <font face=Wingdings>Ø</font> <i><directory entry></i> - <font face=Wingdings>Ø</font> <i><directory entry list></i> , <i><directory entry></i> + ⇒ <i><directory entry></i> + ⇒ <i><directory entry list></i> , <i><directory entry></i> <i><directory entry></i> - <font face=Wingdings>Ø</font> <i><object></i> + ⇒ <i><object></i> </font></b></pre> <p>Directory entry attributes are:</p> @@ -435,7 +435,7 @@ R • <i><token></i> • <i><array of directory entries></i> • <i><er <h3><a name='CmdMkDir'>mkdir</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • mkdir • <i><string: directory path></i> • <i><file attributes></i> • +C • <i><token></i> • FileSystem • mkdir • <i><string: directory path></i> • <i><file attributes></i> • </font></b></pre> <p>The command creates a directory on the server. @@ -445,13 +445,13 @@ C • <i><token></i> • FileSystem • mkdir • <i><string: directory path> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <h3><a name='CmdRmDir'>rmdir</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • rmdir • <i><string: directory path></i> • +C • <i><token></i> • FileSystem • rmdir • <i><string: directory path></i> • </font></b></pre> <p>The command removes a directory. @@ -463,13 +463,13 @@ directory. <i><string: directory path></i> - specifies the directory to be <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <h3><a name='CmdRoots'>roots</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • roots • +C • <i><token></i> • FileSystem • roots • </font></b></pre> <p>The command retrieves file system roots - top level file system objects. @@ -483,13 +483,13 @@ protocol file names to OS native names and back.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><array of directory entries></i> • +R • <i><token></i> • <i><error report></i> • <i><array of directory entries></i> • </font></b></pre> <h3><a name='CmdRemove'>remove</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • remove • <i><string: path></i> • +C • <i><token></i> • FileSystem • remove • <i><string: path></i> • </font></b></pre> <p>The command removes a file or symbolic link. @@ -498,13 +498,13 @@ This request cannot be used to remove directories.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <h3><a name='CmdRealPath'>realpath</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • realpath • <i><string: path></i> • +C • <i><token></i> • FileSystem • realpath • <i><string: path></i> • </font></b></pre> <p>The command canonicalizes any given path name to an absolute path. @@ -514,13 +514,13 @@ relative pathnames without a leading slash into absolute paths.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><string: path></i> • +R • <i><token></i> • <i><error report></i> • <i><string: path></i> • </font></b></pre> <h3><a name='CmdRename'>rename</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • rename • <i><string: old path></i> • <i><string: new path></i> • +C • <i><token></i> • FileSystem • rename • <i><string: old path></i> • <i><string: new path></i> • </font></b></pre> <p>The command renames a file. @@ -532,13 +532,13 @@ point to different file systems on the server.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <h3><a name='CmdReadLink'>readlink</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • readlink • <i><string: link path></i> • +C • <i><token></i> • FileSystem • readlink • <i><string: link path></i> • </font></b></pre> <p>The command reads the target of a symbolic link. @@ -547,13 +547,13 @@ C • <i><token></i> • FileSystem • readlink • <i><string: link path>< <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • <i><string: path></i> • +R • <i><token></i> • <i><error report></i> • <i><string: path></i> • </font></b></pre> <h3><a name='CmdSymLink'>symlink</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • symlink • <i><string: link path></i> • <i><string: target path></i> • +C • <i><token></i> • FileSystem • symlink • <i><string: link path></i> • <i><string: target path></i> • </font></b></pre> <p>The command creates a symbolic link on the server. @@ -563,14 +563,14 @@ C • <i><token></i> • FileSystem • symlink • <i><string: link path></ <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <h3><a name='CmdCopy'>copy</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • copy • <i><string: source path></i> • <i><string: destination path></i> • - <i><boolean: copy permissions></i> • <i><boolean: copy ownership></i> • +C • <i><token></i> • FileSystem • copy • <i><string: source path></i> • <i><string: destination path></i> • + <i><boolean: copy permissions></i> • <i><boolean: copy ownership></i> • </font></b></pre> <p>The command copies a file on remote system. @@ -582,13 +582,13 @@ If <i><boolean: copy ownership></i> is true then copy source file UID and <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><error report></i> • +R • <i><token></i> • <i><error report></i> • </font></b></pre> <h3><a name='CmdUser'>user</a></h3> <pre><b><font face="Courier New" size=2 color=#333399> -C • <i><token></i> • FileSystem • user • +C • <i><token></i> • FileSystem • user • </font></b></pre> <p>The command retrieves information about user account, which is used by server @@ -597,8 +597,8 @@ to access file system on behalf of the client.</p> <p>Reply:</p> <pre><b><font face="Courier New" size=2 color=#333399> -R • <i><token></i> • <i><int: real UID></i> • <i><int: effective UID></i> • - <i><int: real GID></i> • <i><int: effective GID></i> • <i><string: home directory></i> • +R • <i><token></i> • <i><int: real UID></i> • <i><int: effective UID></i> • + <i><int: real GID></i> • <i><int: effective GID></i> • <i><string: home directory></i> • </font></b></pre> <h2><a name='API'>API</a></h2> |