&stat(4)

NAME

&stat - Retrieve a file statistic

SYNOPSIS

&stat <stat> <filename>

DESCRIPTION

&stat returns the specified <stat> on the given <filename>. Valid <stat> values are:-

a


Returns the absolute file name, corrects relative paths and symbolic links, i.e. on unix if the filename is a symbolic link it returns the file name the link points to (recursive), otherwise returns the file name.

d


Returns the file's modification time stamp. The value returned is an integer, larger values indicate a later time.

r


Returns a non-zero value if the user has permission to read the given file.

s


Returns the size of the file in bytes.

t


Returns the type of the file, where values returned are

    0   File does not exist. 
    1   File is a regular file. 
    2   File is a directory. 
    3   File is a URL link (i.e. http://...). 
    4   File is a untouchable system file. 

w


Returns a non-zero value if the user has permission to write to the given file.

x


Returns a non-zero value if the user has permission to execute the given file.

EXAMPLE

The following example is a macro which, given a file name, uses &stat to check that file file is regular:

define-macro test-file 
    !force set-variable #l0 @1 
    !if &not $status 
        set-variable #l0 @ml04 "File name" 
    !endif 
    !if &not &equ &stat "t" #l4 1 
        ml-write &spr "[%s is not a regular file]" #l0 
        !abort 
    !endif 
!emacro 

test-file "foobar" 

The macro can be passed a file name and aborts if the file is not regular, there by returning the state.

The follow example checks that a file is not empty, this is used by mail-check to test for any incoming mail.

    !if &gre &stat "s" %incoming-mail-box 
        ml-write "[You have new mail]" 
    !endif 

SEE ALSO

Variable Functions, find-file(2).

(c) Copyright JASSPA 1999
Last Modified: 1998/09/08
Generated On: 1999/12/01