NcFTP

https://www.ncftp.com/ncftp/doc/
Admin
NcFTP is a powerful and flexible browser program for the File Transfer Protocol, designed to replace...
Tokens:17,956
Snippets:284
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example NcFTP Spooler Job File Content

Source: https://www.ncftp.com/ncftp/doc/ncftpspooler.html

A sample job file demonstrating the key-value pair format, comments, and blank lines. This file specifies a 'get' operation with various parameters.

```text
# This is a NcFTP spool file entry.
job-name=g-20011016-100656-008299-1
op=get
hostname=ftp.freebsd.org
xtype=I
passive=1
remote-dir=pub/FreeBSD
local-dir=/tmp
remote-file=README.TXT
local-file=readme.txt

```

--------------------------------

### ncftpput Account Information File Example

Source: https://www.ncftp.com/ncftp/doc/ncftpput.html

Specifies account information in a file for ncftpput. This file should contain the host, username, and password.

```text
host sphygmomanometer.ncftp.com
user gleason
pass mypasswd

```

--------------------------------

### List Directory Contents (Unix)

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Example of how to list directory contents on a Unix system.

```bash
/bin/ls -CFrt
```

--------------------------------

### Get Help for NcFTP Commands

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Display a list of all supported commands or get specific help for a particular command by typing 'help' followed by the command name.

```shell
help
```

```shell
help open
```

--------------------------------

### Start NcFTP Background Transfers

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

The 'bgstart' command initiates any pending background file transfers. This is typically handled automatically by NcFTP upon site closure or program exit, but can be manually triggered.

```bash
bgstart
```

--------------------------------

### Display NcFTP Version with version

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

The 'version' command displays information about the NcFTP program edition and its installation details.

```bash
version
```

--------------------------------

### Example Job File Name with Process ID and Sequence Number

Source: https://www.ncftp.com/ncftp/doc/ncftpspooler.html

Illustrates a job file name including a job type, timestamp, process ID, and sequence number. Ensure a dash follows the timestamp if appending extra data.

```text
p-20011207-234500-1234-2
```

--------------------------------

### Set Anonymous Password

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Example of setting the anonymous password configuration variable.

```bash
set anon-password ncftp@example.com
```

--------------------------------

### Specify Redial Count and Delay for Utility Programs

Source: https://www.ncftp.com/ncftp/doc/faq.html

When using utility programs like ncftpget, use the -r flag to specify both the number of redials and the delay between them. This example attempts 3 redials with a 60-second delay.

```bash
ncftpget -r 3,60 ...
```

--------------------------------

### NcFTP Spooler Post-Shell-Command Example

Source: https://www.ncftp.com/ncftp/doc/ncftpspooler.html

This Perl script demonstrates how to use the post-shell-command hook to log FTP transfer results. It reads job parameters from standard input and appends a log entry to '/var/log/ncftp_spooler.log' upon successful download or upload.

```perl
#!/usr/bin/perl -w

use strict;

my ($line);
my (%params) = ();

while (defined($line = <STDIN>)) {
	$params{$1} = $2 if ($line =~ /^([^=\#\s]+)=(.*)/);
}

if ((defined($params{"result"})) && ($params{"result"} =~ /^Succeeded/)) {
	open(LOG, ">> /var/log/ncftp_spooler.log") or exit(1);
	print LOG "DOWNLOAD" if ($params{"op"} eq "get");
	print LOG "UPLOAD" if ($params{"op"} eq "put");
	print LOG " ", $params{"local-file"}, "\n";
	close(LOG);
}


```

--------------------------------

### Login with Username and Absolute Path (Alternative)

Source: https://www.ncftp.com/ncftp/doc/ncftpls.html

Demonstrates specifying a username within the URL and using URL encoding for absolute paths.

```bash
$ ncftpls ftp://steve@ftp.apple.com/%2Fetc/
```

--------------------------------

### Set Redial Delay in NcFTP Shell

Source: https://www.ncftp.com/ncftp/doc/faq.html

Within the NcFTP shell, use the 'set' command to configure the redial delay. This example sets the delay to 60 seconds.

```bash
set redial-delay 60
```

