==================================
OPENFTPD 0.30.x VARIABLES OVERVIEW
==================================

MESSAGE VARIABLES
-----------------
The following variables can be used in the OPENFTPD message files
"welcome", "goodbye", "mkdir", "upload", "download", "list", "chdir",
"nuke", "unnuke", "dele", "rmdir" (located in msg/)

%a = number of anonymous users logged in 
%A = maximum number of anonymous users to log in at the same time 
%c = user's credit 
%d = number of bytes downloaded in the current session 
%D = download size of all sessions 
%h = the name of the host from where the user is logged in 
%i = the IP address from which the user is logged in 
%k = last speed of the user's upload/download (kb/s) 
%l = date and time of last login 
%L = the download limit of the user 
%n = number of users logged in (anonymous and registered) 
%N = maximum number of anonymous and registered users 
%p = number of bytes uploaded in the current session 
%P = upload size of all sessions 
%q = upload*100/download ratio of current session 
%Q = upload*100/download ratio of all sessions 
%r = download/upload ratio of current session 
%R = download/upload ratio of all sessions 
%s = depends on the message type:
     chdir/list-messages: directory name
     upload/download-messages: filename
     startup/welcome/goodbye-messages: user name 
%S = name of logged in user 
%t = current date and time 
%u = number of registered users logged in 
%U = maximum number of registerd users to log in at the same time 
%% = percent character 

%#!<program> <arguments> = 
runs program with arguments, arguments can contain variables, too. 
This variable is valid only when it appears at the beginning of a line. 

PERL VARIABLES
--------------
The following variables can be used in the OPENFTPD perl files
(located in bin/)

${F4A_USER}       = name of logged in user 
${F4A_UID}        = user-id of user
${F4A_CLASS}	  = userclass (normal/groupop/siteop/superuser) of 
		    logged in user
${F4A_GROUP}      = groupname of user
${F4A_GID}        = group-id of user
${F4A_INVISIBLE}  = user invisible? (0/1)
${F4A_COLOR}      = color enabled? (0/1)
${F4A_APASS}      = anonymous password
${F4A_STD}        = standarddir where openftpd is installed to
${F4A_R_NUKE}     = is the logged in user allowed to nuke ? (yes/no)
${F4A_R_UNDUPE}   = is the logged in user allowed to undupe ? (yes/no)
${F4A_SECTION}    = name of section
${F4A_SECCFG}     = name of the sectionconfig file
${F4A_INFO}       = tagline of logged in user

EMBEDDED PERL VARIABLES
-----------------------
The following variables and functions can be used in the OPENFTPD embedded 
perl files (located in scripts/ and lib/)

$FTP::vfs_stat(<filename>)		= filestat from vfs_layer
$FTP::var_privileged			= is logged in user normal user? (0/1)
$FTP::var_siteop    			= is logged in user siteop? (0/1)
$FTP::var_superuser 			= is logged in user superuser? (0/1)
$FTP::var_groupop   			= is logged in user groupop? (0/1)
$FTP::var_user      			= username of logged in user
$FTP::var_uid				= userid of logged in user
$FTP::var_group     			= groupname of logged in user
$FTP::var_gid				= groupid of logged in user
$FTP::var_color     			= is color set to on? (0/1)
$FTP::var_section   			= name of section
$FTP::var_tagline			= tagline of logged in user
$FTP::var_logintime			= login time


$FTP::cfg_server_path			= path to siteroot
$FTP::cfg_help_path			= path to <siteroot>/help
$FTP::cfg_etc_path			= path to <siteroot>/etc
$FTP::cfg_msg_path  			= path to <siteroot>/msg
$FTP::cfg_bin_path  			= path to <siteroot>/bin
$FTP::cfg_sbin_path 			= path to <siteroot>/sbin
$FTP::cfg_scrips_path 			= path to <siteroot>/scripts
$FTP::cfg_lib_path 			= path to <siteroot>/lib
$FTP::cfg_var_path 			= path to <siteroot>/var
$FTP::cfg_log_path  			= path to <siteroot>/var/log

&FTP::vfs_getcwd()    			= returns actual path

--- EOF ---
