0x80
/
rsstube
1
1
Fork 0
Code Issues 6 Pull Requests Projects Releases Wiki Activity

Correct readme formatting and spelling.

This commit is contained in:
0x80 2021-12-30 00:00:00 +00:00
parent 8c02d3854b
commit e4c6bb14d9
Signed by: 0x80
GPG Key ID: 68368BCBC000EF51
1 changed files with 36 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@ -78,56 +78,59 @@ If you installed rsstube another way (manual download, package manager), update
Here are the options that work right now. Here are the options that work right now.
### Informational ### Informational
-h, --help Print help text and exit. -h, --help Print help text and exit.
--license Print license declaration and exit. --license Print license declaration and exit.
--sites Print list of supported sites and exit. --sites Print list of supported sites and exit.
--version Print version and exit. --version Print version and exit.
### General Options ### General Options
-n, --non-network (Offline mode.) Only return feed URL if -n, --non-network (Offline mode.) Only return feed URL if
it can be determined without downloading it can be determined without downloading
any pages. any pages.
-o, --output FILENAME Output results to FILENAME rather than -o, --output FILENAME Output results to FILENAME rather than
console. (If FILENAME is an empty console. (If FILENAME is an empty
string, rsstube will output to the string, rsstube will output to the
console.) console.)
--output-format [ompl|url] Specify which output format to use. --output-format [opml|url] Specify which output format to use.
[Default: url] [Default: url]
--unbreak Attempt to work with hostile websites --unbreak Attempt to work with hostile websites
(e.g., those that use Cloudflare). (e.g., those that use Cloudflare).
-U, --update Update rsstube (only works if -U, --update Update rsstube (only works if
downloaded with git). downloaded with git).
### Verbosity ### Verbosity
--verbosity [0-4] Specify how much output you want. | MESSAGE TYPE | REQUIRED VERBOSITY |
Higher number means more messages. | ------------ | ------------------ |
[Default: 3] | Debug | 4 |
| MESSAGE TYPE | REQUIRED VERBOSITY | | Notify | 3 |
| ------------ | ------------------ | | Warn | 2 |
| Debug | 4 | | Error | 1 |
| Notify | 3 |
| Warn | 2 |
| Error | 1 |
-v, --verbose Show: all. Same as --verbosity 4. --verbosity [0-4] Specify how much output you want.
[Default: 3]
-q, --quiet Show: Error. Suppress: Warn, Notify, -v, --verbose Show: all.
Debug. Same as --verbosity 1. Same as --verbosity 4.
--suppress-errors Suppress: all. Same as --verbosity 0. -q, --quiet Show: Error.
Suppress: Warn, Notify, Debug.
Same as --verbosity 1.
--suppress-errors Suppress: all.
Same as --verbosity 0.
### Networking (PycURL args) ### Networking (PycURL args)
-A, --user-agent UA_STRING Specify custom user-agent string. -A, --user-agent UA_STRING Specify custom user-agent string.
-H, --header HEADER Add a header. Use it multiple times to -H, --header HEADER Add a header. Use it multiple times to
add multiple headers. add multiple headers.
## Scope ## Scope