--------------------------------

### Display Program Variables with show

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Use the 'show' command to display program variables. Specify 'all' to show all variables or a specific variable name.

```bash
show
```

```bash
show anon-password
```

--------------------------------

### Specify Login Credentials in a File

Source: https://www.ncftp.com/ncftp/doc/ncftpget.html

Use the -f option to specify a file containing host, user, and password information for authentication. Ensure the file has restricted read permissions.

```bash
host sphygmomanometer.ncftp.com
user gleason
pass mypasswd
```

--------------------------------

### Run Local mkdir Command

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Executes the 'mkdir' command on the local host.

```bash
lmkdir
```

--------------------------------

### Create Directory

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Command to create a new directory on the remote host. Permissions may restrict its use.

```bash
mkdir
```

--------------------------------

### List Local Directory Contents

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Runs 'ls' on the local host and displays the results. Supports standard 'ls' flags.

```bash
lcd ~/doclls -lrt p*.txt
```

--------------------------------

### Save NcFTP Session Settings

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Use the 'bookmark' command to save the current session's remote host and directory. This allows for quick resumption of the session later.

```bash
bookmark
```

--------------------------------

### Recursive Directory Upload with ncftpput

Source: https://www.ncftp.com/ncftp/doc/ncftpput.html

Uploads an entire directory tree recursively to a remote host. Use the -R flag for this functionality.

```bash
$ ncftpput -R pikachu.nintendo.co.jp /incoming /tmp/stuff

```

--------------------------------

### View Local File Page by Page

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Displays a local file one page at a time using the configured PAGER program.

```bash
lpage
```

--------------------------------

### One File Per Line Directory Listing

Source: https://www.ncftp.com/ncftp/doc/ncftpls.html

Use the -1 flag for a simple, one-file-per-line directory listing, which is useful for scripting.

```bash
$ ncftpls -1 ftp://ftp.ncftp.com/ncftp/
```

--------------------------------

### Login with Username and Absolute Path

Source: https://www.ncftp.com/ncftp/doc/ncftpls.html

Specify a username and use URL encoding (%2F for '/') to access absolute pathnames on the remote server.

```bash
$ ncftpls -u linus ftp://ftp.kernel.org/%2Fusr/src/
```

--------------------------------

### Schedule Background File Transfer with NcFTP

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Use 'bgget' to schedule a file download to occur at a specific date and time. This allows for non-immediate transfers, useful for managing bandwidth or performing tasks during off-peak hours.

```bash
bgget -@ 19971106030000 /pub/idstuff/quake/q2_100.zip
```

--------------------------------

### Execute Site-Specific Commands with site

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

The 'site' command allows execution of FTP protocol's site-specific commands. This can be used for operations like changing file permissions.

```bash
site chmod 644 README
```

--------------------------------

### Download File Using URL

Source: https://www.ncftp.com/ncftp/doc/ncftpget.html

Download a file directly by providing its URL as the sole argument. This is useful for quick downloads from web browsers or newsreaders.

```bash
$ cd /tmp
$ ncftpget ftp://ftp.ncftp.com/pub/ncftp/ncftp.tar.Z
$ zcat ncftp.tar.Z | tar xf -
```

--------------------------------

### Sample NcFTP Client Trace Log

Source: https://www.ncftp.com/ncftp/doc/bug.html

A sample trace log file (`$HOME/.ncftp/trace`) generated by the interactive `ncftp` program. This log captures the entire FTP session dialogue and is essential for bug reports.

