src/usr.bin/ftp/ftp.1 - diff

Return to ftp.1 CVS log

Up to [local] / src / usr.bin / ftp

Diff for /src/usr.bin/ftp/ftp.1 between version 1.28 and 1.29

version 1.28, 2000/02/29 04:52:37

version 1.29, 2000/03/07 21:11:09

Line 65

.Pp

The latter three usage formats will fetch a file using either the

HTTP or FTP protocols into the current directory.

This is ideal for scripts. Refer to

This is ideal for scripts.

Refer to

.Sx AUTO-FETCHING FILES

below for more information.

.Pp

The options are as follows:

.Bl -tag -width "port "

.It Fl A

Force active mode ftp. By default,

Force active mode ftp.

By default,

.Nm

will try to use passive mode ftp and fall back to active mode

if passive is not supported by the server. This option causes

if passive is not supported by the server.

This option causes

.Nm

to always use an active connection. It is only useful for connecting

to always use an active connection.

It is only useful for connecting

to very old servers that do not implement passive mode properly.

.It Fl a

Causes

Line 86

Line 90

.It Fl d

Enables debugging.

.It Fl e

Disables command line editing. Useful for Emacs ange-ftp.

Disables command line editing.

Useful for Emacs ange-ftp.

.It Fl g

Disables file name globbing.

.It Fl i

Line 163

Line 168

When

.Nm

is awaiting commands the prompt

.Ql ftp>

.Dq ftp>

is provided to the user.

The following commands are recognized

Line 196

Line 201

.Ic nmap

setting.

File transfer uses the current settings for

.Ic type ,

.Ic format ,

.Ic mode ,

and

.Ic structure .

.It Ic ascii

Line 281

Line 286

.Nm

prints each command sent to the remote machine,

preceded by the string

.Ql \-\->

.Ql \-\-> .

.It Ic dir Op Ar remote-directory Op Ar local-file

Print a listing of the contents of a

directory on the remote machine.

Line 305

Line 310

If no local file is specified, or if

.Ar local-file

.Sq Fl ,

.Dq - ,

the output is sent to the terminal.

.It Ic disconnect

A synonym for

Line 335

Line 340

file name is not specified, it is given the same

name it has on the remote machine, subject to

alteration by the current

.Ic case ,

.Ic ntrans ,

and

.Ic nmap

settings.

The current settings for

.Ic type ,

.Ic form ,

.Ic mode ,

and

.Ic structure

are used while transferring the file.

Line 364

Line 369

gate-ftp server.

.It Ic glob

Toggle filename expansion for

.Ic mdelete ,

.Ic mget

and

.Ic mput .

If globbing is turned off with

.Ic glob ,

the file name arguments

are taken literally and not expanded.

Globbing for

Line 379

Line 384

For

.Ic mdelete

and

.Ic mget ,

each remote file name is expanded

separately on the remote machine and the lists are not merged.

Expansion of a directory name is likely to be

Line 398

Line 403

.Xr tar 1

archive of the subtree (in binary mode).

.It Ic hash Op Ar size

