Removes the source file after file transfer.

Defines streaming for file transfer. On z/OS, ext is the default and enables direct MVS dataset access. All files will use extended streaming, if not otherwise set with "--streaming".

The --streaming=ext option requires also the --checksum=no option, because if checksums are calculated, the file transfer uses staging, which excludes streaming.

Option yes means regular streaming will be used, but files smaller than buffer_size_bytes are not transferred using streaming. Use force with small files.

An alternative way to activate extended streaming is to define SSH_SFTP_STREAMING_MODE=ext and SSH_SFTP_CHECKSUM_MODE=no as environment variables.

Destination filename will be converted to lowercase characters.

Only shows the current newline convention. Does not set the transfer mode to ASCII.

Sets hints for the remote and local newline conventions. The local_nl_conv option operates on the local side, but notice that usually the correct local newline convention is already compiled in.

Notice that those options are only hints for the underlying transfer layer, which tries to use the actual newline convention given by the server whenever possible. You can set either of these options to ask, which will cause sftpg3 to prompt you for the newline convention when needed. The available conventions are dos, unix, and mac, using \r\n, \n, and \r as newlines, respectively.

This command does not set the transfer mode to ASCII.

Recursively changes files and directories.

Uses silent mode (error messages are suppressed).

Uses verbose mode (lists every file processed).

Use md5 or sha1 hash algorithm (default: md5).

Start reading from file offset OFFSET.

Read LENGTH bytes of file data.

The sftpg3 client transfers files recursively from the current directory and all its subdirectories.

The get command is executed as sget meaning that it transfer a single file, and no subdirectories are copied.

Only regular files and symbolic links from the specified directory are copied, and no subdirectories are copied. Otherwise the semantics of the get command are unchanged.

Preserves the file permissions and the timestamps when both the source and the destination are on Unix filesystems (including z/OS USS). Preserves the timestamps but not the file permissions, if either one, the source or the destination is on Windows. If the destination is on z/OS MVS, none will be preserved.

Removes the source file after file transfer. Also directories are removed, if they become empty (move mode).

Prompts whether to overwrite an existing destination file (does not work with batch mode).

Decides whether to overwrite existing destination file(s) (default: yes).

Defines whether MD5 or SHA-1 checksums or a separate checkpoint database are used to determine the point in the file where file transfer can be resumed. The default is no, meaning that checksums are not used if "--checksum" is not specified.

With option yes, SHA1 checksums are used in FIPS mode, and MD5 checksums are used otherwise. Note however, that files smaller than buffer_size_bytes are not checked. Use md5-force or sha1-force with small files. Use checkpointing when transferring large files one by one.

Does not try incremental checks. By default (if this option is not given), incremental checks are tried. This option can only be used together with the --checksum option.

Time interval between checkpoint updates (default: 10 seconds). This option can only be used when --checksum=checkpoint.

Byte interval between checkpoint updates (default: 10 MB). This option can only be used when --checksum=checkpoint.

Defines streaming for file transfer. On z/OS, ext is the default and enables direct MVS dataset access. All files will use extended streaming, if not otherwise set with "--streaming".

The --streaming=ext option requires also the --checksum=no option, because if checksums are calculated, the file transfer uses staging, which excludes streaming.

Option yes means regular streaming will be used, but files smaller than buffer_size_bytes are not transferred using streaming. Use force with small files.

An alternative way to activate extended streaming is to define SSH_SFTP_STREAMING_MODE=ext and SSH_SFTP_CHECKSUM_MODE=no as environment variables.

Destination filename will be converted to lower case characters.

Adds prefix PREFIX to filename during the file transfer. The prefix is removed after the file has been successfully transferred.

Chooses the style of the statistics to be shown after a file transfer operation. The options mean:

no - no statistics will be shown. This is the default.

yes - detailed statistics will be shown. You can configure the contents with the statistics-format option. The default statistics contents are:

Default settings:                    Render for example this:
"Source: %c:%g\n"                    user@host1#22:/path/to/source/file
"Source parameters: %e\n"            X=TEXT, C=ISO8859-1,D=IBM.1047
"Destination: %C:%G\n"               user@host2#22:/path/to/destination/file
"Destination parameters: %E\n"       NONE
"File size: %s bytes\n"              123456 bytes
"Transferred: %t bytes\n"            123456 bytes
"Rate: %RB/s\n"                      345kiB/s
"Start: %xy-%xt-%xd %xh:%xm:%xs\n"   2008-12-19 13:10:56
"Stop: %Xy-%Xt-%Xd %Xh:%Xm:%Xs\n"    2008-12-19 13:23:30
"Time: %y\n"                         00:12:34

