Return to xnsftp.1 CVS log

Up to [CSRG BSD Unix] / 43BSD / contrib / xns / examples / filing

Annotation of 43BSD/contrib/xns/examples/filing/xnsftp.1, revision 1.1

1.1     ! root        1: .TH XNSFTP L "20 June 1985"
        !             2: .UC 4
        !             3: .SH NAME
        !             4: xnsftp \-file transfer program
        !             5: .SH SYNOPSIS
        !             6: .B ftp
        !             7: [ 
        !             8: .B \-v
        !             9: ] [
        !            10: .B \-d
        !            11: ] [
        !            12: .B \-i
        !            13: ] [
        !            14: .B \-n
        !            15: ] [
        !            16: .B \-g
        !            17: ] [
        !            18: .B host
        !            19: ]
        !            20: .SH DESCRIPTION
        !            21: .I Xnsftp
        !            22: is a user interface to the XNS Courier Filing protocol.
        !            23: The program allows a user to transfer files to and from a
        !            24: remote network site running Filing (version 4) server software,
        !            25: typically a Xerox file server.
        !            26: .PP
        !            27: The server host with which 
        !            28: .I xnsftp
        !            29: is to communicate may be specified on the command line.
        !            30: If this is done,
        !            31: .I xnsftp
        !            32: will immediately attempt to establish a connection to a Filing server
        !            33: server on that host; otherwise, 
        !            34: .I xnsftp
        !            35: will enter its command interpreter and await instructions
        !            36: from the user.  When 
        !            37: .I xnsftp
        !            38: is awaiting commands from the user the prompt \*(lqxnsftp>\*(rq
        !            39: is provided the user.  The following commands are recognized
        !            40: by
        !            41: .IR xnsftp :
        !            42: .TP
        !            43: .B \&!
        !            44: Invoke a shell on the local machine.
        !            45: .TP
        !            46: \fBappend\fP \fIlocal-file\fP [ \fIremote-file\fP ]
        !            47: Not yet implemented!
        !            48: Append a local file to a file on the remote machine.
        !            49: If
        !            50: .I remote-file
        !            51: is left unspecified, the local file name is used in naming the
        !            52: remote file.  File transfer uses the current settings for
        !            53: .IR type ,
        !            54: .IR format ,
        !            55: .IR mode ,
        !            56: and
        !            57: .IR structure .
        !            58: .TP
        !            59: .B ascii
        !            60: Set the file transfer 
        !            61: .I type
        !            62: to network ASCII.  This is the default type, and is appropriate for
        !            63: transferring 7-bit ascii text files.
        !            64: .TP
        !            65: .B bell
        !            66: Arrange that a bell be sounded after each file transfer
        !            67: command is completed.
        !            68: .TP
        !            69: .B binary
        !            70: Set the file transfer
        !            71: .I type
        !            72: to support binary image transfer.
        !            73: This is the appropriate type for transferring 8-bit binary data, e.g. Interlisp
        !            74: DCOM files.
        !            75: .TP
        !            76: .B bye
        !            77: Terminate the FTP session with the remote server
        !            78: and exit
        !            79: .IR xnsftp .
        !            80: .TP
        !            81: .BI cd " remote-directory"
        !            82: Change the working directory on the remote machine
        !            83: to 
        !            84: .IR remote-directory .
        !            85: .TP
        !            86: .B close
        !            87: Terminate the FTP session with the remote server, and
        !            88: return to the command interpreter.
        !            89: .TP
        !            90: .BI delete " remote-file"
        !            91: Delete the file
        !            92: .I remote-file
        !            93: on the remote machine.
        !            94: If the remote file is a directory a confirmation will be required.
        !            95: .TP
        !            96: \fBdebug\fP [ \fIdebug-value\fP ]
        !            97: Toggle debugging mode.  If an optional
        !            98: .I debug-value
        !            99: is specified it is used to set the debugging level.
        !           100: .TP
        !           101: \fBdir\fP [ \fIremote-directory\fP ] [ \fIlocal-file\fP ]
        !           102: Print a listing of the directory contents in the
        !           103: directory,
        !           104: .IR remote-directory ,
        !           105: and, optionally, placing the output in
        !           106: .IR local-file .
        !           107: If no directory is specified, the current working
        !           108: directory on the remote machine is used.  If no local
        !           109: file is specified, output comes to the terminal.
        !           110: .TP
        !           111: .BI form " format"
        !           112: Set the file transfer 
        !           113: .I form
        !           114: to 
        !           115: .IR format .
        !           116: The default format, and the only one currently supported, is \*(lqfile\*(rq.
        !           117: .TP
        !           118: \fBget\fP \fIremote-file\fP [ \fIlocal-file\fP ]
        !           119: Retrieve the 
        !           120: .I remote-file
        !           121: and store it on the local machine.  If the local
        !           122: file name is not specified, it is given the same
        !           123: name it has on the remote machine.
        !           124: The current settings for 
        !           125: .IR type ,
        !           126: .IR form ,
        !           127: .IR mode ,
        !           128: and
        !           129: .I structure
        !           130: are used while transferring the file.
        !           131: .TP
        !           132: \fBhash\f
        !           133: Toggle hash-sign (``#'') printing for each data block
        !           134: transferred.  Data blocks vary depending on implementation, but
        !           135: are typically 534 bytes long.
        !           136: .TP
        !           137: .B glob
        !           138: Toggle file name globbing.  With file name globbing enabled,
        !           139: each local file or pathname is processed for 
        !           140: .IR csh (1)
        !           141: metacharacters.  These characters include ``*?[]~{}''.
        !           142: Remote files specified in mutliple item commands, e.g.
        !           143: .IR mput ,
        !           144: are globbed by the remote server.  With globbing disabled
        !           145: all files and pathnames are treated literally.
        !           146: .TP
        !           147: \fBhelp\fP [ \fIcommand\fP ]
        !           148: Print an informative message about the meaning of
        !           149: .IR command .
        !           150: If no argument is given, 
        !           151: .I xnsftp
        !           152: prints a list of the known commands.
        !           153: .TP
        !           154: \fBlcd\fP [ \fIdirectory\fP ]
        !           155: Change the working directory on the local machine.  If
        !           156: no 
        !           157: .I directory
        !           158: is specified, the user's home directory is used.
        !           159: .TP
        !           160: \fBls\fP [ \fIremote-directory\fP ] [ \fIlocal-file\fP ]
        !           161: Print an abbreviated listing (containing remote path names) of the contents of a
        !           162: directory on the remote machine.  If
        !           163: .I remote-directory
        !           164: is left unspecified, the current working directory
        !           165: is used.  If no local file is specified, the output
        !           166: is sent to the terminal.
        !           167: .TP
        !           168: \fBmdelete\fP \fIremote-files\fP
        !           169: Delete the specified files on the remote machine.  If globbing
        !           170: is enabled, the specification of remote files will first be
        !           171: expanded using
        !           172: .IR ls .
        !           173: .TP
        !           174: \fBmdir\fP \fIremote-files\fP \fIlocal-file\fP
        !           175: Obtain a directory listing of multiple files on the remote
        !           176: machine and place the result in
        !           177: .IR local-file .
        !           178: .TP
        !           179: \fBmget\fP \fIremote-files\fP
        !           180: Retrieve the specified files from the remote machine and
        !           181: place them in the current local directory.  If globbing
        !           182: is enabled, the specification of remote files will first be
        !           183: expanding using
        !           184: .IR ls .
        !           185: The local file names will be identical with the name attribute of
        !           186: the remote file names i.e. with the last component of the remote pathname.
        !           187: .TP
        !           188: \fBmkdir\fP \fIdirectory-name\fP
        !           189: Make a directory on the remote machine.
        !           190: .TP
        !           191: \fBmls\fP \fIremote-files\fP \fIlocal-file\fP
        !           192: Obtain an abbreviated listing of multiple files on the remote
        !           193: machine and place the result in
        !           194: .IR local-file .
        !           195: .TP
        !           196: \fBmode\fP [ \fImode-name\fP ]
        !           197: Set the file transfer
        !           198: .I mode
        !           199: to
        !           200: .IR mode-name .
        !           201: The default mode, and the only one currently supported,
        !           202: is \*(lqstream\*(rq mode.
        !           203: .TP
        !           204: \fBmput\fP \fIlocal-files\fP
        !           205: Transfer multiple local files from the current local directory
        !           206: to the current working directory on the remote machine.
        !           207: .TP
        !           208: \fBopen\fP \fIhost\fP [ \fIport\fP ]
        !           209: Establish a connection to the specified
        !           210: .I host
        !           211: Filing server.
        !           212: Note that
        !           213: .I host
        !           214: must be the Clearinghouse name of a Filing server, e.g. 
        !           215: \*(lqcornellfs1:computer\ science:cornell-univ\*(rq; if the domain
        !           216: and organization components of the name are not specified, they default
        !           217: to the local domain and organization.
        !           218: If the 
        !           219: .I auto-login
        !           220: option is on (default), 
        !           221: .I xnsftp
        !           222: will also attempt to automatically log the user in to
        !           223: the Filing server (see below).
        !           224: .TP
        !           225: .B prompt
        !           226: Toggle interactive prompting.  Interactive prompting
        !           227: occurs during multiple file transfers to allow the
        !           228: user to selectively retrieve or store files.  If
        !           229: prompting is turned off (default), any
        !           230: .I mget
        !           231: or
        !           232: .I mput
        !           233: will transfer all files.
        !           234: .TP
        !           235: \fBput\fP \fIlocal-file\fP [ \fIremote-file\fP ]
        !           236: Store a local file on the remote machine.  If 
        !           237: .I remote-file
        !           238: is left unspecified, the local file name is used
        !           239: in naming the remote file.  File transfer uses the
        !           240: current settings for
        !           241: .IR type ,
        !           242: .IR format ,
        !           243: .IR mode ,
        !           244: and
        !           245: .IR structure .
        !           246: .TP
        !           247: .B pwd
        !           248: Print the name of the current working directory on the remote
        !           249: machine.
        !           250: .TP
        !           251: .B quit
        !           252: A synonym for bye.
        !           253: .TP
        !           254: \fBrename\fP [ \fIfrom\fP ] [ \fIto\fP ]
        !           255: Not yet implemented!
        !           256: Rename the file
        !           257: .I from
        !           258: on the remote machine, to the file
        !           259: .IR to .
        !           260: .TP
        !           261: .BI rmdir " directory-name"
        !           262: Delete a directory on the remote machine.
        !           263: .TP
        !           264: \fBsend\fP \fIlocal-file\fP [ \fIremote-file\fP ]
        !           265: A synonym for put.
        !           266: .TP
        !           267: .B status
        !           268: Show the current status of
        !           269: .IR xnsftp .
        !           270: .TP
        !           271: \fBstruct\fP [ \fIstruct-name\fP ]
        !           272: Set the file transfer
        !           273: .I structure
        !           274: to
        !           275: .IR struct-name .
        !           276: By default \*(lqstream\*(rq structure is used.
        !           277: This is also the only structure currently supported.
        !           278: .TP
        !           279: .B trace
        !           280: Toggle packet tracing.
        !           281: .TP
        !           282: \fBtype\fP [ \fItype-name\fP ]
        !           283: Set the file transfer
        !           284: .I type
        !           285: to
        !           286: .IR type-name .
        !           287: If no type is specified, the current type
        !           288: is printed.  The default type is network ASCII.
        !           289: Only ASCII and BINARY types are currently supported.
        !           290: .TP
        !           291: \fBuser\fP \fIuser-name\fP [ \fIpassword\fP ]
        !           292: Identify yourself to the remote Filing server.  If the
        !           293: password is not specified and the server requires it,
        !           294: .I xnsftp
        !           295: will prompt the user for it (after disabling local echo).
        !           296: Unless
        !           297: .I xnsftp
        !           298: is invoked with \*(lqauto-login\*(rq disabled, this
        !           299: process is done automatically on initial connection to
        !           300: the Filing server.
        !           301: The user name should be a standard XNS Clearinghouse name or alias, e.g.
        !           302: \*(lqj.q.\ johnson:computer\ science:cornell-univ\*(rq; if the domain
        !           303: and organization components of the name are not specified, they default
        !           304: to the local domain and organization.
        !           305: .TP
        !           306: .B verbose
        !           307: Toggle verbose mode.  In verbose mode, all responses from
        !           308: the Filing server are displayed to the user.  In addition,
        !           309: if verbose is on, when a file transfer completes, statistics
        !           310: regarding the efficiency of the transfer are reported.  By default,
        !           311: verbose is on.
        !           312: .TP
        !           313: \fB?\fP [ \fIcommand\fP ]
        !           314: A synonym for help.
        !           315: .PP
        !           316: Command arguments which have embedded spaces may be quoted with
        !           317: quote (") marks.
        !           318: .PP
        !           319: .SH "FILE NAMING CONVENTIONS"
        !           320: Files specified as arguments to
        !           321: .I xnsftp
        !           322: commands are processed according to the following rules.
        !           323: .TP
        !           324: 1)
        !           325: If the file name \*(lq\-\*(rq is specified, the
        !           326: .B stdin
        !           327: (for reading) or
        !           328: .B stdout
        !           329: (for writing) is used.
        !           330: .TP
        !           331: 2)
        !           332: If the first character of the file name is \*(lq|\*(rq, the
        !           333: remainder of the argument is interpreted as a shell command.
        !           334: .I Xnsftp
        !           335: then forks a shell, using 
        !           336: .IR popen (3)
        !           337: with the argument supplied, and reads (writes) from the stdout
        !           338: (stdin).  If the shell command includes spaces, the argument
        !           339: must be quoted; e.g. \*(lq"| ls -lt"\*(rq.  A particularly
        !           340: useful example of this mechanism is: \*(lqdir |more\*(rq.
        !           341: .TP
        !           342: 3)
        !           343: Failing the above checks, if ``globbing'' is enabled, 
        !           344: local file names are expanded
        !           345: according to the rules used in the 
        !           346: .IR csh (1);
        !           347: c.f. the 
        !           348: .I glob
        !           349: command. 
        !           350: .TP
        !           351: 4)
        !           352: Remote file names whose first character is \*(lq/\*(rq (slash) are interpreted
        !           353: as absolute pathnames.  Other remote file names are interpreted as pathnames
        !           354: relative to the current connected directory.
        !           355: .SH "FILE TRANSFER PARAMETERS"
        !           356: The FTP specification specifies many parameters which may
        !           357: affect a file transfer.  The 
        !           358: .I type
        !           359: may be one of \*(lqascii\*(rq, \*(lqbinary\*(rq (image),
        !           360: \*(lqebcdic\*(rq, and \*(lqlocal byte size\*(rq (for PDP-10's
        !           361: and PDP-20's mostly).
        !           362: .I Xnsftp
        !           363: supports the ascii and binary types of file transfer.
        !           364: ASCII type is appropriate for transferring text files; Unix EOL characters
        !           365: (\\n) are translated to and from Xerox EOL characters (\\r), Xerox left
        !           366: arrow characters are translated to underscore, etc.  BINARY (image) type
        !           367: is appropriate for all other files.
        !           368: .PP
        !           369: .I Xnsftp
        !           370: supports only the default values for the remaining
        !           371: file transfer parameters: 
        !           372: .IR mode ,
        !           373: .IR form ,
        !           374: and
        !           375: .IR struct .
        !           376: .SH OPTIONS
        !           377: Options may be specified at the command line, or to the 
        !           378: command interpreter.
        !           379: .PP
        !           380: The
        !           381: .B \-v
        !           382: (verbose on) option forces
        !           383: .I xnsftp
        !           384: to show all responses from the remote server, as well
        !           385: as report on data transfer statistics.
        !           386: .PP
        !           387: The
        !           388: .B \-n
        !           389: option restrains 
        !           390: .I xnsftp
        !           391: from attempting \*(lqauto-login\*(rq upon initial connection.
        !           392: .PP
        !           393: The
        !           394: .B \-i
        !           395: option turns off interactive prompting during
        !           396: mutliple file transfers.
        !           397: .PP
        !           398: The
        !           399: .B \-d
        !           400: option enables debugging.
        !           401: .PP
        !           402: The
        !           403: .B \-g
        !           404: option disables file name globbing.
        !           405: .SH BUGS
        !           406: Append and Rename are not yet implemented.
        !           407: .PP
        !           408: Many interesting features of the Filing protocol, e.g. serialized files
        !           409: and remote searches using the Find RPC, are not supported.
        !           410: Also, only version 4 of Filing is supported.
        !           411: .PP
        !           412: Aborting a file
        !           413: transfer does not work right; if one attempts this the connection to
        !           414: the remote server will likely have to be reopened.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.