Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found
Select Git revision
  • develop
  • master
  • v1.1.0
  • v1.2.1
  • v1.3.0
  • v1.3.1
  • v1.3.2
  • v1.4.0
  • v1.5.0
  • v1.5.1
  • v1.5.2
  • v1.5.3
  • v1.5.4
  • v1.6.0
  • v1.7.0
  • v1.7.0-2
  • v1.7.1
  • v1.8.0
  • v1.8.1
  • v1.9.0
20 results

Target

Select target project
  • loregnie/gfal2-util
  • ellert/gfal2-util
  • vokac/gfal2-util
  • lbryant/gfal2-util
  • jbalcas/gfal2-util
  • dmc/gfal2-util
6 results
Select Git revision
  • develop
  • master
  • v1.1.0
  • v1.2.1
  • v1.3.0
  • v1.3.1
  • v1.3.2
  • v1.4.0
  • v1.5.0
  • v1.5.1
10 results
Show changes
Commits on Source (139)
39 additional commits have been omitted to prevent performance issues.
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 1176 additions and 838 deletions
.gitlab-ci.yml 0 → 100644
View file @ ba4633fe
stages:
- build
- test
- publish
#--------------------------
# Build templates
#--------------------------
.build-template: &build-template_definition
stage: build
script:
- ci/fedora-packages.sh
- ci/common-rpm-build.sh
- mkdir ${CI_JOB_NAME}
- cp -rv build/RPMS build/SRPMS ${CI_JOB_NAME}
- tree ${CI_JOB_NAME}
variables:
BRANCH: ${CI_COMMIT_REF_NAME}
artifacts:
paths:
- "$CI_JOB_NAME"
#--------------------------
# Build jobs
#--------------------------
alma8:
image: gitlab-registry.cern.ch/linuxsupport/alma8-base
<<: *build-template_definition
alma9:
image: gitlab-registry.cern.ch/linuxsupport/alma9-base
<<: *build-template_definition
fedora-40:
image: registry.cern.ch/docker.io/library/fedora:40
<<: *build-template_definition
fedora-41:
image: registry.cern.ch/docker.io/library/fedora:41
<<: *build-template_definition
fedora-rawhide:
image: registry.cern.ch/docker.io/library/fedora:rawhide
<<: *build-template_definition
allow_failure: true
when: manual
#--------------------------
# Test templates
#--------------------------
.test-template: &test-template_definition
stage: test
script:
- dnf install -y git
- PLATFORM=${CI_JOB_NAME%-*}
- ci/write-repo-file.sh
- dnf install -y ${PLATFORM}/RPMS/*/*.rpm
- python3 test/functional/test_all.py
variables:
BRANCH: ${CI_COMMIT_REF_NAME}
#--------------------------
# Test jobs
#--------------------------
alma8-test:
image: gitlab-registry.cern.ch/linuxsupport/alma8-base
needs:
- job: alma8
before_script:
- dnf install -y epel-release
<<: *test-template_definition
alma9-test:
image: gitlab-registry.cern.ch/linuxsupport/alma9-base
needs:
- job: alma9
before_script:
- dnf install -y epel-release
<<: *test-template_definition
fedora-40-test:
image: registry.cern.ch/docker.io/library/fedora:40
needs:
- job: fedora-40
<<: *test-template_definition
fedora-41-test:
image: registry.cern.ch/docker.io/library/fedora:41
needs:
- job: fedora-41
<<: *test-template_definition
#--------------------------
# Publish templates
#--------------------------
.publish-template: &publish-template_definition
stage: publish
image: gitlab-registry.cern.ch/eos/gitlab-eos/alma9:latest
dependencies:
- alma8
- alma9
- fedora-40
- fedora-41
- fedora-rawhide
script:
- automount
- cat "$repo_passwd" | kinit "$repo_user"
- |
for platform in alma8 alma9 fedora-40 fedora-41 fedora-rawhide; do
if [[ "${platform}" == "fedora-rawhide" ]] && [[ ! -d ${platform} ]] ; then
echo "Skipping ${platform} packages..." ;
continue ;
fi
packaging/gfal2-repo-manager.py --action add --base /eos/project-d/dmc/www/repos/ --arch-dir x86_64 --ref ${CI_COMMIT_REF_NAME} --packages ${platform}/RPMS/*/*.rpm ${platform}/SRPMS/*
done
tags:
- docker-privileged-xl
retry: 2
#--------------------------
# Publish jobs
#--------------------------
rpms:
<<: *publish-template_definition
rules:
- if: '$CI_PROJECT_NAMESPACE != "dmc"'
when: never
- if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
when: never
- if: '$CI_COMMIT_REF_NAME == "develop" || $CI_COMMIT_TAG != null'
- if: '$CI_COMMIT_REF_NAME != "develop" && $CI_COMMIT_TAG == null'
when: manual
LICENSE
View file @ ba4633fe
This diff is collapsed.
README.md
View file @ ba4633fe
......@@ -16,19 +16,41 @@ We provide here a brief overview of the command line tools we provide as part of
To see detailed usage of each one, you can invoke them with --help to show all the possible options.
### Standard commands
#### gfal-bringonline
Perform a staging operation on the given SURL.
#### gfal-archivepoll
Perform an archive polling operation on a given SURL.
#### gfal-cat
Equivalent to cat. Print into the standard output the content of the requested file
#### gfal-chmod
Equivalent to chmod. Changes the access permissions of the requested file
#### gfal-copy
Equivalent to cp but more powerful. Copy a file, or set of files, between different
storages and/or local. Recursive mode is supported. Try --dry-run to validate what will happen.
#### gfal-evict
Requests a Tape storage to release the given file's disk replica.
- For SRM storage, this is the equivalent of an unpin operation. The file is marked
as eligible for garbage collection
- For CTA storage, this is the equivalent of an evict operation. The file's evict
counter is decreased. When the counter reaches zero, the file's disk replica
is deleted immediately
#### gfal-ls
Equivalent to ls. List the content of a directory. Use -l to generate a detailed list.
#### gfal-mkdir
Equivalent to mkdir. Create a directory
#### gfal-rename
Equivalent to rename command. Moves the file from one location to another one
within the same storage
#### gfal-rm
Equivalent to rm. Remove a file, or a directory if -r is specified.
Try --dry-run if you want to validate what will happen without doing anything.
......@@ -43,6 +65,12 @@ Equivalent to stat. Print information about the file or directory.
Query or calculate the checksum of the given file.
Normally recognised checksums are adler32, md5 and sha1, but it depends on the protocol and/or storage software.
#### gfal-token
Requests a Storage Endpoint (SE) to issue a token for the given SURL (SE-issued token).
The token should be considered opaque, but most often used Grid implementations
are JWTs or macaroons. These tokens have great applicability in HTTP-TPC as
they avoid the need to perform proxy certificate delegation.
#### gfal-xattr
Equivalent to attr. Query or set an extended attribute from a file or directory.
Which extended attributes are supported depend on the protocol. For instance user.replicas or user.comment can be used for SRM or LFC.
......@@ -51,9 +79,6 @@ Which extended attributes are supported depend on the protocol. For instance use
This commands exists purely to provide ways to access functionality previously provided by lcg-util.
We recommend avoiding the usage of these tools if possible.
#### gfal-legacy-bringonline
Perform a staging operation on the given SURL.
#### gfal-legacy-register
Register a new replica in a catalog. We recommend using instead
```bash
......@@ -75,6 +100,9 @@ gfal-xattr [surl] user.replicas=-replica
## License
This software is licensed under the [Apache 2 License](http://www.apache.org/licenses/LICENSE-2.0.html)
Copyright (c) 2013-2022 CERN
Copyright (c) 2012-2013 Members of the EMI Collaboration
See http://www.eu-emi.eu/partners for details on the copyright holders.
## Contact
You can notify bugs or ask for feature requests via dmc-support@cern.ch or dmc-devel@cern.ch
RELEASE-NOTES
View file @ ba4633fe
gfal2-util release notes
========================
## Wed Jul 31 2024 Louis Regnier <loregnie@cern.ch> - 1.9.0
### Bug
- [DMC-1403] - Installing "gfal2-util-scripts" does not bring needed "python3-gfal2-util" dependency
### Task
- [DMC-1414] - Stop building Data Management Clients for CC7
- [DMC-1413] - Data Management Clients for Fedora 39 and Fedora 40
### Improvement
- [DMC-1416] - Disable the automatic clean-up when a copy fails
- [cern-fts/gfal2-util/pull/7] - Update name of LCG trust anchors
## Tue Dec 12 2023 Mihai Patrascoiu <mipatras@cern.ch> - 1.8.1
### Bug
- [DMC-1395] - Gfal2 CLI return code is not within bash return code range
- [gfal2-util/issues/1] - gfal-copy fails to complete the data transfer but returns exit code 0
- [cern-fts/gfal2-util/pull/5] - CommandRm should call CommandBase constructor (solve issue #4)
### New Feature
- [DMC-1344] - Propagate Scitags during TPC transfers
### Task
- [DMC-1327] - DMC packages for Centos Stream 9
- [DMC-1359] - Data Management Clients for Fedora 37
- [DMC-1379] - Move DMC projects to Alma8 and Alma9
- [DMC-1387] - Data Management Clients for Fedora 38
- [DMC-1389] - Port Gfal2 Python3 projects away from "distutils"
## Fri Sep 02 2022 Joao Lopes <batistal@cern.ch> - 1.8.0
### Bug
- [DMC-1328] - Exception with gfal-copy progress bar when source size is known and transfer rate is not reported yet
### New Feature
- [DMC-1319] - Renew gfal-legacy-bringonline command
- [DMC-1332] - Create gfal-archivepoll command
### Task
- [DMC-1336] - Data Management Clients for Fedora 36
- [DMC-1341] - Change gfal2-util license to Apache 2.0
### Improvement
- [DMC-1208] - Gfal2-util bringonline with "--from-file" option
- [gfal2-util/pull/7] - Add missing man page section for "gfal-legacy-register"
### Sub-task
- [DMC-1333] - Create a single file for tape commands in gfal-util
- [DMC-1342] - gfal-archivepoll with "--from-file" option
- [DMC-1343] - Create gfal-evict command
## Mon Mar 07 2022 Mihai Patrascoiu <mipatras@cern.ch> - 1.7.1
### Bug
- [DMC-1285] - Stuck transfers to XRoot sites with enabled TLS
- [DMC-1288] - Python3 "gfal-cat" fails on binary files
- [gfal2-util/pull/5] - DMC-1285: Transfers gets stuck when calling subprocess
### Task
- [DMC-1299] - Update man pages for gfal2-util
### Improvement
- [DMC-1308] - Move Data Management Clients to Fedora 34 & 35
## Thu Sep 23 2021 Joao Lopes <batistal@cern.ch> - 1.7.0
### Epic
- [DMC-1249] - Migrate CI infrastructure to gitlab-CI
### New Feature
- [DMC-1265] - Export SE token retrieval in Gfal2 Python binding
### Task
- [DMC-1250] - Gfal2 packages for Centos8
- [DMC-1264] - Gfal2 packages for Fedora >= 33
## Thu Nov 19 2020 Petr Vokac <petr.vokac at cern.ch> - 1.6.0
### Improvement
- [DMC-1223] make sources compatible with python 2.4 - 3.9
- [DMC-1223] automatically choose available python interpreter
the one from GFAL_PYTHONBIN env is most preferred
with fallback to python3, python2, python
- [DMC-1223] drop separate python3 code
- [DMC-1229] Introduce Gfal2 transfer parameter to enable/disable proxy delegation
- Fix the parsing of passed-in definitions to allow complex groups
## Mon Sep 14 2020 Mihai Patrascoiu <mipatras at cern.ch> - 1.5.4
### Bug
- [DMC-1212] - Prevent gfal2-copy output crashing when filesize is reported 0
- [DMC-1222] - gfal-rm reports return code 0 on MISSING file URLs
### Improvement
- [DMC-1225] - Allow gfal2 CLI clients to separate output generated by the clients from gfal2 library log output
- Change order of uid/gid to match POSIX 'ls -l'
## Thu Jul 11 2019 Andrea Manzi <amanzi at cern.ch> - 1.5.3
### Bug
- [DMC-1155] - gfal-rm with signed https URL gives 401 error
### Task
- [DMC-1150] - Set XrdSecGSIDELEGPROXY=1 in gfal-copy to enable XRD TPC with delegation
## Thu Feb 21 2019 Andrea Manzi <amanzi at cern.ch> - 1.5.2
### Bug
- [DMC-1070] - gfal-ls cannot list WebDAV directories
- [DMC-1142] - Shebang on gfal-utils commands should specify python2 instead of python
### Improvement
- [DMC-1124] - Add --copy-mode to gfal-copy
- [DMC-1077] - gfal-copy --just-copy stats dest
## Wed Jun 21 2017 Alejandro Alvarez <aalvarez at cern.ch> - 1.5.1
### Bug
- [DMC-933] - gfal-copy does stat/propfind even if --just-copy is given
......
VERSION
View file @ ba4633fe
1.5.1
1.9.0
ci/common-rpm-build.sh 0 → 100755
View file @ ba4633fe
#!/usr/bin/env bash
set -e
function print_info {
printf "======================\n"
printf "%-17s%s\n" "Distribution:" "${DIST}"
printf "%-17s%s\n" "Dist name:" "${DISTNAME}"
printf "%-17s%s\n" "Build type:" "${BUILD}"
printf "%-17s%s\n" "Branch:" "${BRANCH}"
printf "%-17s%s\n" "Release:" "${RELEASE}"
printf "%-17s%s\n" "DMC Repository:" "${REPO_FILE}"
printf "%-17s%s\n" "RPM build flags:" "${RPMBUILD_FLAGS}"
printf "======================\n"
}
TIMESTAMP=$(git log -1 --format="%at" | xargs -I{} date -d @{} +%y%m%d%H%M)
GITREF=`git rev-parse --short HEAD`
RELEASE=r${TIMESTAMP}git${GITREF}
BUILD="devel"
if [[ -z ${BRANCH} ]]; then
BRANCH=`git name-rev $GITREF --name-only`
else
printf "Using environment set variable BRANCH=%s\n" "${BRANCH}"
fi
if [[ $BRANCH =~ ^(tags/)?(v)[.0-9]+(-(rc)?([0-9]+))?$ ]]; then
RELEASE="${BASH_REMATCH[4]}${BASH_REMATCH[5]}"
BUILD="rc"
fi
DIST=$(rpm --eval "%{dist}" | cut -d. -f2)
DISTNAME=${DIST}
# Special handling of FC rawhide
[[ "${DISTNAME}" == "fc42" ]] && DISTNAME="fc-rawhide"
# Write repository files to /etc/yum.repos.d/ based on the branch name
REPO_FILE=$(./ci/write-repo-file.sh)
print_info
RPMBUILD=${PWD}/build
SRPMS=${RPMBUILD}/SRPMS
cd packaging/
make srpm RELEASE=${RELEASE} RPMBUILD=${RPMBUILD} SRPMS=${SRPMS} RPMBUILD_SRC_EXTRA_FLAGS="${RPMBUILD_FLAGS}"
dnf builddep -y ${SRPMS}/*
rpmbuild --rebuild --define="_topdir ${RPMBUILD}" ${RPMBUILD_FLAGS} ${SRPMS}/*
ci/fedora-packages.sh 0 → 100755
View file @ ba4633fe
#!/usr/bin/env bash
set -e
# Ensure "epel-release" package is installed
if ! rpm -q --quiet epel-release ; then
dnf install -y epel-release || true
fi
# Fedora rawhide (FC41)
dnf install -y dnf5-plugins || true
dnf install -y dnf-plugins-core git rpm-build tree which \
cmake make gcc gcc-c++
ci/write-repo-file.sh 0 → 100755
View file @ ba4633fe
#!/usr/bin/env bash
set -e
GITREF=`git rev-parse --short HEAD`
if [[ -z ${BRANCH} ]]; then
BRANCH=`git name-rev $GITREF --name-only`
fi
if [[ $BRANCH =~ ^(tags/)?(v)[.0-9]+(-(rc)?([0-9]+))?$ ]]; then
BUILD="rc"
elif [[ ! -z ${DMC_REPO_BRANCH} ]]; then
BUILD="${DMC_REPO_BRANCH}"
else
BUILD="develop"
fi
DIST=$(rpm --eval "%{dist}" | cut -d. -f2)
DISTNAME=${DIST}
# Special handling of FC rawhide
[[ "${DISTNAME}" == "fc42" ]] && DISTNAME="fc-rawhide"
if [[ ${BUILD} == "rc" ]]; then
REPO_PATH="${BUILD}/${DISTNAME}/\$basearch"
elif [[ ${BUILD} == "develop" ]]; then
REPO_PATH="testing/${DISTNAME}/\$basearch"
else
REPO_PATH="testing/${BUILD}/${DISTNAME}/\$basearch"
fi
cat <<- EOF > "/etc/yum.repos.d/dmc-${BUILD}-${DISTNAME}.repo"
[dmc-${BUILD}-${DISTNAME}]
name=DMC Repository
baseurl=http://dmc-repo.web.cern.ch/dmc-repo/${REPO_PATH}
gpgcheck=0
enabled=1
protect=0
priority=3
EOF
echo "dmc-${BUILD}-${DISTNAME}.repo"
doc/man/gfal-archivepoll.1 0 → 100644
View file @ ba4633fe
.\" Manpage for gfal-archivepoll
.\"
.TH GFAL-ARCHIVEPOLL 1 "Set 2022" "v1.8.0"
.SH NAME
gfal-archivepoll \- Perform an archive polling operation on the given SURL
.SH SYNOPSIS
.B gfal-archivepoll
[
.I "OPTION"
]...
.I FILE
.SH DESCRIPTION
.B gfal-archivepoll
This command performs an archive polling operation on a given SURL. If a polling timeout greater than 0 is provided
the command blocks for polling the status of the archiving request and only returns when the file is on tape
or the timeout expires.
.SH OPTIONS
.TP
.B "-h, --help"
show help about the command.
.TP
.B "-V, --version"
output version information and exit.
.TP
.B "-v, --verbose"
verbose mode. Repeat up to 3 times for the most verbose mode.
.TP
.BI "-D, --definition " DEFINITION
define properties for gfal2. Definitions have the following syntax: "CONFIG_GROUP:KEY=VALUE"
.TP
.BI "-t, --timeout " TIMEOUT
global timeout for the execution of the command. Command is interrupted if time expires before it finishes. Note: A grace period of 30 seconds is given to the global timeout.
.TP
.BI "-E, --cert " CERT
user certificate. (This option takes effect only after X509_USER_PROXY environment variable and default /tmp/x509up_u`id -u` location cannot provide a certificate)
.TP
.BI "--key " KEY
user private key.
.TP
.B "-4"
forces Gfal2 to use IPv4 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-6"
forces Gfal2 to use IPv6 addresses only. (Option valid only for GridFTP protocol)
.TP
.BI "-C, --client-info " CLIENT_INFO
provide custom client-side information.
.TP
.BI "--log-file " LOG_FILE
write Gfal2 library logs to the given file location.
.TP
.BI "--from-file " FROM_FILE
read sources from a file.
.TP
.B "--polling-timeout"
The timeout for the polling operation. If a polling timeout greater than 0 is provided the command blocks for polling
the status of the archiving request and only returns when the file is on tape or the timeout expires.
.SH EXAMPLES
.TP
.B gfal-archivepoll http://endpoint.cern.ch/path/file --polling-timeout=3600
.SH FILES
.I /etc/gfal2.d/*
.RS
All configuration files in this directory affect the behavior of the underlying gfal2.
.SH AUTHORS
Duarte Meneses <duarte.meneses@cern.ch>
.br
Adrien Devresse <adrien.devresse@cern.ch>
.br
Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.br
Mihai Patrascoiu <mihai.patrascoiu@cern.ch>
.br
Joao Lopes <joao.pedro.batista.lopes@cern.ch>
.SH "SEE ALSO"
.BR gfal-cat (1),
.BR gfal-chmod (1),
.BR gfal-copy (1),
.BR gfal-ls (1),
.BR gfal-mkdir (1),
.BR gfal-rename (1),
.BR gfal-rm (1),
.BR gfal-save (1),
.BR gfal-stat (1),
.BR gfal-sum (1),
.BR gfal-token (1),
.BR gfal-xattr (1),
.BR gfal-evict (1),
.BR gfal-bringonline (1),
.BR gfal-archivepoll (1)
doc/man/gfal-bringonline.1 0 → 100644
View file @ ba4633fe
.\" Manpage for gfal-bringonline
.\"
.TH GFAL-BRINGONLINE 1 "May 2022" "v1.8.0"
.SH NAME
gfal-bringonline \- Perform a staging operation on the given SURL
.SH SYNOPSIS
.B gfal-bringonline
[
.I "OPTION"
]...
.I FILE
.SH DESCRIPTION
.B gfal-bringonline
This command performs a staging operation on the given SURL. A bringonline token is returned if the staging request
is successful. In addition, if the polling timeout is greater than 0 the command blocks for polling the status of
the staging request and only returns when the file is online or the timeout expires.
.SH OPTIONS
.TP
.B "-h, --help"
show help about the command.
.TP
.B "-V, --version"
output version information and exit.
.TP
.B "-v, --verbose"
verbose mode. Repeat up to 3 times for the most verbose mode.
.TP
.BI "-D, --definition " DEFINITION
define properties for gfal2. Definitions have the following syntax: "CONFIG_GROUP:KEY=VALUE"
.TP
.BI "-t, --timeout " TIMEOUT
global timeout for the execution of the command. Command is interrupted if time expires before it finishes. Note: A grace period of 30 seconds is given to the global timeout.
.TP
.BI "-E, --cert " CERT
user certificate. (This option takes effect only after X509_USER_PROXY environment variable and default /tmp/x509up_u`id -u` location cannot provide a certificate)
.TP
.BI "--key " KEY
user private key.
.TP
.B "-4"
forces Gfal2 to use IPv4 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-6"
forces Gfal2 to use IPv6 addresses only. (Option valid only for GridFTP protocol)
.TP
.BI "-C, --client-info " CLIENT_INFO
provide custom client-side information.
.TP
.BI "--log-file " LOG_FILE
write Gfal2 library logs to the given file location.
.TP
.TP
.B "--pin-lifetime"
Desired pin lifetime
.TP
.B "--desired-request-time"
Desired total request time
.TP
.B "--staging-metadata"
Metadata for the bringonline operation
.BI "--from-file " FROM_FILE
read list of surls from a file.
.TP
.B "--polling-timeout"
The timeout for the polling operation. If a polling timeout greater than 0 is provided the command blocks for polling
the status of the staging request and only returns when the file is on disk or the timeout expires.
.SH EXAMPLES
.TP
.B gfal-bringonline http://endpoint.cern.ch/path/file --polling-timeout=3600
.SH FILES
.I /etc/gfal2.d/*
.RS
All configuration files in this directory affect the behavior of the underlying gfal2.
.SH AUTHORS
Duarte Meneses <duarte.meneses@cern.ch>
.br
Adrien Devresse <adrien.devresse@cern.ch>
.br
Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.br
Mihai Patrascoiu <mihai.patrascoiu@cern.ch>
.br
Joao Lopes <joao.pedro.batista.lopes@cern.ch>
.SH "SEE ALSO"
.BR gfal-cat (1),
.BR gfal-chmod (1),
.BR gfal-copy (1),
.BR gfal-ls (1),
.BR gfal-mkdir (1),
.BR gfal-rename (1),
.BR gfal-rm (1),
.BR gfal-save (1),
.BR gfal-stat (1),
.BR gfal-sum (1),
.BR gfal-token (1),
.BR gfal-xattr (1),
.BR gfal-evict (1),
.BR gfal-bringonline (1),
.BR gfal-archivepoll (1)
doc/man/gfal-cat.1
View file @ ba4633fe
.\" Manpage for gfal-cat
.\"
.TH GFAL-CAT 1 "May 2017" "v1.5.0"
.TH GFAL-CAT 1 "March 2022" "v1.7.1"
.SH NAME
gfal-cat \- concatenate a file and print on the standard output
.SH SYNOPSIS
.B gfal-cat
[
.B "-h"
] [
.B -V
] [
.B -v
] [
.B -D
.I DEFINITION
] [
.B -t
.I TIMEOUT
] [
.B -p
]
.I "OPTION"
]...
.I FILE
.SH DESCRIPTION
......@@ -36,14 +24,33 @@ output version information and exit.
.B "-v, --verbose"
verbose mode. Repeat up to 3 times for the most verbose mode.
.TP
.B "-D, --definition"
define properties for gfal2.
.BI "-D, --definition " DEFINITION
define properties for gfal2. Definitions have the following syntax: "CONFIG_GROUP:KEY=VALUE"
.TP
.B "-C, --client-info"
provide custom client-side information
.BI "-t, --timeout " TIMEOUT
global timeout for the execution of the command. Command is interrupted if time expires before it finishes. Note: A grace period of 30 seconds is given to the global timeout.
.TP
.B "-t, --timeout"
global timeout for the execution of the command. Command is interrupted if time expires before it finishes.
.BI "-E, --cert " CERT
user certificate. (This option takes effect only after X509_USER_PROXY environment variable and default /tmp/x509up_u`id -u` location cannot provide a certificate)
.TP
.BI "--key " KEY
user private key.
.TP
.B "-4"
forces Gfal2 to use IPv4 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-6"
forces Gfal2 to use IPv6 addresses only. (Option valid only for GridFTP protocol)
.TP
.BI "-C, --client-info " CLIENT_INFO
provide custom client-side information.
.TP
.BI "--log-file " LOG_FILE
write Gfal2 library logs to the given file location.
.TP
.B "-b, --bytes"
handle file contents as bytes. (only in Python3)
.SH EXAMPLES
.TP
......@@ -61,11 +68,26 @@ Duarte Meneses <duarte.meneses@cern.ch>
Adrien Devresse <adrien.devresse@cern.ch>
.br
Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.br
Andrea Manzi <andrea.manzi@cern.ch>
.br
Mihai Patrascoiu <mihai.patrascoiu@cern.ch>
.br
Joao Lopes <joao.pedro.batista.lopes@cern.ch>
.SH "SEE ALSO"
.BR gfal-cat (1),
.BR gfal-chmod (1),
.BR gfal-copy (1),
.BR gfal-ls (1),
.BR gfal-mkdir (1),
.BR gfal-rename (1),
.BR gfal-rm (1),
.BR gfal-cat (1),
.BR gfal-save (1),
.BR gfal-mkdir (1),
.BR gfal-ls (1)
.BR gfal-stat (1),
.BR gfal-sum (1),
.BR gfal-token (1),
.BR gfal-xattr (1),
.BR gfal-evict (1),
.BR gfal-bringonline (1),
.BR gfal-archivepoll (1)
doc/man/gfal-chmod.1
View file @ ba4633fe
.\" Manpage for gfal-chmod
.\"
.TH GFAL-CHMOD 1 "May 2017" "v1.5.0"
.TH GFAL-CHMOD 1 "March 2022" "v1.7.1"
.SH NAME
gfal-chmod \- Change the permissions of a file
.SH SYNOPSIS
.B gfal-chmod
[
.B "-h"
] [
.B -V
] [
.B -v
] [
.B -D
.I DEFINITION
] [
.B -C
.I CLIENT-INFO
] [
.B -t
.I TIMEOUT
]
.I "OPTION"
]...
.I MODE
.I URL
......@@ -39,26 +26,29 @@ output version information and exit.
.B "-v, --verbose"
verbose mode. Repeat up to 3 times for the most verbose mode.
.TP
.B "-D, --definition"
define properties for gfal2.
.BI "-D, --definition " DEFINITION
define properties for gfal2. Definitions have the following syntax: "CONFIG_GROUP:KEY=VALUE"
.TP
.B "-C, --client-info"
provide custom client-side information
.BI "-t, --timeout " TIMEOUT
global timeout for the execution of the command. Command is interrupted if time expires before it finishes. Note: A grace period of 30 seconds is given to the global timeout.
.TP
.B "-t, --timeout"
global timeout for the execution of the command. Command is interrupted if time expires before it finishes.
.BI "-E, --cert " CERT
user certificate. (This option takes effect only after X509_USER_PROXY environment variable and default /tmp/x509up_u`id -u` location cannot provide a certificate)
.TP
.B "-E, --cert"
user certificate
.TP
.B "--key"
user private key
.BI "--key " KEY
user private key.
.TP
.B "-4"
Forces gfal2-util to use IPv4 addresses only (if the plugin supports this)
forces Gfal2 to use IPv4 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-6"
Forces gfal2-util to use IPv6 addresses only (if the plugin supports this)
forces Gfal2 to use IPv6 addresses only. (Option valid only for GridFTP protocol)
.TP
.BI "-C, --client-info " CLIENT_INFO
provide custom client-side information.
.TP
.BI "--log-file " LOG_FILE
write Gfal2 library logs to the given file location.
.SH EXAMPLES
.B gfal-chmod
......@@ -76,6 +66,12 @@ Duarte Meneses <duarte.meneses@cern.ch>
Adrien Devresse <adrien.devresse@cern.ch>
.br
Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.br
Andrea Manzi <andrea.manzi@cern.ch>
.br
Mihai Patrascoiu <mihai.patrascoiu@cern.ch>
.br
Joao Lopes <joao.pedro.batista.lopes@cern.ch>
.SH "SEE ALSO"
.BR gfal-cat (1),
......@@ -88,4 +84,8 @@ Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.BR gfal-save (1),
.BR gfal-stat (1),
.BR gfal-sum (1),
.BR gfal-xattr (1)
\ No newline at end of file
.BR gfal-token (1),
.BR gfal-xattr (1),
.BR gfal-evict (1),
.BR gfal-bringonline (1),
.BR gfal-archivepoll (1)
doc/man/gfal-copy.1
View file @ ba4633fe
.\" Manpage for gfal-copy
.\"
.TH GFAL-COPY 1 "May 2017" "v1.5.0"
.TH GFAL-COPY 1 "March 2022" "v1.7.1"
.SH NAME
gfal-copy \- Copy files
.SH SYNOPSIS
......@@ -9,7 +9,10 @@ gfal-copy \- Copy files
.I OPTION
]...
.I SOURCE
.I DEST1 [ DEST2 ... ]
.I DEST1
[
.I DEST2
]...
.SH DESCRIPTION
.B gfal-copy
......@@ -26,59 +29,83 @@ output version information and exit.
.B "-v, --verbose"
verbose mode. Repeat up to 3 times for the most verbose mode.
.TP
.BI "-D, --definition"
define properties for gfal2.
.TP
.BI "-C, --client-info"
provide custom client-side information
.BI "-D, --definition " DEFINITION
define properties for gfal2. Definitions have the following syntax: "CONFIG_GROUP:KEY=VALUE"
.TP
.BI "-t, --timeout " TIMEOUT
maximum time for the operation to terminate - default is 1800 seconds. This timeout is enforced by gfal2-util, so it
applies to the overall operation. It should be greater or equal than --transfer-timeout.
global timeout for the execution of the command. Command is interrupted if time expires before it finishes. Note: A grace period of 30 seconds is given to the global timeout.
.TP
.BI "-E, --cert " CERT
user certificate
user certificate. (This option takes effect only after X509_USER_PROXY environment variable and default /tmp/x509up_u`id -u` location cannot provide a certificate)
.TP
.BI "--key " KEY
user private key
user private key.
.TP
.B "-4"
Forces gfal2-util to use IPv4 addresses only
forces Gfal2 to use IPv4 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-6"
Forces gfal2-util to use IPv6 addresses only
forces Gfal2 to use IPv6 addresses only. (Option valid only for GridFTP protocol)
.TP
.BI "-C, --client-info " CLIENT_INFO
provide custom client-side information.
.TP
.BI "--log-file " LOG_FILE
write Gfal2 library logs to the given file location.
.TP
.B "-f, --force"
if destination file(s) cannot be overwritten, delete it and try again
if destination file(s) cannot be overwritten, delete it and try again.
.TP
.B "-p, --parent"
if the destination directory does not exist, create it
if the destination directory does not exist, create it.
.TP
.BI "-n, --nbstreams " NBSTREAMS
specify the maximum number of parallel streams to use for the copy
specify the maximum number of parallel streams to use for the copy.
.TP
.BI "--tcp-buffersize " TCP_BUFFERSIZE
specify the TCP buffersize
specify the TCP buffersize.
.TP
.BI "-s, --src-spacetoken " SRC_SPACETOKEN
source spacetoken to use for the transfer
source spacetoken to use for the transfer.
.TP
.BI "-S, --dst-spacetoken " DST_SPACETOKEN
destination spacetoken to use for the transfer
destination spacetoken to use for the transfer.
.TP
.BI "-T, --transfer-timeout " TRANSFER_TIMEOUT
timeout for the transfer operation. This timeout is enforced by each plugin, so it applies to the transfer operation
only.
timeout for the transfer operation. This timeout is enforced by each plugin, so it applies to the transfer operation only. Ensure it is equal or smaller than "--timeout" setting.
.TP
.BI "-K, --checksum " CHECKSUM
checksum algorithm to use, or algorithm:value
checksum algorithm to use, or algorithm:value.
.TP
.BI "--checksum-mode " CHECKSUM_MODE
checksum validation mode: 'source', 'target' or 'both'.
.TP
.BI "--from-file " FROM_FILE
read sources from a file
read sources from a file.
.TP
.BI "--copy-mode " COPY_MODE
select the TPC copy mode: 'pull', 'push' or 'streamed'. (Option valid only for HTTP protocol)
.TP
.B "--just-copy"
just do the copy and skip any preparation (i.e. checksum, overwrite, etc.)
just do the copy and skip any preparation (i.e. checksum, overwrite, stats etc.). Warning: use of this switch is incompatible with the presence of directories in the argument list.
.TP
.B "--no-delegation"
disable TPC with proxy delegation.
.TP
.B "--evict"
evict source file from disk buffer when the transfer is finished.
.TP
.B "--scitag" SCITAG
SciTag transfer flow identifier (number in [65-65535] range) (available only for HTTP-TPC)
.TP
.B "-r, --recursive"
copy directories recursively.
.TP
.B "--abort-on-failure"
abort the whole copy as soon as one failure is encountered.
.TP
.B "--dry-run"
print what would have happened without any actual change.
.SH EXAMPLES
.TP
......@@ -109,12 +136,26 @@ Duarte Meneses <duarte.meneses@cern.ch>
Adrien Devresse <adrien.devresse@cern.ch>
.br
Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.br
Andrea Manzi <andrea.manzi@cern.ch>
.br
Mihai Patrascoiu <mihai.patrascoiu@cern.ch>
.br
Joao Lopes <joao.pedro.batista.lopes@cern.ch>
.SH "SEE ALSO"
.BR gfal-cat (1),
.BR gfal-chmod (1),
.BR gfal-copy (1),
.BR gfal-ls (1),
.BR gfal-mkdir (1),
.BR gfal-rename (1),
.BR gfal-rm (1),
.BR gfal-cat (1),
.BR gfal-save (1),
.BR gfal-mkdir (1),
.BR gfal-ls (1),
.BR gfal-xattr (1)
.BR gfal-stat (1),
.BR gfal-sum (1),
.BR gfal-token (1),
.BR gfal-xattr (1),
.BR gfal-evict (1),
.BR gfal-bringonline (1),
.BR gfal-archivepoll (1)
doc/man/gfal-evict.1 0 → 100644
View file @ ba4633fe
.\" Manpage for gfal-evict
.\"
.TH GFAL-EVICT 1 "April 2021" "v1.8.0"
.SH NAME
gfal-evict \- Evict file from a disk buffer
.SH SYNOPSIS
.B gfal-evict
[
.I "OPTION"
]...
.I FILE
[
.I TOKEN
]
.SH DESCRIPTION
.B gfal-evict
This command evicts a file from a disk buffer
.SH OPTIONS
.TP
.B "-h, --help"
show help about the command.
.TP
.B "-V, --version"
output version information and exit.
.TP
.B "-v, --verbose"
verbose mode. Repeat up to 3 times for the most verbose mode.
.TP
.B "-D, --definition"
define properties for gfal2.
.TP
.B "-C, --client-info"
provide custom client-side information
.TP
.B "-t, --timeout"
global timeout for the execution of the command. Command is interrupted if time expires before it finishes.
.TP
.B "-E, --cert"
user certificate
.TP
.B "--key"
user private key
.TP
.B FILE
URI to the file to be evicted
.TP
.B TOKEN
The token from the bring online request. Optional argument for some protocols (For example: xrootd)
.TP
.SH EXAMPLES
.TP
Evict a file from a disk buffer
.B gfal-evict https://endpoint.cern.ch/path/file
.SH FILES
.I /etc/gfal2.d/*
.RS
All configuration files in this directory affect the behavior of the underlying gfal2.
.SH AUTHORS
Duarte Meneses <duarte.meneses@cern.ch>
.br
Adrien Devresse <adrien.devresse@cern.ch>
.br
Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.br
Mihai Patrascoiu <mihai.patrascoiu@cern.ch>
.br
Joao Lopes <joao.pedro.batista.lopes@cern.ch>
.SH "SEE ALSO"
.BR gfal-cat (1),
.BR gfal-chmod (1),
.BR gfal-copy (1),
.BR gfal-ls (1),
.BR gfal-mkdir (1),
.BR gfal-rename (1),
.BR gfal-rm (1),
.BR gfal-save (1),
.BR gfal-stat (1),
.BR gfal-sum (1),
.BR gfal-xattr (1)
.BR gfal-bringonline (1)
.BR gfal-archivepoll (1)
doc/man/gfal-legacy-register.1
View file @ ba4633fe
.\" Manpage for gfal-save
.\"
.TH GFAL-LEGACY-REGISTER "May 2017" "v1.5.0"
.TH GFAL-LEGACY-REGISTER 1 "May 2017" "v1.5.0"
.SH NAME
gfal-legacy-register \- register a replica
.SH SYNOPSIS
......
doc/man/gfal-ls.1
View file @ ba4633fe
.\" Manpage for gfal-ls
.\"
.TH GFAL-LS 1 "May 2017" "v1.5.0"
.TH GFAL-LS 1 "March 2022" "v1.7.1"
.SH NAME
gfal-ls \- list directory contents or file information
.SH SYNOPSIS
.B gfal-ls [-h] [-V] [-v] [-D DEFINITION] [-C CLIENT-INFO] [-t TIMEOUT] [-a] [-l] [-d] [-H] file
.B gfal-ls
[
.I "OPTION"
]...
.I FILE
.SH DESCRIPTION
.B gfal-ls
......@@ -13,7 +17,7 @@ List information about the file. Depending on the implementation, some informati
.SH OPTIONS
.TP
.B "-h, --help"
show help about the command
show help about the command.
.TP
.B "-V, --version"
output version information and exit.
......@@ -21,14 +25,29 @@ output version information and exit.
.B "-v, --verbose"
verbose mode. Repeat up to 3 times for the most verbose mode.
.TP
.B "-D, --definition"
define properties for gfal2.
.BI "-D, --definition " DEFINITION
define properties for gfal2. Definitions have the following syntax: "CONFIG_GROUP:KEY=VALUE"
.TP
.BI "-t, --timeout " TIMEOUT
global timeout for the execution of the command. Command is interrupted if time expires before it finishes. Note: A grace period of 30 seconds is given to the global timeout.
.TP
.BI "-E, --cert " CERT
user certificate. (This option takes effect only after X509_USER_PROXY environment variable and default /tmp/x509up_u`id -u` location cannot provide a certificate)
.TP
.BI "--key " KEY
user private key.
.TP
.B "-4"
forces Gfal2 to use IPv4 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-C, --client-info"
provide custom client-side information
.B "-6"
forces Gfal2 to use IPv6 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-t, --timeout"
global timeout for the execution of the command. Command is interrupted if time expires before it finishes.
.BI "-C, --client-info " CLIENT_INFO
provide custom client-side information.
.TP
.BI "--log-file " LOG_FILE
write Gfal2 library logs to the given file location.
.TP
.B "-a, --all"
don't hide files with name starting in '.'.
......@@ -40,16 +59,19 @@ long listing format. Following columns are displayed for each entry: mode, numbe
list directory entries instead of its contents.
.TP
.B "-H, --human-readable"
with -l, print sizes in human readable format (e.g., 1K 234M 2G).
with -l, print sizes in human readable format (e.g.: 1K, 234M, 2G).
.TP
.BI "--xattr " XATTR
with -l, query additional attributes. Can be specified multiple times.
.TP
.B "--time-style"
time style. supports locale, iso, long-iso and full-iso (partially)
.BI "--time-style " STYLE
specify the time style. Supports the following values: locale, iso, long-iso or full-iso (partially).
.TP
.B "--full-time"
equivalent to --time-style=full-iso
equivalent to --time-style=full-iso.
.TP
.B "--color"
enable or disable color output. supports always, never, auto.
.BI "--color " MODE
with -l, enable or disable color output. Supports the following values: always, never, auto.
.SH EXAMPLES
.TP
......@@ -73,6 +95,12 @@ Duarte Meneses <duarte.meneses@cern.ch>
Adrien Devresse <adrien.devresse@cern.ch>
.br
Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.br
Andrea Manzi <andrea.manzi@cern.ch>
.br
Mihai Patrascoiu <mihai.patrascoiu@cern.ch>
.br
Joao Lopes <joao.pedro.batista.lopes@cern.ch>
.SH "SEE ALSO"
.BR gfal-cat (1),
......@@ -85,4 +113,8 @@ Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.BR gfal-save (1),
.BR gfal-stat (1),
.BR gfal-sum (1),
.BR gfal-xattr (1)
\ No newline at end of file
.BR gfal-token (1),
.BR gfal-xattr (1),
.BR gfal-evict (1),
.BR gfal-bringonline (1),
.BR gfal-archivepoll (1)
doc/man/gfal-mkdir.1
View file @ ba4633fe
.\" Manpage for gfal-mkdir
.\"
.TH GFAL-MKDIR 1 "May 2017" "v1.5.0"
.TH GFAL-MKDIR 1 "March 2022" "v1.7.1"
.SH NAME
gfal-mkdir \- make directories
.SH SYNOPSIS
.B gfal-mkdir
[
.B "-h"
] [
.B -V
] [
.B -v
] [
.B -D
.I DEFINITION
] [
.B -C
.I CLIENT-INFO
] [
.B -t
.I TIMEOUT
] [
.B -p
] \fIDIRECTORY\fR...
.I "OPTION"
]...
\fIDIRECTORY\fR...
.SH DESCRIPTION
.B gfal-mkdir
......@@ -40,20 +25,35 @@ output version information and exit.
.B "-v, --verbose"
verbose mode. Repeat up to 3 times for the most verbose mode.
.TP
.B "-D, --definition"
define properties for gfal2.
.BI "-D, --definition " DEFINITION
define properties for gfal2. Definitions have the following syntax: "CONFIG_GROUP:KEY=VALUE"
.TP
.BI "-t, --timeout " TIMEOUT
global timeout for the execution of the command. Command is interrupted if time expires before it finishes. Note: A grace period of 30 seconds is given to the global timeout.
.TP
.BI "-E, --cert " CERT
user certificate. (This option takes effect only after X509_USER_PROXY environment variable and default /tmp/x509up_u`id -u` location cannot provide a certificate)
.TP
.BI "--key " KEY
user private key.
.TP
.B "-4"
forces Gfal2 to use IPv4 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-C, --client-info"
provide custom client-side information
.B "-6"
forces Gfal2 to use IPv6 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-t, --timeout"
global timeout for the execution of the command. Command is interrupted if time expires before it finishes.
.BI "-C, --client-info " CLIENT_INFO
provide custom client-side information.
.TP
.B "-m, --mode"
set file mode (as in chmod). If not specified, 0755 is used. Depending on the storage implementation, it might not be used.
.BI "--log-file " LOG_FILE
write Gfal2 library logs to the given file location.
.TP
.BI "-m, --mode " MODE
set file mode (default is 0755). Depending on the storage implementation, it might not be used.
.TP
.B "-p, --parents"
no error if existing, make parent directories as needed.
make parent directories as needed. Reports no error if directory exists.
.SH EXAMPLES
.TP
......@@ -75,6 +75,12 @@ Duarte Meneses <duarte.meneses@cern.ch>
Adrien Devresse <adrien.devresse@cern.ch>
.br
Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.br
Andrea Manzi <andrea.manzi@cern.ch>
.br
Mihai Patrascoiu <mihai.patrascoiu@cern.ch>
.br
Joao Lopes <joao.pedro.batista.lopes@cern.ch>
.SH "SEE ALSO"
.BR gfal-cat (1),
......@@ -87,4 +93,8 @@ Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.BR gfal-save (1),
.BR gfal-stat (1),
.BR gfal-sum (1),
.BR gfal-xattr (1)
\ No newline at end of file
.BR gfal-token (1),
.BR gfal-xattr (1),
.BR gfal-evict (1),
.BR gfal-bringonline (1),
.BR gfal-archivepoll (1)
doc/man/gfal-rename.1
View file @ ba4633fe
.\" Manpage for gfal-rename
.\"
.TH GFAL-RENAME 1 "May 2017" "v1.5.0"
.TH GFAL-RENAME 1 "March 2022" "v1.7.1"
.SH NAME
gfal-rename \- Renames files or directories
.SH SYNOPSIS
.B gfal-rename
[
.B "-h"
] [
.B -V
] [
.B -v
] [
.B -D
.I DEFINITION
] [
.B -C
.I CLIENT-INFO
] [
.B -t
.I TIMEOUT
]
.I "OPTION"
]...
.I SOURCE
.I DESTINATION
......@@ -39,26 +26,29 @@ output version information and exit.
.B "-v, --verbose"
verbose mode. Repeat up to 3 times for the most verbose mode.
.TP
.B "-D, --definition"
define properties for gfal2.
.BI "-D, --definition " DEFINITION
define properties for gfal2. Definitions have the following syntax: "CONFIG_GROUP:KEY=VALUE"
.TP
.B "-C, --client-info"
provide custom client-side information
.BI "-t, --timeout " TIMEOUT
global timeout for the execution of the command. Command is interrupted if time expires before it finishes. Note: A grace period of 30 seconds is given to the global timeout.
.TP
.B "-t, --timeout"
global timeout for the execution of the command. Command is interrupted if time expires before it finishes.
.BI "-E, --cert " CERT
user certificate. (This option takes effect only after X509_USER_PROXY environment variable and default /tmp/x509up_u`id -u` location cannot provide a certificate)
.TP
.B "-E, --cert"
user certificate
.TP
.B "--key"
user private key
.BI "--key " KEY
user private key.
.TP
.B "-4"
Forces gfal2-util to use IPv4 addresses only (if the plugin supports this)
forces Gfal2 to use IPv4 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-6"
Forces gfal2-util to use IPv6 addresses only (if the plugin supports this)
forces Gfal2 to use IPv6 addresses only. (Option valid only for GridFTP protocol)
.TP
.BI "-C, --client-info " CLIENT_INFO
provide custom client-side information.
.TP
.BI "--log-file " LOG_FILE
write Gfal2 library logs to the given file location.
.SH EXAMPLES
.TP
......@@ -76,6 +66,12 @@ Duarte Meneses <duarte.meneses@cern.ch>
Adrien Devresse <adrien.devresse@cern.ch>
.br
Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.br
Andrea Manzi <andrea.manzi@cern.ch>
.br
Mihai Patrascoiu <mihai.patrascoiu@cern.ch>
.br
Joao Lopes <joao.pedro.batista.lopes@cern.ch>
.SH "SEE ALSO"
.BR gfal-cat (1),
......@@ -88,4 +84,8 @@ Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.BR gfal-save (1),
.BR gfal-stat (1),
.BR gfal-sum (1),
.BR gfal-xattr (1)
\ No newline at end of file
.BR gfal-token (1),
.BR gfal-xattr (1),
.BR gfal-evict (1),
.BR gfal-bringonline (1),
.BR gfal-archivepoll (1)
doc/man/gfal-rm.1
View file @ ba4633fe
.\" Manpage for gfal-rm
.\"
.TH GFAL-RM 1 "May 2017" "v1.5.0"
.TH GFAL-RM 1 "March 2022" "v1.7.1"
.SH NAME
gfal-rm \- Remove files or directories
.SH SYNOPSIS
.B gfal-rm
[
.B "-h"
] [
.B -V
] [
.B -v
] [
.B -D
.I DEFINITION
] [
.B -C
.I CLIENT-INFO
] [
.B -t
.I TIMEOUT
] [
.B -r
] \fIFILE\fR...
.I "OPTION"
]...
\fIFILE\fR...
.SH DESCRIPTION
.B gfal-rm
Removes each specified file or directory. By default, it does not remove directories. To delete a directory, --recursive needs to be given, in which case all given directories are removed too along with all their contents.
Removes each specified file or directory. By default, it does not remove directories. To delete a directory, --recursiv needs to be given, in which case all given directories are removed too along with all their contents.
.SH OPTIONS
.TP
......@@ -39,17 +25,41 @@ output version information and exit.
.B "-v, --verbose"
verbose mode. Repeat up to 3 times for the most verbose mode.
.TP
.B "-D, --definition"
define properties for gfal2.
.BI "-D, --definition " DEFINITION
define properties for gfal2. Definitions have the following syntax: "CONFIG_GROUP:KEY=VALUE"
.TP
.B "-C, --client-info"
provide custom client-side information
.BI "-t, --timeout " TIMEOUT
global timeout for the execution of the command. Command is interrupted if time expires before it finishes. Note: A grace period of 30 seconds is given to the global timeout.
.TP
.B "-t, --timeout"
global timeout for the execution of the command. Command is interrupted if time expires before it finishes.
.BI "-E, --cert " CERT
user certificate. (This option takes effect only after X509_USER_PROXY environment variable and default /tmp/x509up_u`id -u` location cannot provide a certificate)
.TP
.B "-r, --recursive"
also remove directories and their contents recursively.
.BI "--key " KEY
user private key.
.TP
.B "-4"
forces Gfal2 to use IPv4 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-6"
forces Gfal2 to use IPv6 addresses only. (Option valid only for GridFTP protocol)
.TP
.BI "-C, --client-info " CLIENT_INFO
provide custom client-side information.
.TP
.BI "--log-file " LOG_FILE
write Gfal2 library logs to the given file location.
.TP
.B "-r, -R, --recursive"
remove directories and their contents recursively.
.TP
.B "--dry-run"
print what would have happened without any actual change.
.TP
.B "--just-delete"
do not perform any check on the file prior to delete. (Needed to delete HTTP signed URLs)
.TP
.BI "--from-file " FROM_FILE
read SURLs from a file.
.TP
.B "--bulk"
perform bulk deletion.
......@@ -74,6 +84,12 @@ Duarte Meneses <duarte.meneses@cern.ch>
Adrien Devresse <adrien.devresse@cern.ch>
.br
Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.br
Andrea Manzi <andrea.manzi@cern.ch>
.br
Mihai Patrascoiu <mihai.patrascoiu@cern.ch>
.br
Joao Lopes <joao.pedro.batista.lopes@cern.ch>
.SH "SEE ALSO"
.BR gfal-cat (1),
......@@ -86,4 +102,8 @@ Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.BR gfal-save (1),
.BR gfal-stat (1),
.BR gfal-sum (1),
.BR gfal-xattr (1)
\ No newline at end of file
.BR gfal-token (1),
.BR gfal-xattr (1),
.BR gfal-evict (1),
.BR gfal-bringonline (1),
.BR gfal-archivepoll (1)
doc/man/gfal-save.1
View file @ ba4633fe
.\" Manpage for gfal-save
.\"
.TH GFAL-SAVE 1 "May 2017" "v1.5.0"
.TH GFAL-SAVE 1 "March 2022" "v1.7.1"
.SH NAME
gfal-mkdir \- make directories
gfal-save \- read from standard input and write it to a file
.SH SYNOPSIS
.B gfal-save
[
.B "-h"
] [
.B -V
] [
.B -v
] [
.B -D
.I DEFINITION
] [
.B -C
.I CLIENT-INFO
] [
.B -t
.I TIMEOUT
] \fI file\fR ...
.I "OPTION"
]...
.I FILE
.SH DESCRIPTION
.B gfal-save
......@@ -37,17 +25,29 @@ output version information and exit.
.B "-v, --verbose"
verbose mode. Repeat up to 3 times for the most verbose mode.
.TP
.B "-D, --definition"
define properties for gfal2.
.BI "-D, --definition " DEFINITION
define properties for gfal2. Definitions have the following syntax: "CONFIG_GROUP:KEY=VALUE"
.TP
.B "-C, --client-info"
provide custom client-side information
.BI "-t, --timeout " TIMEOUT
global timeout for the execution of the command. Command is interrupted if time expires before it finishes. Note: A grace period of 30 seconds is given to the global timeout.
.TP
.B "-t, --timeout"
global timeout for the execution of the command. Command is interrupted if time expires before it finishes.
.BI "-E, --cert " CERT
user certificate. (This option takes effect only after X509_USER_PROXY environment variable and default /tmp/x509up_u`id -u` location cannot provide a certificate)
.TP
.B file
destination file where the contents read from stdin will be written to.
.BI "--key " KEY
user private key.
.TP
.B "-4"
forces Gfal2 to use IPv4 addresses only. (Option valid only for GridFTP protocol)
.TP
.B "-6"
forces Gfal2 to use IPv6 addresses only. (Option valid only for GridFTP protocol)
.TP
.BI "-C, --client-info " CLIENT_INFO
provide custom client-side information.
.TP
.BI "--log-file " LOG_FILE
write Gfal2 library logs to the given file location.
.SH EXAMPLES
.TP
......@@ -67,6 +67,12 @@ Duarte Meneses <duarte.meneses@cern.ch>
Adrien Devresse <adrien.devresse@cern.ch>
.br
Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.br
Andrea Manzi <andrea.manzi@cern.ch>
.br
Mihai Patrascoiu <mihai.patrascoiu@cern.ch>
.br
Joao Lopes <joao.pedro.batista.lopes@cern.ch>
.SH "SEE ALSO"
.BR gfal-cat (1),
......@@ -79,4 +85,8 @@ Alejandro Alvarez Ayllon <alejandro.alvarez.ayllon@cern.ch>
.BR gfal-save (1),
.BR gfal-stat (1),
.BR gfal-sum (1),
.BR gfal-xattr (1)
\ No newline at end of file
.BR gfal-token (1),
.BR gfal-xattr (1),
.BR gfal-evict (1),
.BR gfal-bringonline (1),
.BR gfal-archivepoll (1)