@c This file is automatically created from ``fntable.fn''; don't change
@c this file, change ``fntable.fn'' instead.

@c *********************************************************************
@node	 Functions
@chapter Functions

@menu
* Basic Functions::	
* Scrolling Functions::	
* Selection Functions::	
* Tagging Functions::	

All Functions Alphabetically
* bind::		bind key
* cd::			change directory
* clear-tags::		clear all tags
* colon::		execute cftp command
* deidle::		deidle connection
* down::		move cursor N lines down (default: 1)
* enter::		enter directory
* enter/get::		enter directory or get file
* enter/view::		enter directory or view file
* exit::		exit cftp
* get::			get file
* get-tags::		get tagged files
* goto::		goto line N (default: last)
* help::		display help
* isearch::		incremental search
* lcd::			change directory on local host
* leave::		leave current directory
* leave-tag::		leave @code{<tag>} state
* load-tags::		load tag list from file
* page-down::		move N screens down (default: 1)
* page-up::		move N screens up (default: 1)
* pipe::		pipe file to command
* prefix::		prefix digit
* put::			put file
* reconnect::		reconnect to server
* redraw::		redraw screen
* reload::		reload current directory
* response::		display dialog with server
* save-tags::		save tag list to file
* save-urls::		save tags as url list
* set::			set option
* shell::		shell escape
* show-name::		show name of file under cursor
* state::		change binding state
* tag::			tag/untag file for later download
* up::			move cursor N lines up (default: 1)
* version::		display version number
* view::		view file
@end menu


@c =====================================================================
@node Basic Functions
@section Basic Functions
@cindex Basic Functions

@menu
* exit::		exit cftp
* version::		display version number
* redraw::		redraw screen
* show-name::		show name of file under cursor
* help::		display help
* lcd::			change directory on local host
* shell::		shell escape
* colon::		execute cftp command
* deidle::		deidle connection
* reconnect::		reconnect to server
* response::		display dialog with server
* prefix::		prefix digit
* bind::		bind key
* set::			set option
@end menu

@c ---------------------------------------------------------------------
@node exit
@subsection exit -- exit cftp
@cindex exit

@itemize @bullet
@item
Synopsis: exit [-f]
@end itemize

Close the connection to the remote server and exit @sc{cftp}; if you
have tagged files, @sc{cftp} asks for confirmation (unless the
-f option is given).

@c ---------------------------------------------------------------------
@node version
@subsection version -- display version number
@cindex version

@itemize @bullet
@item
Synopsis: version 
@end itemize

Display the @sc{cftp} version string.

@c ---------------------------------------------------------------------
@node redraw
@subsection redraw -- redraw screen
@cindex redraw

@itemize @bullet
@item
Synopsis: redraw [-c]
@end itemize

Clear and redraw the screen.

Use this function if something messed up your display.  If @code{-c}
is given (as it is in the default bindings), the cursor is centered on
the screen.

@c ---------------------------------------------------------------------
@node show-name
@subsection show-name -- show name of file under cursor
@cindex show-name

@itemize @bullet
@item
Synopsis: show-name 
@end itemize

Display the name of the file under the cursor in the message area.

@c ---------------------------------------------------------------------
@node help
@subsection help -- display help
@cindex help

@itemize @bullet
@item
Synopsis: help 
@end itemize

Display help on a function or option, or the binding of a key.

Asks if you want help on a function, option or key binding.  For
functions, their help string is displayed.  Help on an option shows
its short name (e. g., 'mo' for mode), its type (boolean, character,
integer, string, or enum), its current value and help string.  For key
bindings, @code{help} displays the function with arguments (if any),
as it is executed when you press the key.

If you press the shifted letter for a category, a list of all
functions, options, or key bindings will be displayed.

@c ---------------------------------------------------------------------
@node lcd
@subsection lcd -- change directory on local host
@cindex lcd

@itemize @bullet
@item
Synopsis: lcd [dir]
@end itemize

Change the current directory on your local host; if you don't supply
@var{dir}, you will be prompted for it.  The new current directory is
printed.

@c ---------------------------------------------------------------------
@node shell
@subsection shell -- shell escape
@cindex shell

@itemize @bullet
@item
Synopsis: shell [cmd arg @dots{}]
@end itemize

Execute shell command; if no command is given, you are prompted for
it.  Enter empty string to get an interactive shell.

@c ---------------------------------------------------------------------
@node colon
@subsection colon -- execute cftp command
@cindex colon

@itemize @bullet
@item
Synopsis: colon [args @dots{}]
@end itemize

Execute an arbitrary @sc{cftp} command.

Allows you to execute functions not bound to a key.


@c ---------------------------------------------------------------------
@node deidle
@subsection deidle -- deidle connection
@cindex deidle

@itemize @bullet
@item
Synopsis: deidle 
@end itemize

Send a @code{noop} to ftp server, thus resetting idle time on server.

