s3qladm [options] <action> <storage url>
where action may be either of passphrase, upgrade, delete or download-metadata.
The s3qladm command performs various operations on unmounted S3QL file systems. The file system must not be mounted when using s3qladm or things will go wrong badly.
The storage url depends on the backend that is used. The S3QL User’s Guide should be consulted for a description of the available backends.
The s3qladm command accepts the following options.
The following actions may be specified:
s3qladm may terminate with the following exit codes:
0: | Everything went well. |
---|---|
1: | An unexpected error occured. This may indicate a bug in the program. |
2: | Invalid command line argument. |
3: | Invalid backend option. |
10: | Could not open log file for writing. |
11: | No such backend. |
12: | Authentication file has insecure permissions. |
13: | Unable to parse proxy settings. |
14: | Invalid credentials (Authentication failed). |
15: | No permission to access backend (Authorization denied). |
16: | Invalid storage URL, specified location does not exist in backend. |
17: | Wrong file system passphrase. |
18: | No S3QL file system found at given storage URL. |
19: | Unable to connect to backend, can’t resolve hostname. |
45: | Unable to access cache directory. |
The S3QL homepage is at https://bitbucket.org/nikratio/s3ql/.
The full S3QL documentation should also be installed somewhere on your system, common locations are /usr/share/doc/s3ql or /usr/local/doc/s3ql.