```log
SESSION STARTED at:  Wed Aug 27 14:18:41 2003
   Program Version:  NcFTP 3.1.6/102 Aug 25 2003, 08:04 PM
   Library Version:  LibNcFTP 3.1.6 (August 24, 2003)
        Process ID:  1174
          Platform:  linux-x86
          Hostname:  pc.example.com  (rc=3)
          Terminal:  vt100
14:18:41  Fw: firewall.example.com  Type: 0  User: joseph  Pass: ********  Port: 21
14:18:41  FwExceptions: .example.com,localhost,localdomain
14:18:51  > o ftp.example.com

14:18:51  Resolving ftp.example.com...
14:18:51  Connecting to 172.16.75.25...
14:18:51  LibNcFTP 3.1.6 (August 24, 2003) compiled for linux-x86
14:18:51  Uname: Linux|pc|2.4.20|#2 SMP Mon Feb 17 15:36:45 CST 2003|i686
14:18:51  Glibc: 2.2.4 (stable)
14:18:51  Remote server is running wu-ftpd.
14:18:51  Logging in...
14:18:51  220: ftp.example.com FTP server (Version wu-2.6.1-18) ready.
14:18:51  Connected to 172.16.75.25.
14:18:51  Cmd: USER anonymous
14:18:51  331: Guest login ok, send your complete e-mail address as password.
14:18:51  Cmd: PASS joseph@example.com
14:18:51  Logging in...
14:18:51  230: Guest login ok, access restrictions apply.
14:18:51  Cmd: PWD
14:18:51  257: "/" is current directory.
14:18:51  Logged in to 172.16.75.25 as anonymous.
14:19:31  > get secretfile.txt

14:19:31  Cmd: SIZE secretfile.txt
14:19:31  550: secretfile.txt: No such file or directory.
14:19:31  Cmd: PASV
14:19:31  227: Entering Passive Mode (172,16,75,25,49,39)
14:19:31  Cmd: RETR secretfile.txt
14:19:31  550: secretfile.txt: No such file or directory.
14:19:44  > quit

14:19:46  Cmd: QUIT
14:19:46  221: You have transferred 0 bytes in 0 files.
14:19:46       Total traffic for this session was 1011 bytes in 0 transfers.
14:19:46       Thank you for using the FTP service on ftp.example.com.
SESSION ENDED at:    Wed Aug 27 14:19:46 2003
```

--------------------------------

### Open FTP Connection (Anonymous)

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Establishes an FTP control connection to a remote host, logging in anonymously by default.

```bash
open
```

--------------------------------

### Request Specific Remote Server Help

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Sends a help request for a specific FTP command to the remote server.

```bash
rhelp NLST
```

--------------------------------

### Upload Directory Tree

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Recursively uploads an entire directory and its contents to the remote server using the '-R' flag.

```bash
put -R
```

--------------------------------

### Copy Files Using Wildcard

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Copies files matching a wildcard pattern to the remote host, similar to 'mput'.

```bash
put *.zip
```

--------------------------------

### Request Remote Server Help

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Sends a help request to the remote server, potentially listing FTP commands or site administrator info.

```bash
rhelp
```

--------------------------------

### Download File from Remote System

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Copy a file from the currently connected remote system to your local machine. The program displays transfer progress.

```shell
get README.txt
```

--------------------------------

### Run Local chmod Command

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Executes the 'chmod' command on the local host.

```bash
lchmod
```

--------------------------------

### Login with Regular Username

Source: https://www.ncftp.com/ncftp/doc/faq.html

Use the -u option to log in with a specific username instead of anonymous. This is applicable to all NcFTP programs and the 'open' command in the NcFTP shell.

```bash
ncftp -u joeuser ftp.example.com
```

--------------------------------

### Piping Command Output to Remote File with ncftpput

Source: https://www.ncftp.com/ncftp/doc/ncftpput.html

Pipes the output of a local command directly into a remote file. Use the -c option to specify stdin as the input source.

```bash
$ tar cf - / | ncftpput -c sonic.sega.co.jp /usr/local/backup.tar

```

--------------------------------

### List NcFTP Bookmarks

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

The 'bookmarks' command displays the contents of the user's bookmark file, showing saved session configurations. This helps in recalling bookmark names for later use with the 'open' command.

```bash
bookmarks
```

--------------------------------

### Run Local rmdir Command

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Executes the 'rmdir' command on the local host.

```bash
lrmdir
```

--------------------------------

### Print Current Local Directory

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Prints the current working directory on the local machine.

```bash
lpwd
```

--------------------------------

### List Directory Contents with NcFTP

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

The 'dir' command displays a detailed listing of files and directories on the remote server, similar to the 'ls -l' command in UNIX. It supports common 'ls' flags for customized output.

```bash
dir -rt
```

--------------------------------

