commit 6f4dbe911948fff928721c7b926b230abff14321 parent 71e9c93590445139848853eb03915cbd879b47f1 Author: Hiltjo Posthuma <hiltjo@codemadness.org> Date: Tue, 23 Nov 2021 16:35:36 +0100 sfeed.1: add a basic usage example for using the sfeed package "man sfeed" now hopefully more quickly gives a better overview how the tools work together. Reference the README for extended examples and use-cases. Diffstat:
| M | sfeed.1 | | | 32 | ++++++++++++++++++++++++++++++++ |
1 file changed, 32 insertions(+), 0 deletions(-)
diff --git a/sfeed.1 b/sfeed.1 @@ -55,6 +55,38 @@ Item, categories, multiple values are separated by the '|' character. .Bd -literal curl -s 'https://codemadness.org/atom.xml' | sfeed .Ed +.Sh EXAMPLE SETUP +1. Create a directory for the sfeedrc configuration and the feeds: +.Bd -literal + mkdir -p ~/.sfeed/feeds +.Ed +.Pp +2. Copy the example +.Xr sfeedrc 5 +configuration: +.Bd -literal + cp sfeedrc.example ~/.sfeed/sfeedrc + $EDITOR ~/.sfeed/sfeedrc +.Ed +.Pp +Or import existing OPML subscriptions using +.Xr sfeed_opml_import 1 : +.Bd -literal + sfeed_opml_import < file.opml > ~/.sfeed/sfeedrc +.Ed +.Pp +3. To update feeds and merge the new items with existing items: +.Bd -literal + sfeed_update +.Ed +.Pp +4. Format feeds to a plain-text list using one of the included format programs +.Xr sfeed_plain 1 : +.Bd -literal + sfeed_plain ~/.sfeed/feeds/* +.Ed +.Pp +The README file has more examples. .Sh SEE ALSO .Xr sfeed_plain 1 , .Xr sfeed_update 1 ,