The s3ql_oauth_client command

Synopsis

s3ql_oauth_client [options]

Description

The s3ql_oauth_client command may be used to obtain OAuth2 authentication tokens for use with Google Storage. It requests a “user code” from Google which has to be pasted into the browser to complete the authentication process interactively. Once authentication in the browser has been completed, s3ql_oauth_client displays the OAuth2 refresh token.

When combined with the special username oauth2, the refresh token can be used as a backend passphrase when using the Google Storage S3QL backend.

Options

The s3ql_oauth_client command accepts the following options:

--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.

--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

s3ql_oauth_client may terminate with the following exit codes:

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.

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.