System Administration Guide: Network Services

ProcedureHow to Configure the README Option

The first time a directory is visited, README files can be listed. To configure the README option, add the following entries to the ftpaccess file.

  1. Become superuser or assume an equivalent role.

    Roles contain authorizations and privileged commands. For more information about roles, see Configuring RBAC (Task Map) in System Administration Guide: Security Services.

  2. Add the following entries to the ftpaccess file.

    readme message-file [when [class...]]

    Keyword that is used to specify a message file to be checked when a user logs in or changes the working directory. If the message file exists, the user is notified and is given the date the file was modified.


    Name of the message file to be checked.


    Parameter that is set as login or cwd=dir. See the following example.


    The class specification allows the message to be displayed only to members of a particular class.

    Note –

    The greeting and banner keywords can also be used to send messages to users. See ftpaccess(4).

Example 28–11 Configuring the README Option

readme  README*     login
readme  README*     cwd=*  

The previous example states that any files that match README* are listed at login or when a directory is changed. Here is a sample login that is based on the settings that are used in that example.

% ftp earth
Connected to earth.
220 earth FTP server ready.
Name (earth:rimmer): ftp
331 Guest login ok, send your complete e-mail address as password.
230-Welcome to earth -- local time is Thu Jul 15 16:13:24 
230-You are number 1 out of a maximum of 10.
230-All transfers are logged.
230-If your FTP client crashes or hangs shortly after login 
please try
230-using a dash (-) as the first character of your 
password.  This will
230-turn off the informational messages that may be 
confusing your FTP
230-Please send any comments to ftpadmin@earth.
230 Guest login ok, access restrictions apply.
ftp> cd pub
250-Please read the file README
250-  it was last modified on Thu Jul 15 16:12:25 1999 - 0 
days ago
250 CWD command successful.
ftp> get README /tmp/README
200 PORT command successful.
150 Opening ASCII mode data connection for README (0 
226 ASCII Transfer complete.
ftp> quit
221 Goodbye.