This prevents the server from logging you out due to timeouts.  Since
@sc{cftp} caches directory listings, a timeout can occur even while
you're actively using @sc{cftp}.

@c ---------------------------------------------------------------------
@node reconnect
@subsection reconnect -- reconnect to server
@cindex reconnect

@itemize @bullet
@item
Synopsis: reconnect 
@end itemize

Reopen connection to server.

You can use this function when you were disconnected after a timeout
or network hickup.  To prevent timeouts, use @ref{deidle}.

@c ---------------------------------------------------------------------
@node response
@subsection response -- display dialog with server
@cindex response

@itemize @bullet
@item
Synopsis: response 
@end itemize

Display a log of @sc{cftp}'s communication with the remote host. 

Commands sent by @sc{cftp} and the responses from the remote host are
kept in a log, with commands prefixed with @samp{->}.  You can change
the number of lines to keep in the log with the option
@ref{hist-size}.

@c ---------------------------------------------------------------------
@node prefix
@subsection prefix -- prefix digit
@cindex prefix

@itemize @bullet
@item
Synopsis: prefix 
@end itemize

Enter a digit of the prefix argument for another command.
@c XXX: ref to the prefix chapter


@c ---------------------------------------------------------------------
@node bind
@subsection bind -- bind key
@cindex bind

@itemize @bullet
@item
Synopsis: bind [<state>]key [cmd [args @dots{}]]
@end itemize

Change binding for @var{key}.  

If @var{cmd} (the command) is omitted, remove the key binding.
@var{<state>} specifies the binding state and defaults to
@c XXX: ref to binding state 
@code{<global>}.  This command is mainly used in the @ref{cftprc}.

@c ---------------------------------------------------------------------
@node set
@subsection set -- set option
@cindex set

@itemize @bullet
@item
Synopsis: set [option [value]]
@end itemize

Set @var{option} to @var{value}.

If either @var{value} or @var{option} and @var{value} are omitted, you
will be asked for them.  If you enter an empty string the command will
be cancelled.


@c =====================================================================
@node Scrolling Functions
@section Scrolling Functions
@cindex Scrolling Functions

@menu
* down::		move cursor N lines down (default: 1)
* up::			move cursor N lines up (default: 1)
* page-down::		move N screens down (default: 1)
* page-up::		move N screens up (default: 1)
* goto::		goto line N (default: last)
* isearch::		incremental search
@end menu

@c ---------------------------------------------------------------------
@node down
@subsection down -- move cursor N lines down (default: 1)
@cindex down

@itemize @bullet
@item
Synopsis: down [@var{n}]
@end itemize

Move cursor down @var{n} lines, wrapping around at the bottom.

@var{n} can be a prefix argument.

@c ---------------------------------------------------------------------
@node up
@subsection up -- move cursor N lines up (default: 1)
@cindex up

@itemize @bullet
@item
Synopsis: up [@var{n}]
@end itemize

Move cursor up @var{n} lines, wrapping around at the top.  

@var{n} can be a prefix argument.

@c ---------------------------------------------------------------------
@node page-down
@subsection page-down -- move N screens down (default: 1)
@cindex page-down

@itemize @bullet
@item
Synopsis: page-down [@var{n}]
@end itemize

Move down @var{n} screens, placing the cursor at the top of the
screen. Wrap around to the first line if at the last screen.  

@var{n} can be a prefix argument.

@c ---------------------------------------------------------------------
@node page-up
@subsection page-up -- move N screens up (default: 1)
@cindex page-up

@itemize @bullet
@item
Synopsis: page-up [@var{n}]
@end itemize

Move up @var{n} screens, placing the cursor at the top of the
screen. Wrap around to the last screen if at the first line.  

@var{n} can be a prefix argument.

@c ---------------------------------------------------------------------
@node goto
@subsection goto -- goto line N (default: last)
@cindex goto

@itemize @bullet
@item
Synopsis: goto [@var{n}]
@end itemize

Move cursor to line @var{n}.

@var{n} can be a prefix argument.  If line @var{n} doesn't exist or
@var{n} is zero, the cursor moves to the last line.

@c ---------------------------------------------------------------------
@node isearch
@subsection isearch -- incremental search
@cindex isearch

@itemize @bullet
@item
Synopsis: isearch 
@end itemize

Search directory listing incrementally.
@c XXX: genau beschreiben :-)



@c =====================================================================
@node Selection Functions
@section Selection Functions
@cindex Selection Functions

@menu
* enter/get::		enter directory or get file
* enter/view::		enter directory or view file
* enter::		enter directory
* reload::		reload current directory
* get::			get file
* view::		view file
* pipe::		pipe file to command
* put::			put file
* leave::		leave current directory
* cd::			change directory
* state::		change binding state
* leave-tag::		leave @code{<tag>} state
@end menu