simple - simple one-line statistics will be shown. You can configure the contents with the statistics-format option. The default statistics contents are:

Default settings:                   Render for example this:  
"%f | %TB | %RB/s | TOC: %z\n"      file | 2.8kiB |  72kiB/s | TOC: 00:00:38

bytes - basic statistics reporting the transferred bytes will be shown. You can configure the contents with the statistics-format option. The default statistics contents are:

Default settings:                             
"Transferred %t bytes, file: '%f' -> '%F'\n"  

Render for example this:  
Transferred 12345 bytes, file: 'file1' -> 'file2'

Chooses the format and the contents of the statistics. Use this option when --statistics=yes|simple|bytes. Select the contents for the statistics using the following definitions:

%c      - source connection: user@host#port or profile
%g      - /path/to/source/file
%f      - source file name
%e      - source parameters (file transfer and dataset parameters)
%C      - destination connection: user@host#port or profile
%G      - /path/to/destination/file
%F      - destination file name
%E      - destination parameters (file transfer and dataset parameters)
%s      - file size in bytes
%S      - file size as "XXyB" (B, kiB, MiB or GiB)
%t      - transfer size in bytes
%T      - transfer size as "XXyB" (B, kiB, MiB or GiB)
%p      - transfer percentage
%q      - transfer rate in bit/s
%Q      - transfer rate as "XXyb/s" (b/s, kib/s, Mib/s, Gib/s)
%r      - transfer rate in bytes/s
%R      - transfer rate as "XXyB/s" (B/s, kiB/s, MiB/s, GiB/s)
%D      - current date in format: Wed Jan 28 2009 17:11:52 +0200
%D(FMT) - current date
%x      - start date in format: Wed Jan 28 2009 17:11:52 +0200
%x(FMT) - start date
%X      - end date in format: Wed Jan 28 2009 17:11:52 +0200
%X(FMT) - end date
%y      - elapsed time
%Y      - time remaining
%z      - ETA or, if transfer has finished, TOC
%Z      - string "ETA" or, if transfer has finished, "TOC"
%Z(eta)(toc) - string "eta" or, if transfer has finished, "toc"

Above, (FMT) indicates the conversion specifications used in the strftime(3) POSIX function. Note that the supported conversion specifications vary slightly between operating systems. See your operating system documentation for details. For POSIX related specifications, see also IEEE Std 1003.1, 2004 Edition.

For example on Linux, the following conversion specifications can be used:

%a The abbreviated weekday name according to the current locale.
%A The full weekday name according to the current locale.
%b The abbreviated month name according to the current locale.
%B The full month name according to the current locale.
%c The preferred date and time representation for the current locale.
%C The century number (year/100) as a 2-digit integer.
%d The day of the month as a decimal number (range 01 to 31).
%D Equivalent to %m/%d/%y. 
%e Like %d, the day of the month as a decimal number, but a leading zero is 
   replaced by a space.
%F Equivalent to %Y-%m-%d (the ISO 8601 date format).
%G The ISO 8601 year with century as a decimal number. The 4-digit year 
   corresponding to the ISO week number (see %V). This has the same format 
   and value as %y, except that if the ISO week number belongs to the 
   previous or next year, that year is used instead.
%g Like %G, but without century, that is, with a 2-digit year (00-99).
%h Equivalent to %b.
%H The hour as a decimal number using a 24-hour clock (range 00-23).
%I The hour as a decimal number using a 12-hour clock (range 01-12).
%j The day of the year as a decimal number (range 001-366).
%k The hour (24-hour clock) as a decimal number (range 0-23);
   single digits are preceded by a blank. (See also %H.)
%l The hour (12-hour clock) as a decimal number (range 1-12);
   single digits are preceded by a blank. (See also %I.)
%m The month as a decimal number (range 01-12).
%M The minute as a decimal number (range 00-59).
%p Either `AM' or `PM' according to the given time value, or the 
   corresponding strings for the current locale. Noon is treated as `pm' 
   and midnight as `am'.
%r The time in a.m. or p.m. notation. In the POSIX locale this is equivalent 
   to %I:%M:%S%p.
%R The time in 24-hour notation (%H:%M). 
   For a version including the seconds, see %T below.
%S The second as a decimal number (range 00-60). (The range is up to 60 to 
   allow for occasional leap seconds.)
%T The time in 24-hour notation (%H:%M:%S).
%u The day of the week as a decimal, range 1 to 7, Monday being 1. See
   also %w.
%U The week number of the current year as a decimal number, range 00-53, 
   starting with the first Sunday as the first day of week 01. 
   See also %V and %W.
