3. The shell

Yafc presents the user with an internal shell. Command redirection is available, using the conventional shell syntax (eg cat foo.txt > foo will copy the remote file foo.txt to the local file foo.) Input redirection, however, is not supported. Also asynchronous mode is not supported. The following will thus be rejected: ls |emacs & or open < login.foo.

3.1 Yafc commands		all yafc internal commands
3.2 Nohup transfers

3.1 Yafc commands

All commands follow the usual GNU command line syntax, with long options starting with two dashes (`--').

Most commands have an option `--help' that shows a short syntax description.

3.1.1 !		execute shell command
3.1.2 afslog		obtain remote AFS tokens
3.1.3 alias		create an alias
3.1.4 bookmark		create a bookmark
3.1.5 cache		control directory cache
3.1.6 cat		view a text file
3.1.7 cd		change working directory
3.1.8 cdup		change to parent directory
3.1.9 chmod		change access mode (permissions) of files
3.1.10 close		close connection
3.1.11 copyright		show copyright notice
3.1.12 filetime		print file modification time
3.1.13 flush		flush replies
3.1.14 fxp		transfer files between hosts
3.1.15 get		get files
3.1.16 help		don't panic
3.1.17 idle		modify idle time
3.1.18 kauth		authenticate to Kerberos
3.1.19 kdestroy		destroy Kerberos tickets
3.1.20 klist		list Kerberos tickets
3.1.21 krbtkfile		specify Kerberos ticket file
3.1.22 lcd		change local working directory
3.1.23 list		show raw directory listing
3.1.24 lpwd		print local working directory
3.1.25 ls		show directory listing
3.1.26 ltag		tag local files
3.1.27 luntag		remove files from local taglist
3.1.28 mkdir		create directory
3.1.29 mv		move files
3.1.30 nlist		show filename list
3.1.31 nop		do nothing
3.1.32 open		open a connection
3.1.33 prot		change Kerberos data protection level
3.1.34 put		put files
3.1.35 pwd		print working directory
3.1.36 quit		quit Yafc
3.1.37 quote		send arbitrary FTP command
3.1.38 reopen		reopen active connection
3.1.39 rhelp		remote help
3.1.40 rm		remove files
3.1.41 rmdir		remove empty directory
3.1.42 rstatus		show status
3.1.43 set		show and set variables
3.1.44 shell		execute local shell
3.1.45 site		issue a site specific FTP command
3.1.46 source		read a configuration file
3.1.47 status		show local status
3.1.48 switch		switch between open connections
3.1.49 system		show type of system
3.1.50 tag		tag files
3.1.51 unalias		remove an alias
3.1.52 untag		remove files from taglist
3.1.53 url		print the current FTP url
3.1.54 user		send new user information
3.1.55 version		show Yafc version
3.1.56 warranty		show lack of warranty

3.1.1 !

3.1.2 afslog

3.1.3 alias

3.1.4 bookmark

Usage:

bookmark [options] [bookmark name ...]

Options:

`-s[FILE]'

`--save[=FILE]'

Save bookmarks in memory to file. If the optional parameter FILE is omitted, save to default bookmarks file `workdir/bookmarks'.

`-e'

`--edit'

Start editor (found in $EDITOR environment variable) with your bookmarks file.

`-r[FILE]'

`--read[=FILE]'

Read bookmarks from bookmarks file, or file given by optional parameter FILE.

`-d'

`--delete'

Delete bookmarks given as arguments to bookmark. The bookmarks file will be rewritten.

`-l'

`--list'

List bookmarks in memory.

`-h'

`--help'

Show short syntax description.

3.1.5 cache

Control the directory cache.

Usage:

cache [options] [directory ...]

Options:

`-c'

`--clear'

Clear the whole directory cache.

`-l'

`--list'

List the contents of the directory cache.

`-t'

`--touch'

Remove the specified directories from the cache. If no directories are given as arguments, the current directory is removed from the cache.

`-h'

`--help'

Show a short help description.

3.1.6 cat

Usage:

cat [options] file ...

Options:

`-t TYPE'

`--type=TYPE'

Set transfer type. Valid values for TYPE is ascii or binary.

`-h'

`--help'

Show a short help description

3.1.7 cd

Usage:

cd [directory]

If no argument is given, cd changes to the home directory. The home directory is the current directory when logged in.

If the argument is '-', cd changes to the previous working directory.

3.1.8 cdup

3.1.9 chmod

Usage:

chmod mode file ...

Mode must be given in octal representation (for example: 0644 is -rw-r--r---).

3.1.10 close

3.1.11 copyright

3.1.12 filetime

3.1.13 flush

3.1.14 fxp

This will not always work with all ftp servers, either because passive mode is not supported on the source host, or because the target refuses the given port. The target ftp server might refuse the port as a security policy. You might get the error 'Illegal PORT Command' or 'Possible port theft'.

If the destination file already exists, and none of the options `--append', `--force', `--newer', `--resume', `--skip-existing' or `--unique' is given, you will be prompted what to do.

Usage:

fxp [options] file ...

Options:

`-a'

`--append'

Append if destination exists.

`-D'

`--delete-after'

Delete remote file after successful transfer.

`--dir-mask=GLOB'

Enter only directories matching GLOB pattern.

`--dir-rx-mask=REGEXP'

Enter only directories matching REGEXP pattern.

`-f'

`--force'

Overwrite existing destinations, never prompt.

`-H'

`--nohup'

Transfer files in background (nohup mode), quits yafc.

`-i'

`--interactive'

Prompt before each transfer.

`-L FILE'

`--logfile=FILE'

Use FILE as logfile instead of `~/.yafc/nohup/nohup.<pid>'.

`-m GLOB'

`--mask=GLOB'

Only transfer files matching GLOB pattern.

`-M REGEXP'

`--rx-mask=REGEXP'

Only transfer files matching REGEXP pattern.

`-n'

`--newer'

Only transfer file if remote is newer than local file.

`-o DEST'

`--output=DEST'

Specify other destination. If more than one file is transferred, or option `--recursive' is given, DEST denotes a directory. Otherwise (if only one file is to be transferred), DEST denotes a filename.

Examples:

fxp --target=2 foo.tar.gz -o bar.tar.gz

will transfer the remote file `foo.tar.gz' on the currently active remote server to the remote file `bar.tar.gz' on the remote server specified with the `--target' option (in this case the second open connection).

fxp --target=funet *.tar.gz -o foo

will transfer all remote `*.tar.gz' files to a directory named `foo' on the host specified with the `--target' option (in this case 'funet').

fxp -T ftp.stacken.kth.se foo -r -o bar

will transfer the remote file `foo' to a directory named `bar' on ftp.stacken.kth.se. If `foo' is a directory, it will be downloaded recursively.

`-p'

`--preserve'

Try to preserve file attributes.

`-P'

`--parents'

Append source path to destination.

`-q'

`--quiet'

Overrides `--verbose'.

`-r'

`--recursive'

Transfer directories recursively.

`-R'

`--resume'

Resume broken download (restart at EOF).

`-s'

`--skip-existing'

Always skip existing files.

`-t'

`--tagged'

Transfer tagged files.

`-T HOST'

`--target=HOST'

This option is required and specifies which remote server is the target. The HOST parameter can be a complete hostname, an alias or the connection number. The connection number is 1 for the first open connection, 2 for the second and so on. It might be useful to include that information in the prompt using the `%C' code, See section 4.2 Prompt codes.

`--type=TYPE'

Specify transfer type, 'ascii' or 'binary'.

`-u'

`--unique'

Always store as unique target file.

`-v'

`--verbose'

Explain what is being done.

`--help'

Show a short syntax description.

3.1.15 get

Transfer files from remote server to local computer.

If the destination file already exists, and none of the options `--append', `--force', `--newer', `--resume', `--skip-existing' or `--unique' is given, you will be prompted what to do.

Usage:

get [options] file ...

Options:

`-a'

`--append'

Append if destination exists.

`-c PERM'

`--chmod=PERM'

Change mode of transferred files to PERM.

`--chgrp=GROUP'

change group of transferred files to GROUP. You need to be a member of GROUP.

`-d'

`--no-dereference'

Copy symbolic links as symbolic links.

`-D'

`--delete-after'

Delete remote file after successful transfer.

`--dir-mask=GLOB'

Enter only directories matching GLOB pattern.

`--dir-rx-mask=REGEXP'

Enter only directories matching REGEXP pattern.

`-f'

`--force'

Overwrite existing destinations, never prompt.

`-H'

`--nohup'

Transfer files in background (nohup mode), quits yafc.

`-i'

`--interactive'

Prompt before each transfer.

`-L FILE'

`--logfile=FILE'

Use FILE as logfile instead of `~/.yafc/nohup/nohup.<pid>'.

`-m GLOB'

`--mask=GLOB'

Only get files matching GLOB pattern.

`-M REGEXP'

`--rx-mask=REGEXP'

Only get files matching REGEXP pattern.

`-n'

`--newer'

Only get file if remote is newer than local file.

`-o DEST'

`--output=DEST'

Specify other destination. If more than one file is transferred, or option `--recursive' is given, DEST denotes a directory. Otherwise (if only one file is to be transferred), DEST denotes a filename.

Examples:

get foo.tar.gz -o bar.tar.gz

will transfer the remote file `foo.tar.gz' to the local file `bar.tar.gz'.

get *.tar.gz -o foo

will transfer all remote `*.tar.gz' files to a local directory named `foo'.

get foo -r -o bar

will transfer the remote file `foo' to a local directory named `bar'. If `foo' is a directory, it will be downloaded recursively.

`-p'

`--preserve'

Try to preserve file attributes and timestamps.

`-P'

`--parents'

Append source path to destination.

`-q'

`--quiet'

Overrides `--verbose'.

`-r'

`--recursive'

Get directories recursively.

`-R'

`--resume'

Resume broken download (restart at EOF).

`-s'

`--skip-existing'

Always skip existing files.

`-t'

`--tagged'

Transfer tagged files.

`--type=TYPE'

Specify transfer type, 'ascii' or 'binary'.

`-u'

`--unique'

Always store as unique local file.

`-v'

`--verbose'

Explain what is being done.

`--help'

Show a short syntax description.

3.1.16 help

3.1.17 idle

3.1.18 kauth

3.1.19 kdestroy

3.1.20 klist

3.1.21 krbtkfile

3.1.22 lcd

3.1.23 list

3.1.24 lpwd

3.1.25 ls

Usage:

ls [options] [files ...]

Options:

`-a'

`--all'

Do not hide entries starting with '.'.

`-A'

`--almost-all'

As `--all', but do not list . and ..

`-B'

`--ignore-backups'

Do not list implied entries ending with ~.

`-C'

List entries by columns.

`--color[=WHEN]'

Control whether color is used to distinguish file types. WHEN may be either never, always or auto. If WHEN is not given, default is always. If the argument is auto, colors will be used only if output is bound to a tty.

`-d'

`--directory'

List directory entries instead of contents.

`--dirs-first'

Show directories first (last with `--reverse').

`-F'

`--classify'

Append a character for typing each entry.

`-g'

Ignored.

`-G'

`--no-group'

Inhibit display of group information.

`-h'

`--human-readable'

Print sizes in human readable format (e.g. 1K, 234M, 2G)

`-l'

Use a long listing format.

`-N'

`--literal'

Print raw entry names (don't treat control characters specially)

`-o'

Use a long listing format without group info. Same as `-lG'.

`-r'

`--reverse'

Reverse order while sorting.

`-R'

`--recursive'

List subdirectories recursively.

`-S'

Sort by file size

`-t'

Sort by modification time.

`-U'

Do not sort; list entries in directory order.

`-x'

List entries by lines instead of by columns.

`-X'

Sort alphabetically by entry extension.

`-1'

List one file per line.

`--help'

Show a short syntax description.

3.1.26 ltag

3.1.27 luntag

3.1.28 mkdir

Usage:

mkdir directory

3.1.29 mv

3.1.30 nlist

3.1.31 nop

3.1.32 open

Opens a new connection to an FTP server.

Usage: open [options] [proto://][user[:password]@]hostname[:port][/directory] ...

proto can be either 'ftp' or 'ssh'

Options:

`-a'

`--anon'

Try to login anonymously.

`-u'

`--noauto'

Disable autologin.

`-U'

`--noalias'

Disable bookmark alias lookup and abbreviation.

`-m MECH'

`--mechanism=MECH'

Try security mechanism MECH when logging in. This will override any 'mech' options in `yafcrc' or `bookmarks'. MECH is a colon-separated string, supported values are "krb4", "krb5" and "none". The mechanisms are tried in the order specified.

`-s PATH'

`--sftp=PATH'

Specify path to the remote sftp-server program. SSH starts this program on the remote side when initiating an sftp connection. This option is only necessary if the remote ssh server doesn't understand the sftp subsystem.

Specify `--sftp=""' to disable the sftp-server path, and use sftp subsystem instead.

If you don't know the remote path to the sftp-server program, the default for OpenSSH is `/usr/libexec/sftp-server'. Another common path is `/usr/bin/sftp-server'.

`--help'

Show a short syntax description.

3.1.33 prot

Changes the data protection level for data transfers. The protection level defines how data transfers are handled by the security mechanism.

Usage:

prot [options] [command | data] protlevel

Options:

`-h'

`--help'

Show short syntax description.

Valid protection levels are:

clear

no data protection

safe

integrity check

private

all data encrypted and integrity checked

3.1.34 put

If the destination file already exists, and none of the options `--append', `--force', `--newer', `--resume', `--skip-existing' or `--unique' is given, you will be prompted what to do.

Usage:

put [options] file ...

Options:

`-a'

`--append'

Append if destination file exists.

`-D'

`--delete-after'

Delete local file after successful transfer.

`--dir-mask=GLOB'

Enter only directories matching GLOB pattern.

`--dir-rx-mask=REGEXP'

Enter only directories matching REGEXP pattern.

`-f'

`--force'

Overwrite existing destinations, never prompt.

`-H'

`--nohup'

Transfer files in background (nohup mode), quits yafc.

`-i'

`--interactive'

Prompt before transferring each file.

`-L FILE'

`--logfile=FILE'

Use FILE as logfile instead of `~/.yafc/nohup/nohup.<pid>' for nohup transfers.

`-m GLOB'

`--mask=GLOB'

Only put files matching GLOB pattern.

`-M REGEXP'

`--rx-mask=REGEXP'

Only put files matching REGEXP pattern.

`-n'

`--newer'

Only transfer file if local is newer than remote file.

`-o DEST'

`--output=DEST'

Specify other destination. If more than one file is transferred, or option `--recursive' is given, DEST denotes a directory. Otherwise (if only one file is to be transferred), DEST denotes a filename.

Examples:

put foo.tar.gz -o bar.tar.gz

will transfer the local file `foo.tar.gz' to the remote file `bar.tar.gz'.

put *.tar.gz -o foo

will transfer all local `*.tar.gz' files to a remote directory named `foo'.

put foo -r -o bar

will transfer the local file `foo' to a remote directory named `bar'. If `foo' is a directory, it will be uploaded recursively.

`-p'

`--preserve'

Try to preserve file attributes (permissions).

`-P'

`--parents'

Append source path to destination.

`-q'

`--quiet'

Overrides `--verbose'.

`-r'

`--recursive'

Upload directories recursively.

`-R'

`--resume'

Resume broken transfer (restart at EOF).

`-s'

`--skip-existing'

Always skip existing files.

`-t'

`--tagged'

Transfer (locally) tagged files.

`--type=TYPE'

Specify transfer type, 'ascii' or 'binary'.

`-u'

`--unique'

Always store as unique file (if server supports the STOU command).

`-v'

`--verbose'

Explain what is being done.

`--help'

Show a short syntax description.

3.1.35 pwd

Prints the current remote working directory.

Usage: pwd

3.1.36 quit

3.1.37 quote

3.1.38 reopen

Reopen a timed out connection.

3.1.39 rhelp

3.1.40 rm

Remove files on remote server.

Usage: rm [options] file...

Options:

`-f'

`--force'

never prompt

`-i'

`--interactive'

prompt before any removal

`-r'

`--recursive'

remove the contents of directories recursively. CAREFUL!

`-t'

`--tagged'

remove tagged files

`-v'

`--verbose'

explain what is being done

`--help'

display help

3.1.41 rmdir

3.1.42 rstatus

3.1.43 set

3.1.44 shell

3.1.45 site

Usage:

site command

Try site help or rhelp site for more information

3.1.46 source

3.1.47 status

3.1.48 switch

Usage:

switch [options] [connection]

Options:

`-h'

`--help'

Show short syntax description.

The connection argument specifies which connection to switch to. It can be specified either as the connection number or with the name (hostname or alias).

If no argument is given, switch to the next open connection.

3.1.49 system

3.1.50 tag

Usage:

tag [options] file ...

Options:

`-c'

`--clear'

Clear the taglist.

`-i'

`--info'

Show some information about the tagged files. This includes the total size of all tagged file, how many files and how many directories are tagged.

`-l'

`--list'

List tagged files.

`-L[FILE]'

`--load[=FILE]'

Load saved taglist file. If optional parameter FILE is omitted, the taglist for this host is loaded (from the file `workdir/taglist.hostname').

`-s[FILE]'

`--save[=FILE]'

Save taglist to file. If optional parameter fILE is omitted, the taglist is saved in the default file `workdir/taglist.hostname'.

`-h'

`--help'

Show short syntax description.

3.1.51 unalias

3.1.52 untag

3.1.53 url

Usage:

url [options]

Options:

`-e'

`--no-encoding'

Don't encode the URL as RFC1738 says.

`-h'

`--help'

Show short syntax description.

3.1.54 user

3.1.55 version

3.1.56 warranty

3.2 Nohup transfers

get and put has an option `--nohup'. When given, Yafc will fork itself to the background and continue to transfer the specified files, allowing you to use your shell or even logout. Output is redirected to the file `~/.yafc/nohup/nohup.pid', or to file specified by option `--logfile=FILE'. If you have tagged any files (with the tag command, see 3.1.50 tag), add the option `--tagged' to the get command to transfer those files too. There is an equivalent command for local files and put, namely ltag.

Yafc will also enter nohup mode upon receipt of SIGHUP.

Set nohup_mailaddress in the yafcrc file to a valid mail address if you want to receive a mail notifying you when the transfer is complete.