@c This file is automatically created from ``options.op''; don't change
@c this file, change ``options.op'' instead.
@c
@c Created from:
@c   $NiH: mkoptexi.m4,v 1.7 2002/09/16 12:42:40 dillo Exp $
@c   $NiH: options.op,v 1.23 2002/09/16 12:42:40 dillo Exp $

@c *********************************************************************
@node	 Options
@chapter Options

@menu
* mode::		transfer mode for downloads
* passive::		use passive mode to establish data connections
* stall-timeout::	timeout for stalled connections (in seconds)
* tag-char::		char to mark tagged files with
* hist-size::		size of ftp command/response history
* beep::		beep after some commands
* scroll-limit::	minimum overlap for scrolling lists
* pager::		pager used to view files
* sort::		sort criterium for directory listings
* wrap::		wrap around bottom/top when scrolling
* user-anon-passwd::	whether to send user name as anonymous password
@end menu

@c ---------------------------------------------------------------------
@node mode
@section mode -- transfer mode for downloads
@cindex mode

@itemize @bullet
@item
Option: mode
@item 
Short: mo
@item
Default: 'i'
@end itemize

Transfer mode used for downloads; set to `i' for image (binary), `a'
for ascii.

@c ---------------------------------------------------------------------
@node passive
@section passive -- use passive mode to establish data connections
@cindex passive

@itemize @bullet
@item
Option: passive
@item 
Short: pv
@item
Default: 0
@end itemize



@c ---------------------------------------------------------------------
@node stall-timeout
@section stall-timeout -- timeout for stalled connections (in seconds)
@cindex stall-timeout

@itemize @bullet
@item
Option: stall-timeout
@item 
Short: st
@item
Default: 900
@end itemize

If no data arrives on the data connection for this many seconds,
consider the transfer stalled and abort.

@c ---------------------------------------------------------------------
@node tag-char
@section tag-char -- char to mark tagged files with
@cindex tag-char

@itemize @bullet
@item
Option: tag-char
@item 
Short: tc
@item
Default: '>'
@end itemize

Tagged files in the current directory are marked with this character
in the first column.

@c ---------------------------------------------------------------------
@node hist-size
@section hist-size -- size of ftp command/response history
@cindex hist-size

@itemize @bullet
@item
Option: hist-size
@item 
Short: hs
@item
Default: 200
@end itemize

Specifies how many lines of ftp commands and responses exchanged
with the ftp server to remember.  Remembered lines can be displayed
with @code{response}.  @xref{response}

@c ---------------------------------------------------------------------
@node beep
@section beep -- beep after some commands
@cindex beep

@itemize @bullet
@item
Option: beep
@item 
Short: bp
@item
Default: 0
@end itemize

Tells cftp to beep after completing some commands, e. g. downloading
tagged files.

@c ---------------------------------------------------------------------
@node scroll-limit
@section scroll-limit -- minimum overlap for scrolling lists
@cindex scroll-limit

@itemize @bullet
@item
Option: scroll-limit
@item 
Short: sl
@item
Default: 0
@end itemize

Don't scroll lists if overlap of old and new positions is less than
@code{scroll-limit} lines; make a full redraw instead.

@c ---------------------------------------------------------------------
@node pager
@section pager -- pager used to view files
@cindex pager

@itemize @bullet
@item
Option: pager
@item 
Short: pg
@item
Default: "more"
@end itemize

Pager used to view files.  Defaults to the value of the environment
variable @code{$PAGER} if set, to @code{more} otherwise.

@c ---------------------------------------------------------------------
@node sort
@section sort -- sort criterium for directory listings
@cindex sort

@itemize @bullet
@item
Option: sort
@item 
Short: so
@item
Default: 1
@end itemize

Set how to sort directory listings; possible values are
@table @code
@item none
list as returned by ftp server
@item name
alphabetically by file name
@item date
chronologically by modification time, newest first
@item name-r
alphabetically by file name, in reverse order
@item date-r
chronologically by modification time, oldest first
@end table


@c ---------------------------------------------------------------------
@node wrap
@section wrap -- wrap around bottom/top when scrolling
@cindex wrap

@itemize @bullet
@item
Option: wrap
@item 
Short: wa
@item
Default: 1
@end itemize

If set, scrolling wraps around bottom/top when scrolling.

@c ---------------------------------------------------------------------
@node user-anon-passwd
@section user-anon-passwd -- whether to send user name as anonymous password
@cindex user-anon-passwd

@itemize @bullet
@item
Option: user-anon-passwd
@item 
Short: ua
@item
Default: 0
@end itemize

If set, the username (and, if available, FQDN) is sent as password
for anonymous.  If unset, ``anonymous@'' is sent instead.  Default is
unset.