Toggle hash-sign (``#'') printing for each data block

Toggle hash mark

transferred.

.Pq Ql #

printing for each data block transferred.

The size of a data block defaults to 1024 bytes.

This can be changed by specifying

.Ar size

Line 443

Line 449

If no local file is specified, or if

.Ar local-file

.Fl ,

.Dq - ,

the output is sent to the terminal.

.It Ic macdef Ar macro-name

Define a macro.

Subsequent lines are stored as the macro

.Ar macro-name ;

a null line (consecutive newline characters

in a file or

carriage returns from the terminal) terminates macro input mode.

Line 457

Line 463

Macros remain defined until a

.Ic close

command is executed.

The macro processor interprets `$' and `\e' as special characters.

The macro processor interprets

A `$' followed by a number (or numbers) is replaced by the

.Ql $

and

.Ql \e

as special characters.

.Ql $

followed by a number (or numbers) is replaced by the

corresponding argument on the macro invocation command line.

A `$' followed by an `i' tells the macro processor that the

.Ql $

followed by an

.Sq i

tells the macro processor that the

executing macro is to be looped.

On the first pass `$i' is

On the first pass

.Ql $i

replaced by the first argument on the macro invocation command line,

on the second pass it is replaced by the second argument, and so on.

A `\e' followed by any character is replaced by that character.

Use the `\e' to prevent special treatment of the `$'.

.Ql \e

followed by any character is replaced by that character.

Use the

.Ql \e

to prevent special treatment of the

.Ql $ .

.It Ic mdelete Op Ar remote-files

Delete the

.Ar remote-files

on the remote machine.

.It Ic mdir Ar remote-files local-file

.Ic dir ,

except multiple remote files may be specified.

If interactive prompting is on,

.Nm

Line 492

Line 515

.Ic glob

for details on the filename expansion.

Resulting file names will then be processed according to

.Ic case ,

.Ic ntrans ,

and

.Ic nmap

Line 506

Line 529

Make a directory on the remote machine.

.It Ic mls Ar remote-files local-file

.Ic ls ,

except multiple remote files may be specified,

and the

.Ar local-file

Line 584

Line 607

.Ic case

settings).

Variable templating is accomplished by including the

sequences `$1', `$2', ..., `$9' in

sequences

.Ql $1 ,

.Ql $2 ,

...,

.Ql $9

.Ar inpattern .

Use `\\' to prevent this special treatment of the `$' character.

Use

.Ql \e

to prevent this special treatment of the

.Ql $

character.

All other characters are treated literally, and are used to determine the

.Ic nmap

.Ar inpattern

Line 598

Line 630

The

.Ar outpattern

determines the resulting mapped filename.

The sequences `$1', `$2', ...., `$9' are replaced by any value resulting

The sequences

from the

.Ql $1 ,

.Ql $2 ,

...,

.Ql $9

are replaced by any value resulting from the

.Ar inpattern

template.

The sequence `$0' is replaced by the original filename.

The sequence

.Ql $0

is replaced by the original filename.

Additionally, the sequence

.Ql Op Ar seq1 , Ar seq2

is replaced by

Line 618

Line 656

.Ed

.Pp

would yield

the output filename "myfile.data" for input filenames "myfile.data" and

the output filename

"myfile.data.old", "myfile.file" for the input filename "myfile", and

.Pa myfile.data ,

"myfile.myfile" for the input filename ".myfile".

for input filenames

.Pa myfile.data

and

.Pa myfile.data.old ,

.Pa myfile.file

for the input filename

.Pa myfile ,

and

.Pa myfile.myfile

for the input filename

.Pa \&.myfile .

Spaces may be included in

.Ar outpattern ,

as in the example: `nmap $1 sed "s/ *$//" > $1' .

as in the example

