The fsck.s3ql command

Synopsis

fsck.s3ql [options] <storage url>

Description

The fsck.s3ql command checks the file system in the location specified by storage url for errors and attempts to repair any problems. The format of 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.

Options

The fsck.s3ql command accepts the following options.

--authfile <path>

Read authentication credentials from this file (default: /home/nikratio/.s3ql/authinfo2).

--cachedir <path>

Store cached data in this directory (default: /home/nikratio/.s3ql).

--backend-options <options>

Backend specific options (separate by commas). See backend documentation for available options.

--keep-cache

Do not purge locally cached files on exit.

--batch

If user input is required, exit without prompting.

--force

Force checking even if file system is marked clean.

--force-remote

Force use of remote metadata even when this would likely result in data loss.

--fast

Run a faster, less thorough check.

--max-connections <no>

Maximum number of concurrent backend I/O operations (default: 32). This is independent of –max-threads, which governs compression.

--max-threads <no>

Number of parallel compression/encryption threads to use (default: auto). This bounds CPU parallelism only and is independent of –max- connections.

--log <target>

Destination for log messages. Specify ‘none’ for standard output or ‘syslog’ for the system logging daemon. Anything else is interpreted as a file name. Log files are rotated when they reach 1 MiB, keeping at most 5 old files. [default: /home/nikratio/.s3ql/fsck.log]

--debug

Activate debugging output from all S3QL modules. Debug messages are written to the destination given by –log.

--debug-modules <module>

Activate debugging output from the named module. May be given multiple times; use ‘all’ for everything. Debug messages are written to the destination given by –log.

--quiet

be really quiet

--install-completion

Install completion for the current shell.

--show-completion

Show completion for the current shell, to copy it or customize the installation.

--help

Show this message and exit.

Exit Codes

If fsck.s3ql found any file system errors (no matter if they were corrected or not), the exit code will be 128 plus one of the codes listed below. If no errors were found, the following exit codes are used as-is:

0:

Everything went well.

1:

An unexpected error occurred. This may indicate a bug in the program.

2:

Invalid command line argument or configuration file key.

3:

Invalid backend option.

10:

Could not open log file for writing.

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.

32:

Unsupported file system revision (too old).

33:

Unsupported file system revision (too new).

40:

Cannot check mounted file system.

41:

User input required, but running in batch mode.

42:

File system check aborted by user.

43:

Local metadata is corrupted.

44:

Uncorrectable errors found.

45:

Unable to access cache directory.

128:

This error code will be added to one of the codes above if any file system errors have been found (no matter if they were corrected or not).

See Also

The S3QL homepage is at https://github.com/s3ql/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.