@c ---------------------------------------------------------------------
@node enter/get
@subsection enter/get -- enter directory or get file
@cindex enter/get

@itemize @bullet
@item
Synopsis: enter/get [file]
@end itemize

Enter directory or get file; default is file/directory at cursor.

@c ---------------------------------------------------------------------
@node enter/view
@subsection enter/view -- enter directory or view file
@cindex enter/view

@itemize @bullet
@item
Synopsis: enter/view [file]
@end itemize

Enter directory or view file; default is file under cursor.

@c ---------------------------------------------------------------------
@node enter
@subsection enter -- enter directory
@cindex enter

@itemize @bullet
@item
Synopsis: enter [file]
@end itemize

Enter directory; default is directory under cursor.

@c ---------------------------------------------------------------------
@node reload
@subsection reload -- reload current directory
@cindex reload

@itemize @bullet
@item
Synopsis: reload 
@end itemize

Reload listing of current directory from server, disregarding cache.

@c ---------------------------------------------------------------------
@node get
@subsection get -- get file
@cindex get

@itemize @bullet
@item
Synopsis: get [file]
@end itemize

Get file; default is file under cursor.

@c ---------------------------------------------------------------------
@node view
@subsection view -- view file
@cindex view

@itemize @bullet
@item
Synopsis: view [file]
@end itemize

View file;  default is file under cursor.

@c ---------------------------------------------------------------------
@node pipe
@subsection pipe -- pipe file to command
@cindex pipe

@itemize @bullet
@item
Synopsis: pipe [-q] file cmd [arg ...]
@end itemize

Pipe file to command @var{cmd}.  If @code{-q} is given, display is not escaped (thus, @var{cmd} should not produce any output).

@c ---------------------------------------------------------------------
@node put
@subsection put -- put file
@cindex put

@itemize @bullet
@item
Synopsis: put [file]
@end itemize

Put file; if no file name given, you will be prompted for it.

@c ---------------------------------------------------------------------
@node leave
@subsection leave -- leave current directory
@cindex leave

@itemize @bullet
@item
Synopsis: leave 
@end itemize

Leave current directory, positioning cursor over it.

@c ---------------------------------------------------------------------
@node cd
@subsection cd -- change directory
@cindex cd

@itemize @bullet
@item
Synopsis: cd [dir]
@end itemize

Change remote directory;  default is to directory under cursor.

@c ---------------------------------------------------------------------
@node state
@subsection state -- change binding state
@cindex state

@itemize @bullet
@item
Synopsis: state [state]
@end itemize

Change binding state to @var{state}. @xref{Binding States}.

@c ---------------------------------------------------------------------
@node leave-tag
@subsection leave-tag -- leave @code{<tag>} state
@cindex leave-tag

@itemize @bullet
@item
Synopsis: leave-tag 
@end itemize

Leave @code{<tag>} state, entering whatever state was active before
entering @code{<tag>} state.


@c =====================================================================
@node Tagging Functions
@section Tagging Functions
@cindex Tagging Functions

@menu
* tag::			tag/untag file for later download
* clear-tags::		clear all tags
* get-tags::		get tagged files
* save-tags::		save tag list to file
* load-tags::		load tag list from file
* save-urls::		save tags as url list
@end menu

@c ---------------------------------------------------------------------
@node tag
@subsection tag -- tag/untag file for later download
@cindex tag

@itemize @bullet
@item
Synopsis: tag [file]
@end itemize

Tag file; default is file under cursor.

@c ---------------------------------------------------------------------
@node clear-tags
@subsection clear-tags -- clear all tags
@cindex clear-tags

@itemize @bullet
@item
Synopsis: clear-tags 
@end itemize

Clear all tags.

@c ---------------------------------------------------------------------
@node get-tags
@subsection get-tags -- get tagged files
@cindex get-tags

@itemize @bullet
@item
Synopsis: get-tags download tagged files
@end itemize

Download tagged files.

@c ---------------------------------------------------------------------
@node save-tags
@subsection save-tags -- save tag list to file
@cindex save-tags

@itemize @bullet
@item
Synopsis: save-tags [file]
@end itemize

Save tag list to file, in the same format as the listing in
@code{<tag>} state.

@c ---------------------------------------------------------------------
@node load-tags
@subsection load-tags -- load tag list from file
@cindex load-tags

@itemize @bullet
@item
Synopsis: load-tags [file]
@end itemize

Load tags from file and merge them with current tags.  A tags file
contains one tag per line, each consisting of up to three whitespace
separated fields: size (integer, -1 for unknown; optional), type
(`d'irectory, palin `f'ile, `l'ink, or `x' for unknown; optional), and
name (mandatory).

@c ---------------------------------------------------------------------
@node save-urls
@subsection save-urls -- save tags as url list
@cindex save-urls

@itemize @bullet
@item
Synopsis: save-urls [file]
@end itemize

Save tag list to file, in URL notation.