pictuga/morss
1
1
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

README: decent line length

Browse Source 
Obtained from the output of:
python -m morss --help | cat
This commit is contained in:
pictuga
2020-09-15 23:01:42 +02:00
parent 9ecf856f10
commit b290568e14
1 changed files with 25 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -77,8 +77,11 @@ cases" below is detailed how to pass those arguments to morss.
The list of arguments can be obtained by running `morss --help` The list of arguments can be obtained by running `morss --help`
``` ```
usage: morss [-h] [--format {rss,json,html,csv}] [--search STRING] [--clip] [--indent] [--cache] [--force] [--proxy] [--newest] [--firstlink] [--items XPATH] [--item_link XPATH] usage: morss [-h] [--format {rss,json,html,csv}] [--search STRING] [--clip]
[--item_title XPATH] [--item_content XPATH] [--item_time XPATH] [--nolink] [--noref] [--silent] [--indent] [--cache] [--force] [--proxy] [--newest] [--firstlink]
[--resolve] [--items XPATH] [--item_link XPATH]
[--item_title XPATH] [--item_content XPATH] [--item_time XPATH]
[--nolink] [--noref] [--silent]
url url
Get full-text RSS feeds Get full-text RSS feeds
@@ -93,28 +96,38 @@ output:
--format {rss,json,html,csv} --format {rss,json,html,csv}
output format output format
--search STRING does a basic case-sensitive search in the feed --search STRING does a basic case-sensitive search in the feed
--clip stick the full article content under the original feed content (useful for twitter) --clip stick the full article content under the original feed
--indent returns indented XML or JSON, takes more place, but human-readable content (useful for twitter)
--indent returns indented XML or JSON, takes more place, but
human-readable
action: action:
--cache only take articles from the cache (ie. don't grab new articles' content), so as to save time --cache only take articles from the cache (ie. don't grab new
articles' content), so as to save time
--force force refetch the rss feed and articles --force force refetch the rss feed and articles
--proxy doesn't fill the articles --proxy doesn't fill the articles
--newest return the feed items in chronological order (morss ohterwise shows the items by appearing order) --newest return the feed items in chronological order (morss
--firstlink pull the first article mentioned in the description instead of the default link ohterwise shows the items by appearing order)
--resolve replace tracking links with direct links to articles (not compatible with --proxy) --firstlink pull the first article mentioned in the description
instead of the default link
--resolve replace tracking links with direct links to articles
(not compatible with --proxy)
custom feeds: custom feeds:
--items XPATH (mandatory to activate the custom feeds function) xpath rule to match all the RSS entries --items XPATH (mandatory to activate the custom feeds function)
--item_link XPATH xpath rule relative to items to point to the entry's link xpath rule to match all the RSS entries
--item_link XPATH xpath rule relative to items to point to the entry's
link
--item_title XPATH entry's title --item_title XPATH entry's title
--item_content XPATH entry's content --item_content XPATH entry's content
--item_time XPATH entry's date & time (accepts a wide range of time formats) --item_time XPATH entry's date & time (accepts a wide range of time
formats)
misc: misc:
--nolink drop links, but keeps links' inner text --nolink drop links, but keeps links' inner text
--noref drop items' link --noref drop items' link
--silent don't output the final RSS (useless on its own, but can be nice when debugging) --silent don't output the final RSS (useless on its own, but
can be nice when debugging)
GNU AGPLv3 code GNU AGPLv3 code
``` ```