%V The ISO 8601:1988 week number of the current year as a decimal number, 
   range 01-53, where week 1 is the first week that has at least 4 days in 
   the current year, and with Monday as the first day of the week. 
   See also %U and %W.
%w The day of the week as a decimal, range 0-6, Sunday being 0. See also %u.
%W The week number of the current year as a decimal number, range 00-53, 
   starting with the first Monday as the first day of week 01.
%x The preferred date representation for the current locale without the time.
%X The preferred time representation for the current locale without the date.
%y The year as a decimal number without a century (range 00-99).
%Y The year as a decimal number including the century.
%z The time-zone as hour offset from GMT. Required to emit RFC 822
   conformant dates (using "%a, %d %b %Y %H:%M:%S %z").
%Z The time zone or name or abbreviation.

Other special characters in the format strings are:

\n - line feed
\t - horizontal tab
\\ - backslash
%% - a literal % sign

Chooses the mode of displaying the progress during a file transfer operation. The default is bar, which shows a progress bar. Option line shows the progress information according to the settings made in the --progress-line-format option.

Chooses what information will be shown on the progress line. Use this option when --progress-display=line. Select the contents for the progress line using the same conversion specification options as with --statistics-format above.

Defines how often the progress information is updated in line mode. The interval is given in seconds, and the default is 60 seconds.

Connects the local side to the local filesystem (which does not require a server).

Directory trees are listed recursively. By default, subdirectories of the arguments are not visited.

Permissions, owners, sizes and modification times are also shown (long format).

Sorting is done based on file sizes (default: alphabetical sorting).

The sort order is reversed.

Only one page of listing is shown at a time.

The client generates the long output (alias for option -l).

The long output supplied by the server is used, if available.

Connects the remote side to the local filesystem (which does not require a server).

Prompts whether to remove a file or directory (does not work with batch mode).

Directories are removed recursively.

Sets the parameters to be system defaults.

When at least one of the communicating parties is a z/OS host, sftpg3 checksums cannot be used, and so the default is always no.

If you need to change the sftpg3 checksum behaviour, use the command option "--checksum", instead.

Defines what mode of recursiveness is used in the file transfer:

Decides whether to overwrite existing destination file(s) (default: yes).

Chooses the mode of displaying the progress during a file transfer operation. The default is bar, which shows a progress bar. Option line shows the progress information according to the settings made with the progress-line-format option.

Chooses what information will be shown on the progress line. Use this option when --progress-display=line. See the definitions of contents options in command: get --progress-line-format.

Defines how often the progress information is updated in line mode. The interval is given in seconds, and the default is 60 seconds.

Chooses the style of the statistics to be shown after a file transfer operation (default: no). See the options described for command: get --statistics.

Chooses the format and contents of the statistics. Use this command when statistics-display=yes|simple|bytes. See the definitions of contents options in command: get --statistics-format

When at least one of the communicating parties is a z/OS host, sftpg3 streaming always defaults to ext, and extended streaming is used enabling direct MVS dataset access.

If you need to change the sftpg3 streaming behaviour, use the command option "--streaming".

By default, files smaller than buffer_size_bytes are not transferred using streaming. Use force with small files.

On z/OS, the default streaming=ext option also forces the checksum=no setting, because any checksum calculations would require staging, which in turn would exclude streaming.

An alternative way to activate extended streaming is to define SSH_SFTP_STREAMING_MODE=ext and SSH_SFTP_CHECKSUM_MODE=no as environment variables.

Prints the uid.

Prints the euid.

Prints the pid.

Prints the thread id.

Prints the hostname.

Prints the debug level.

Prints the module.

Prints the line.

Prints the function name.

Prints the file name.

Prints the message.

Prints the ordinal or the number of messages printed so far.

Prints the new line.

Expands to the value of the environment variable var.

Formats a piece of the current date, where x is one of the following

f -- milliseconds
s -- seconds
m -- minutes
h -- hours
d -- day
t -- month
y -- year

Reports resource usage, where x is one of the following

u -- user time used by current process
U -- user time used by children that have terminated and have been waited for
s -- system time used by current process
S -- system time used by children that have terminated and have been waited for

Enables word-wrapping of debug messages. No line of output will be longer than m characters, and every line after the first one in a message will be indented by i spaces. This does not actually output anything.

Just writes the character n in verbatim to the output, and it is assumed to take zero width.

Causes the debug module to sleep n milliseconds after the debug message has been printed. The value of n must lie between 0 and 60,000 (one minute).

Gives field maximum width n to the option x.

Gives field minimum width n to the option x.

Specifies alignment to right.