Specify working options in readme.

This commit is contained in:
0x80 2021-12-30 00:00:00 +00:00
parent 8f49afdc86
commit 8c02d3854b
Signed by: 0x80
GPG Key ID: 68368BCBC000EF51
1 changed files with 52 additions and 1 deletions

View File

@ -75,8 +75,59 @@ If you installed rsstube another way (manual download, package manager), update
`rsstube <link>` `rsstube <link>`
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 ## Scope