From 8c02d3854b1ccac1c90fa94fcb4753b662f59c7c Mon Sep 17 00:00:00 2001 From: 0x80 <0x80@negativezero.link> Date: Thu, 30 Dec 2021 00:00:00 +0000 Subject: [PATCH] Specify working options in readme. --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6571e2c..e7272c7 100644 --- a/README.md +++ b/README.md @@ -75,8 +75,59 @@ If you installed rsstube another way (manual download, package manager), update `rsstube ` -There are some options, but most of them don't work yet. +Here are the options that work right now. +### Informational + -h, --help Print help text and exit. + + --license Print license declaration and exit. + + --sites Print list of supported sites and exit. + + --version Print version and exit. + +### General Options + -n, --non-network (Offline mode.) Only return feed URL if + it can be determined without downloading + any pages. + + -o, --output FILENAME Output results to FILENAME rather than + console. (If FILENAME is an empty + string, rsstube will output to the + console.) + + --output-format [ompl|url] Specify which output format to use. + [Default: url] + + --unbreak Attempt to work with hostile websites + (e.g., those that use Cloudflare). + + -U, --update Update rsstube (only works if + downloaded with git). + +### Verbosity + --verbosity [0-4] Specify how much output you want. + Higher number means more messages. + [Default: 3] + | MESSAGE TYPE | REQUIRED VERBOSITY | + | ------------ | ------------------ | + | Debug | 4 | + | Notify | 3 | + | Warn | 2 | + | Error | 1 | + + -v, --verbose Show: all. Same as --verbosity 4. + + -q, --quiet Show: Error. Suppress: Warn, Notify, + Debug. Same as --verbosity 1. + + --suppress-errors Suppress: all. Same as --verbosity 0. + +### Networking (PycURL args) + -A, --user-agent UA_STRING Specify custom user-agent string. + + -H, --header HEADER Add a header. Use it multiple times to + add multiple headers. ## Scope