Use the `\e' character to prevent special treatment

.Pp

of the `$','[','[', and `,' characters.

.Bd -literal -offset indent -compact

nmap $1 sed "s/ *$//" > $1 .

.Ed

.Pp

Use the

.Ql \e

character to prevent special treatment

of the

.Ql $ ,

.Ql [ ,

.Ql \&] ,

and

.Ql \&,

characters.

.It Ic ntrans Op Ar inchars Op Ar outchars

Set or unset the filename character translation mechanism.

If no arguments are specified, the filename character

Line 653

Line 714

If the character's position in

.Ar inchars

is longer than the length of

.Ar outchars ,

the character is deleted from the file name.

.It Ic open Ar host Op Ar port

Establish a connection to the specified

Line 685

Line 746

.Ev PAGER

is null or not defined).

.It Ic passive

Toggle passive mode. If passive mode is turned on

Toggle passive mode.

(default is on), the ftp client will

If passive mode is turned on (default is on), the ftp client will

send a

.Dv PASV

command for all data connections instead of the usual

.Dv PORT

command. The

command.

The

.Dv PASV

command requests that the remote server open a port for the data connection

and return the address of that port. The remote server listens on that

and return the address of that port.

port and the client connects to it. When using the more traditional

The remote server listens on that port and the client connects to it.

When using the more traditional

.Dv PORT

command, the client listens on a port and sends that address to the remote

server, who connects back to it. Passive mode is useful when using

server, who connects back to it.

Passive mode is useful when using

.Nm

through a gateway router or host that controls the directionality of

traffic.

Line 712

Line 776

The progress bar will be disabled for a transfer that has

.Ar local-file

.Sq Fl

.Dq -

or a command that starts with

.Sq \&| .

Refer to

Line 760

Line 824

The first

.Ic proxy

command should be an

.Ic open ,

to establish the secondary control connection.

Enter the command "proxy ?" to see other ftp commands executable on the

Enter the command

.Ic proxy ?

to see other ftp commands executable on the

secondary connection.

The following commands behave differently when prefaced by

.Ic proxy :

.Ic open

will not define new macros during the auto-login process,

.Ic close

Line 775

Line 841

.Ic mget

transfer files from the host on the primary control connection

to the host on the secondary control connection, and

.Ic put ,

.Ic mput ,

and

.Ic append

Line 797

Line 863

in naming the remote file.

File transfer uses the

current settings for

.Ic type ,

.Ic format ,

.Ic mode ,

and

.Ic structure .

.It Ic pwd

Line 820

Line 886

.Ar local-file

exists and is

smaller than

.Ar remote-file ,

.Ar local-file

is presumed to be

a partially transferred copy of

Line 878

Line 944

.Ic get

.Ic mget

command, a ".1" is appended to the name.

command, a

.Dq \&.1

is appended to the name.

If the resulting name matches another existing file,

a ".2" is appended to the original name.

If this process continues up to ".99", an error

.Dq \&.2

is appended to the original name.

If this process continues up to

.Dq \&.99 ,

an error

message is printed, and the transfer does not take place.

The generated unique filename will be reported.

Note that

Line 1021

Line 1093

.El

.Pp

Command arguments which have embedded spaces may be quoted with

quote `"' marks.

quote

.Pq Ql "

marks.

.Pp

Commands which toggle settings can take an explicit

.Ic on

Line 1142

Line 1216

.Bl -enum

.It

If the file name

.Sq Fl

.Dq -

is specified, the stdin

is specified, the standard input (for reading)

(for reading) or stdout

or standard output (for writing)

(for writing) is used.

is used.

.It

If the first character of the file name is

.Sq \&| ,

Line 1154

Line 1228

.Nm

then forks a shell, using

.Xr popen 3

with the argument supplied, and reads (writes) from the stdout

with the argument supplied, and reads (writes) from the standard output

(stdin).

(standard input).

If the shell command includes spaces, the argument

must be quoted; e.g.

must be quoted; e.g.,

\*(Lq" ls -lt"\*(Rq.

A particularly

useful example of this mechanism is: \*(Lqdir \&|more\*(Rq.

.It

Failing the above checks, if ``globbing'' is enabled,

Failing the above checks, if

.Dq globbing

is enabled,

local file names are expanded

according to the rules used in the

.Xr csh 1 ;

c.f. the

.Ic glob

command.

If the

.Nm

command expects a single local file (.e.g.

command expects a single local file (e.g.,

.Ic put ) ,

only the first filename generated by the "globbing" operation is used.

only the first filename generated by the

.Dq globbing

operation is used.

.It

For

.Ic mget

Line 1181

Line 1259

.Ic get

commands with unspecified local file names, the local filename is

the remote filename, which may be altered by a

.Ic case ,

.Ic ntrans ,

.Ic nmap

Line 1224

Line 1302

.Nm

supports only the default values for the remaining

file transfer parameters:

.Ic mode ,

.Ic form ,

and

.Ic struct .

Line 1296

Line 1374

.Pa .netrc

file for any user other

than

.Ar anonymous ,

.Nm

will abort the auto-login process if the

.Pa .netrc

Line 1358

Line 1436

utilizes the following environment variables:

.Bl -tag -width "FTPSERVERPORT"

.It Ev FTPMODE

Overrides the default operation mode. Recognized values are:

Overrides the default operation mode.

Recognized values are:

.Bl -tag -width "passive "

.It passive

passive mode ftp only