docs/36459: [PATCH] tftp(1) manual's "get" syntax/description is confusing

[Jim Brown]

The following reply was made to PR docs/36459; it has been noted by GNATS.

From: Jim Brown <jpb at sixshooter.v6.thrupoint.net>
To: freebsd-gnats-submit at FreeBSD.org, swear at blarg.net
Cc:  
Subject: Re: docs/36459: [PATCH] tftp(1) manual's "get" syntax/description is confusing
Date: Tue, 6 May 2003 11:45:50 -0400

 Hi,
 
 Here is a patch for docs/36459 to clear up
 the different command forms for 'get' and 'put'.
 
 Best Regards,
 jpb
 ===
 
 
 root at jpb-wks:/usr2/tmp/src/usr.bin/tftp#cvs diff -u tftp.1
 Index: tftp.1
 ===================================================================
 RCS file: /home/ncvs/src/usr.bin/tftp/tftp.1,v
 retrieving revision 1.14
 diff -u -r1.14 tftp.1
 --- tftp.1      2002/11/26 17:33:36     1.14
 +++ tftp.1      2003/05/06 15:43:27
 @@ -101,15 +101,33 @@
  .It Cm get Ar remotename localname
  .It Cm get Ar file1 file2 ...  fileN
  Get a file or set of files from the specified
 -.Ar sources .
 -.Ar Source
 -can be in one of two forms:
 +.Ar source .
 +If the first command form is used, the file
 +is transferred from the remote host
 +to the local host retaining the same name.
 +If the second form is used, the file is
 +transferred from the remote host to the
 +local host and renamed as
 +.Ar localname .
 +If the third form is
 +used, the last hostname specified becomes the default for
 +future transfers.
 +.Pp
 +A
 +.Ar source
 +can be in one of two forms-
  a filename on the remote host, if the host has already been specified,
  or a string of the form
 -.Ar hosts Ns : Ns Ar filename
 +.Ar host Ns : Ns Ar filename
  to specify both a host and filename at the same time.
  If the latter form is used,
  the last hostname specified becomes the default for future transfers.
 +To specify an IPv6 numeric address for a
 +.Ar host ,
 +wrap it using square brackets
 +like [3ffe:2900:e00c:ffee::1234]:foo
 +to disambiguate the colons used in the IPv6 address
 +from the colon separating the host from the filename.
  .Pp
  .It Cm mode Ar transfer-mode
  Set the mode for transfers;
 @@ -126,23 +144,18 @@
  .It Cm put Ar file1 file2 ... fileN remote-directory
  Put a file or set of files to the specified
  remote file or directory.
 -The destination
 -can be in one of two forms:
 -a filename on the remote host, if the host has already been specified,
 -or a string of the form
 -.Ar hosts Ns : Ns Ar filename
 -to specify both a host and filename at the same time.
 -If the latter form is used,
 -the hostname specified becomes the default for future transfers.
 +The three command forms have similar meaning
 +to those of the
 +.Ar get
 +command above.
  If the remote-directory form is used, the remote host is
  assumed to be a
  .Ux
  machine.
 -To specify IPv6 numeric addresses with
 -.Ar hosts ,
 -wrap them using square brackets like
 -.Bo Ar hosts Bc Ns : Ns Ar filename ,
 -to disambiguate the colon.
 +To specify an IPv6 numeric address for a
 +.Ar host ,
 +see the example above under
 +.Ar get .
  .Pp
  .It Cm quit
  Exit