Node:Keywords, Next:Prompt codes, Up:Configuration

Keywords

The configuration file consists of keywords with an argument, separated with a space. There are three types of arguments: strings, booleans and integers. Strings must be enclosed in quotes if they contains spaces. Boolean arguments can be written as 0/1, true/false or on/off. The keywords are case insensitive.

These are the supported keywords:

anon_password

type: string

This is the password used for anonymous logins. It should be your email address.

autologin

type: boolean

Setting this to true will cause yafc to attempt to login automatically. Information for doing this is specified by See Bookmarks.

autoreconnect

type: boolean

If this option is true, yafc will try to reconnect the currently open connection if it has timed out. The directory cache is retained after a successful reconnect.

quit_on_eof

type: boolean

Quits yafc on end-of-file (usually Ctrl-D).

read_netrc

type: boolean

Read additional autologin entries from ~/.netrc. Bookmarks.

use_passive_mode

type: boolean

If true, use passive mode data connections. You might have to do this if you are behind a proxy.

reverse_dns

type: boolean

If this option is true, IP addresses will be reverse looked up in the DNS for a hostname, which can be slow. Set to false to skip this.

waiting_dots

type: boolean

If this option is true, filenames will be completed with ... while waiting for the directory listing to be downloaded.

cache_timeout

type: integer

Time (in seconds) before a cached directory times out and needs to be reread. Set to 0 (zero) to disable the timeout.

verbose

type: boolean

Show all replies received from remote host.

debug

type: boolean

Show exactly what is going on. Prints all FTP commands sent to remote host and all replies received, including response code.

trace

type: string

Create trace files in ~/.yafc/trace/trace.<pid>.

ssh_program

type: string

Path to local ssh program which will be used in SSH2 connections. Note that only SSH version 2 is supported.

sftp_server_program

type: string

Path to remote sftp-server program. Leave commented to use the sftp subsystem. See also open.

inhibit_startup_syst

type: boolean

Set to true to skip query of remote system on connect.

use_env_string

type: boolean

Alter the environment strings to reflect what Yafc is doing. This information can be seen with the shell command ps.

remote_completion

type: boolean

Use tab to complete remote files. Yeahh.

auto_bookmark

type: yes/no/ask

If set to yes, Yafc automatically creates a bookmarks for the site when the connection is closed. Setting this to ask, makes Yafc to ask if to create the bookmark.

The bookmark is given an appropriate aliases name.

auto_bookmark_save_password

type: boolean

If set to yes, Yafc don't ask whether to save passwords in the bookmarks file. Anonymous password, though, are always saved.

Passwords in the bookmarks file are stored either as clear text or base64-encoded. Be sure the file is not world readable (chmod 0600 bookmarks.)

auto_bookmark_silent

type: boolean

If set to true, Yafc won't say anything about automatically created bookmarks.

default_type

type: string

Specifies the default type used for file transfers, either binary or ascii. Setting this to ascii can mess up binary files (ascii mode rewrites the end-of-line characters).

default_mechanism

type: string

This option specifies which security mechanisms to try, in given order. It is a colon-separated string, supported values are "krb4", "krb5" and "none". Example: default_mechanism "krb4:krb5"

ascii_transfer_mask

type: string

Filenames matching any of these filemasks are always transferred in ascii mode, regardless of the value of the default_type keyword. This can be overridden with the --type option to get/put.

Masks are separated by colons (eg. *.ext1:*.ext2:filename*) and are case sensitive.

Preferrably used with default_type set to binary.

beep_after_long_command

type: boolean

Beep after a long command is finished. Use long_command_time to specify how long a long command is.

long_command_time

type: integer

Number of seconds for command to become long

command_timeout

type: integer

How long (in seconds) before aborting a command without response.

connection_timeout

type: integer

How long (in seconds) before aborting a connection without response.

connect_attempts

type: integer

Number of times to try to re-connect if login failed (due to busy server.) Use the value -1 for unlimited number of tries, and 0 to disable this feature.

connect_wait_time

type: integer

Number of seconds to wait between connection attempts.

use_history

type: boolean

Save and load history lines in ~/.yafc/history. This is a no-op if not compiled with Readline.

history_max

type: integer

Max number of history lines to save in the history file. This is a no-op if not compiled with Readline.

startup_local_directory

type: string

Yafc will change to this (local) directory upon startup.

nohup_mailaddress

type: string

If set, Yafc sends mail to this address when nohup transfers are finished. Nohup transfers.

sendmail_path

type: string

Complete path to sendmail used by nohup_mailaddress above.

prompt1

type: string

This prompt is printed when no connection is established.

See Prompt codes.

You can put escape codes here, for example if you want a colored prompt "%{\e[01;31m%}ftp%{\e[0m%}" will be "ftp" in red, if your terminal supports ISO 6429 (ANSI) color codes. Colors.

prompt2

type: string

connected but not logged in.

prompt3

type: string

connected and logged in

transfer_begin_string

type: string

This string is printed before the actual transfer begins.

These strings are printed with the --verbose option to get/put. Transfer codes for special character codes that can be used in this string to show dynamic information.

transfer_string

type: string

This string is printed (approx.) every second or so during the transfer with a trailing carriage return. Transfer codes for special character codes that can be used in this string to show dynamic information.

transfer_end_string

type: string

This string is printed when the transfer is finished. Transfer codes for special character codes that can be used in this string to show dynamic information.

transfer_xterm_string

type: string

This string is printed at the same time transfer_string is printed, if the current $TERM variable is defined in xterm_title_terms. This string can be used to reflect dynamic information about the current transfer in the title bar of an Xterm. Transfer codes for special character codes that can be used in this string to show dynamic information.

tilde

type: boolean

Display ~ instead of full home directory path for various commands.

xterm_title1

type: string

Xterm window titles

same codes as for the prompts, see See Prompt codes.

This is an excerpt from the Xterm-title mini-HOWTO:

Many people find it useful to set the title of a terminal to reflect dynamic information, such as the name of the host the user is logged into, the current working directory, etc.

This may be done by using XTerm escape sequences. The following sequences are useful in this respect:

ESC]0;_string_BEL

Set icon name and window title to _string_

ESC]1;_string_BEL

Set icon name to _string_

ESC]2;_string_BEL

Set window title to _string_

where ESC is the _escape_ character (\033), and BEL is the _bell_ character (\007).

_Note_: these sequences apply to most xterm derivatives, such as nxterm, color-xterm and rxvt. Other terminal types often use different escapes; see the appendix for examples. For the full list of xterm escape sequences see the file ctlseq2.txt, which comes with the xterm distribution, or xterm.seq, which comes with the rxvt distribution.

These escapes really need to be applied every time the prompt changes. This way the string is updated with every command you issue and can keep track of information such as current working directory, username, hostname, etc.

Example: xterm_title1 "\e]0;Yafc\x07" sets the xterm window title and icon name to Yafc.

xterm_title2

type: string

Example: xterm_title1 "\e]0:Yafc - %h\x07" sets the xterm window title and icon name to Yafc - hostname.

xterm_title3

type: string

Example: xterm_title1 "\e]0;Yafc - %u@%h:%~\x07" sets the xterm window title and icon name to Yafc - user@hostname:directory.

xterm_title_terms

type: string

List of $TERM's, separated with spaces, which can handle xterm escape sequences.