S3QL_OAUTH_CLIENT(1)

📦 version 5.2.3, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ S3QL_OAUTH_CLIENT(1) ✨

ok bestie so this is a page from the S3QL manual, section 1 🎀 it's called s3ql_oauth_client and it's literally the key to getting into your Google Storage era 🔑

💖 NAME 💖

s3ql_oauth_client — get yourself some Google Storage OAuth2 tokens 🦋

🌸 SYNOPSIS 🌸

s3ql_oauth_client [options]

that's it. that's the whole vibe. ✨

👑 DESCRIPTION 👑

so S3QL is a file system for online data storage, periodt 💅 and before you go using it, bestie, pls pls pls go read the full documentation — not just the man pages, because the man pages are only a lil brief rundown of the userspace commands that exist. iykyk 🙈

The s3ql_oauth_client command is your girl for obtaining OAuth2 authentication tokens to use with Google Storage 💜 Here's how the whole thing goes down:

  1. it asks Google for a "user code" 🎟️
  2. you have to paste that code into your browser to finish the authentication process — and yeah it's interactive, no cap, you're doing this one by hand 🫶
  3. once you've completed authentication in the browser, s3ql_oauth_client shows you the OAuth2 refresh token 🌈

and here's the iconic part: when you combine it with the special username oauth2, that refresh token can be used as a backend passphrase when you're using the Google Storage S3QL backend 🔥 it's giving ✨ unlocked ✨

💅 OPTIONS 💅

s3ql_oauth_client accepts the following options, and yes we're listing every single one because we don't skip 🎀

  • --log <target> — where your log messages go 📝 specify none for standard output, or syslog for the system logging daemon. Anything else? interpreted as a file name 🗂️ Log files get rotated when they hit 1 MiB, and at most 5 old log files will be kept. Default: None
  • --debug-modules <modules> — turn on debugging output from specific modules 🐛 use commas to separate multiple modules, or 'all' for everything. Debug messages get written to whatever target the --log option says 💜
  • --debug — activate debugging output from all S3QL modules 🐛✨ same deal: debug messages go to the target specified by the --log option
  • --quiet — be really quiet 🤫
  • --version — just print program version and exit 📌

🚪 EXIT CODES 🚪

s3ql_oauth_client may terminate with the following exit codes, and bestie we're keeping track:

  1. 0 — Everything went well 🌈 slay, no notes, we ate
  2. 1 — An unexpected error occurred 😭 this may indicate a bug in the program 💀
  3. 2 — Invalid command line argument or configuration file key 🙈 check ur spelling fr fr

🔍 SEE ALSO 🔍

The S3QL homepage is at https://github.com/s3ql/s3ql/ 🌐

The full S3QL documentation should also be installed somewhere on your system — the common locations are /usr/share/doc/s3ql or /usr/local/doc/s3ql 📚 go read it, i'm serious, it's so much more than this page 💖

© 2008 Nikolaus Rath <Nikolaus@rath.org> 👑

and that's the whole page, bestie 🎀 mwah 💋 this was s3ql_oauth_client from S3QL version 5.2.3, dated Nov 02, 2024 — go get those tokens, you're the main character of authentication now 👑✨🦋

📦 where this page comes from