### Run Local mv Command

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Executes the 'mv' command (rename) on the local host.

```bash
lrename
```

--------------------------------

### Generating Trace Log with ncftpget

Source: https://www.ncftp.com/ncftp/doc/bug.html

Use the `-d` option with `ncftpget` to save the FTP protocol trace to a specified log file. This is crucial for debugging issues with non-interactive commands.

```bash
ncftpget -d /tmp/ncftpget.log ftp.freebsd.org . /pub/FreeBSD/README.TXT
```

--------------------------------

### View NcFTP Background Tasks

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Displays the list of currently executing NcFTP background tasks by running 'ncftpbatch -l'.

```bash
jobs
```

--------------------------------

### List Directory Contents (Pager)

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Commands equivalent to 'dir' and 'ls' that pipe output to a pager, useful for long listings.

```bash
pdir, pls
```

--------------------------------

### List Remote Directory Contents

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Prints a directory listing from the remote system, attempting to mimic 'ls -CF'. Supports standard 'ls' flags when the remote server is UNIX-like.

```bash
ls
```

```bash
ls -rt
```

--------------------------------

### Set NcFTP Configuration Variable

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Sets a program variable, which is saved in $HOME/.ncftp/prefs. Basic syntax is 'set <option> <value>'.

```bash
set <option> <value>
```

--------------------------------

### Download Files from Remote Host

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Copies files from the remote host to the local machine. Supports wildcards and renaming during download.

```bash
get README README.too
```

```bash
get README*
```

```bash
get -z ReadMe.txt README
```

```bash
get -A log.11
```

```bash
get -DD
```

```bash
get -R
```

```bash
get -RT
```

--------------------------------

### Retrieve Entire Directory Tree Recursively

Source: https://www.ncftp.com/ncftp/doc/ncftpget.html

Use the -R flag to download an entire directory tree. This feature requires the remote FTP server to be UNIX-based or emulate UNIX's list output.

```bash
$ ncftpget -R ftp.ncftp.com /tmp /pub/ncftp
```

--------------------------------

### Upload File to Remote System

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Copy a file from your local machine to the currently connected remote system. This is used for uploading files.

```shell
put something.tar
```

--------------------------------

### Upload with Temporary Filename using ncftpput

Source: https://www.ncftp.com/ncftp/doc/ncftpput.html

Uploads a file using a temporary destination pathname that is renamed upon completion. This prevents remote processes from seeing incomplete files. Use the -S option to specify the temporary extension.

```bash
$ ncftpput -S .tmp bowser.nintendo.co.jp /pub/incoming /a/README

```

--------------------------------

### Open FTP Connection with Specific User

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Opens an FTP connection to a specified host using a specific username.

```bash
open -u mario bowser.nintendo.co.jp
```

--------------------------------

### Display Remote File Content with NcFTP

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

The 'cat' command downloads a remote file and displays its content directly to the screen. It's similar to the UNIX 'cat' command but operates on remote files.

```bash
cat
```

--------------------------------

### Machine Readable Directory Listing

Source: https://www.ncftp.com/ncftp/doc/ncftpls.html

The -m flag provides a machine-readable format, ideal for parsing. Note that server support for MLSD is required, and field order may vary.

```bash
$ ncftpls -m ftp://ftp.ncftp.com/ncftp/
type=cdir;modify=20050407005654;UNIX.mode=0755 /ncftp
type=pdir;modify=20010521005346;UNIX.mode=0755 /
type=dir;modify=20050512221217;UNIX.mode=0755 binaries
type=file;size=95832;modify=19971122045900;UNIX.mode=0644 ncftp-1.9.5.tar.gz
type=file;size=192937;modify=19980320033600;UNIX.mode=0644 ncftp-2.4.3.tar.gz
type=file;size=409722;modify=20050325011837;UNIX.mode=0644 ncftp-3.1.9-src.tar.bz2
type=file;size=516060;modify=20050325011837;UNIX.mode=0644 ncftp-3.1.9-src.tar.gz
type=file;size=655834;modify=20050325011837;UNIX.mode=0644 ncftp-3.1.9-src.zip
```

--------------------------------

