.\" -*- nroff -*-
.TH ARCLS 1 "2024-04-13" "NorduGrid ARC 6.19.0" "NorduGrid Users Manual"

.SH NAME

arcls \- list files or directories

.SH DESCRIPTION

The
.B arcls
command is used for listing files in grid storage elements and file index
catalogues.

.SH SYNOPSIS

.B arcls [options] url

.SH OPTIONS

.IP "\fB-l\fR, \fB--long\fR"
long format (like ls -l). The name of the object is followed by these
elements: filetype of object, size in bytes, modification time,
checksum and access latency (ONLINE or NEARLINE). The
elements for which information is available is protocol-dependent.
.IP "\fB-L\fR, \fB--locations\fR"
show URLs of file locations (replicas) registered in index services.
.IP "\fB-m\fR, \fB--metadata\fR"
list all available metadata.
.IP "\fB-r\fR, \fB--recursive\fR"
operate recursively
.IP "\fB-D\fR, \fB--depth\fR=\fIlevel\fR"
operate recursively up to specified level
.IP "\fB-n\fR, \fB--nolist\fR"
show only description of requested object, do not list content of directories (like ls -d).
.IP "\fB-f\fR, \fB--forcelist\fR"
treat requested object as directory and always try to list content
.IP "\fB-c\fR, \fB--checkaccess\fR"
check readability of object. Retrieving and showing information about object is suppressed.
.IP "\fB-P\fR, \fB--listplugins\fR"
list the available plugins (protocols supported)
.IP "\fB-t\fR, \fB--timeout\fR=\fIseconds\fR"
timeout in seconds (default 20)
.IP "\fB-z\fR, \fB--conffile\fR=\fIfilename\fR"
configuration file (default ~/.arc/client.conf)
.IP "\fB-d\fR, \fB--debug\fR=\fIdebuglevel\fR"
FATAL, ERROR, WARNING, INFO, VERBOSE or DEBUG
.IP "\fB-v\fR, \fB--version\fR"
print version information
.IP "\fB-?\fR, \fB--help\fR"
print help

.SH ARGUMENTS

.IP "\fBurl\fR"
the location to list
.LP

.SH EXTENDED DESCRIPTION

The
.B arcls
command lists files and directories on grid storage elements and in
file index catalogues. Depending on the installed libraries (check with
.B -P
), the following protocols may be used: file  (file://  prefix  may  be
omitted), http, https, httpg, ftp, gsiftp, srm, root.
 
In the case of a directory/fileset, attributes of objects belonging
to it will be retrieved, unless
.B --nolist
is specified.

If url starts from '@', the remainder should be a path to a local file
containing list of URLs, one per line. Then arcls acts as if it was
called multiple times, once for each URL. For more information on ARC
URL syntax please read "Protocols, Uniform Resource Locators (URL) and
Extensions Supported in ARC" [NORDUGRID-TECH-7]

.SH FILES

.TP
.B ~/.arc/client.conf
Some options can be given default values by specifying them in the
ARC client configuration file. By using the
.B --conffile
option a different configuration file can be used than the default.

.SH ENVIRONMENT VARIABLES

.TP
.B X509_USER_PROXY
The location of the user's Grid proxy file. Shouldn't be set unless
the proxy is in a non-standard location.

.TP
.B ARC_LOCATION
The location where ARC is installed can be specified by this variable. If not
specified the install location will be determined from the path to the
command being executed, and if this fails a WARNING will be given stating the
location which will be used.

.TP
.B ARC_PLUGIN_PATH
The location of ARC plugins can be specified by this variable. Multiple
locations can be specified by separating them by : (; in Windows). The
default location is \fB$ARC_LOCATION\fR/lib/arc (\\ in Windows).

.SH EXAMPLE

arcls -l gsiftp://example.com/grid/file.dat

.SH COPYRIGHT

APACHE LICENSE Version 2.0

.SH AUTHOR

ARC software is developed by the NorduGrid Collaboration 
(http://www.nordugrid.org), please consult the AUTHORS file distributed with 
ARC. Please report bugs and feature requests to http://bugzilla.nordugrid.org

.SH SEE ALSO

.BR arccp (1),
.BR arcmkdir (1),
.BR arcrename (1),
.BR arcrm (1),