### Filter Files by Extension (Client-side)

Source: https://www.ncftp.com/ncftp/doc/ncftpls.html

A more reliable method for filtering is to pipe the output to a client-side tool like 'grep', which does not depend on server support.

```bash
$ ncftpls -1 ftp://ftp.freebsd.org/pub/FreeBSD/ | grep -i '\.TXT$'
```

--------------------------------

### Filter Files by Extension (Server-side)

Source: https://www.ncftp.com/ncftp/doc/ncftpls.html

Use the -i flag with a pattern to filter the listing on the server-side. This functionality depends on the FTP server's implementation.

```bash
$ ncftpls -1 -i '*.TXT' ftp://ftp.freebsd.org/pub/FreeBSD/
```

--------------------------------

### Print Remote Working Directory

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Prints the current remote working directory. A portion is also displayed in the shell's prompt.

```bash
pwd
```

--------------------------------

### Change Local Directory

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Changes the current working directory on the local host. Useful for organizing downloaded files.

```bash
lcd
```

--------------------------------

### Connect to Non-Standard Port

Source: https://www.ncftp.com/ncftp/doc/faq.html

Use the -P option to specify a non-standard port when connecting to an FTP server. This applies to all NcFTP programs and the 'open' command within the NcFTP shell.

```bash
ncftp -P 2121 ftp.example.com
```

--------------------------------

### Copy Files to Remote Host

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Copies files from the local host to the remote machine's current working directory.

```bash
put xx.zip yy.zip
```

--------------------------------

### Lookup Host Information

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Performs name service lookups for remote hosts, displaying IP addresses and detailed information with the -v flag.

```bash
lookup cse.unl.edu ftp.cs.unl.edu sphygmomanometer.unl.edu
```

```bash
lookup -v cse.unl.edu ftp.cs.unl.edu
```

```bash
lookup 129.93.33.24
```

--------------------------------

### Enable Passive Mode in NCFTP

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Use this command within an NCFTP prompt to enable passive mode, which can help bypass firewalls that block incoming connections.

```bash
set passive yes
```

--------------------------------

### Open Remote System Connection

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Connect to a remote FTP server using its symbolic name or IP address. Symbolic names are preferred as IP addresses may change.

```shell
open typhoon.unl.edu
open 129.93.33.24
```

--------------------------------

### Remote ls -l Listing

Source: https://www.ncftp.com/ncftp/doc/ncftpls.html

Use the -l flag to perform a remote 'ls -l' command, providing detailed file information.

```bash
ncftpls -l
```

--------------------------------

### Run Local rm Command

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Executes the 'rm' command (remove) on the local host.

```bash
lrm
```

--------------------------------

### Set Binary Transfer Mode in NcFTP

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

The 'binary' command sets the file transfer mode to raw binary, which is the default. This ensures no data translation occurs during transfers, suitable for all file types.

```bash
binary
```

--------------------------------

### Enable Debugging Mode in NcFTP

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

The 'debug' command enables debugging mode, which displays detailed communication messages between NcFTP and the server. This is useful for troubleshooting and bug reporting.

```bash
debug 1
```

--------------------------------

### Change Transfer Types with type

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Use the 'type' command to change file transfer modes between ASCII and binary. 'ascii' is equivalent to 'type a', and 'binary' is equivalent to 'type i' or 'type b'.

```bash
type ascii
```

```bash
type binary
```

```bash
type image
```

--------------------------------

### Copy File with Different Remote Name

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Uploads a local file and renames it on the remote server using the '-z' flag.

```bash
put -z ncftpd-2.0.6.tar.gz NFTPD206.TGZ
```

--------------------------------

### Send Direct FTP Command

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Sends a direct FTP Protocol command to the remote server. Generally not for average users.

```bash
quote
```

--------------------------------

### Browse Remote File

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Allows browsing a remote file one page at a time using the local PAGER program without downloading.

```bash
page
```

--------------------------------

### Edit Remote File Locally

Source: https://www.ncftp.com/ncftp/doc/ncftp.html

Downloads a remote file to a temporary local file for editing, then uploads the modified file back to the remote host.

```bash
edit
```
Tokens:
Raw