summaryrefslogtreecommitdiff
path: root/README
AgeCommit message (Collapse)Author
2021-03-01README: combine bandwidth saving options into one sectionHiltjo Posthuma
Combine E-Tags, If-Modified-Since in one section. Also mention the curl --compression option for typically GZIP decompression. Note that E-Tags were broken in curl <7.73 due to a bug with "weak" e-tags. https://github.com/curl/curl/issues/5610 From a question/feedback by e-mail from Hadrien Lacour, thanks.
2021-02-05sfeed_update: $SFEED_UPDATE_INCLUDE: be a bit more precise/pedanticHiltjo Posthuma
2021-01-28README: fix xargs -P example when there are no feedsHiltjo Posthuma
Kindof a non-issue but if theres a sfeedrc with no feeds then xargs will still be executed and give an error. The xargs -r option (GNU extension) fixes this: From the OpenBSD xargs(1) man page: "-r Do not run the command if there are no arguments. Normally the command is executed at least once even if there are no arguments." Reproducable with the sfeedrc: feeds() { true }
2021-01-27typofixesHiltjo Posthuma
2021-01-27README: add an example script to reuse the sfeed_update codeHiltjo Posthuma
This code uses the non-portable xargs -P option to more efficiently process feeds in parallel.
2021-01-22README: tested with laccHiltjo Posthuma
Interesting C compiler project: lacc: A simple, self-hosting C compiler: https://github.com/larmel/lacc
2021-01-16README: newsboat sqlite3 export script: improvementsHiltjo Posthuma
- Export read/unread state to a separate plain-text "urls" file, line by line. - Handle white-space control-chars better. From the sfeed(1) man page: " The fields: title, id, author are not allowed to have newlines and TABs, all whitespace characters are replaced by a single space character. Control characters are removed." So do the reverse for newsboat aswell: change white-space characters which are also control-characters (such as TABs and newlines) to a single space character.
2021-01-01README: add text about page redirects + tweak some words.Hiltjo Posthuma
... move sections around in a more logical order and tweak some words. Prompted by a question and feedback from Aleksei, thanks!
2021-01-01README: tested on MIPS32 (big-endian)Hiltjo Posthuma
2020-10-21README: filter example, filter Google Analytics utm_* parametersHiltjo Posthuma
https://support.google.com/analytics/answer/1033867?hl=nl
2020-10-18README: improve etag example with escaping of the filenameHiltjo Posthuma
Use the same base filename as the feed file, because sfeed_update replaces '/' in names with '_': filename="$(printf '%s' "$1" | tr '/' '_')" This fixes the example for fetching feeds with names containing '/'. Reported by __20h__, thanks!
2020-10-18README: add example to support ETag cachingHiltjo Posthuma
2020-10-16README: fix unescaped character in regex in awk in filter exampleHiltjo Posthuma
Found by testing using mawk.
2020-10-12README: filter example: strip Facebook fbclid parameterHiltjo Posthuma
2020-10-09README: tested with cproc and sdcc on Z80 emulator, for funHiltjo Posthuma
cproc: cproc: https://github.com/michaelforney/cproc qbe: https://c9x.me/compile/ z80 (sfeed base program) fuzix: http://www.fuzix.org/ RC2014 emulator: https://github.com/EtchedPixels/RC2014 sdcc: http://sdcc.sourceforge.net/
2020-07-05README: reference sfeed_cursesHiltjo Posthuma
2020-07-05README: improvementsHiltjo Posthuma
- Add an example to optimize bandwidth use with the curl -z option. - Add a note about CDNs blocking based on the User-Agent (based on a question mailed to me). - Add an script to convert existing newsboat items to the sfeed(5) TSV format.
2020-06-25README: small tweaks and a filter example improvementHiltjo Posthuma
This is a "quick&dirty" regex to block some of the typical 1px width or height tracking pixels.
2020-05-15README: fix indentation for fdm.conf examplesHiltjo Posthuma
No functional difference, but it should improve readability.
2020-05-01README: update tested platformsHiltjo Posthuma
- HPPA in qemu (OpenBSD). - FreeDOS + djgpp (+ wget with networking) in 32-bit mode.
2020-03-11README: update tested environmentsHiltjo Posthuma
2020-02-06README: simplify sfeed_archive example using awkHiltjo Posthuma
Also use a more portable date +'%s' (remove -j). NOTE though: date +'%s' is not POSIX, but it is supported in most cases.
2020-01-18improve README a bitHiltjo Posthuma
2020-01-18add sfeed_gopher: generic gopher formatting program, remove sfeed_gphHiltjo Posthuma
2019-11-24README: add rss2email OPML import exampleHiltjo Posthuma
2019-09-30README: remove wrong $LC_LOCALE, also remove $LC_ALL from examplesHiltjo Posthuma
2019-09-06README: minor typosHiltjo Posthuma
2019-09-06README: improve mail example and add an example similar to rss2emailHiltjo Posthuma
2019-08-22README, README.xml: improve some wordingHiltjo Posthuma
2019-07-27README: improve dmenu exampleHiltjo Posthuma
2019-06-11README: remove an old filename reference, simplify sfeed_update purpose hereHiltjo Posthuma
2019-05-15README and sfeed_update: use names (order vs sort) and in the execution orderHiltjo Posthuma
2019-05-10README: use HTTPS linksHiltjo Posthuma
2019-05-08README: add tail-like example in honor of the removed sfeed_tailHiltjo Posthuma
2019-05-06remove sfeed_tail and recently added security considerationsHiltjo Posthuma
... both are out-of-scope for sfeed. - sfeed_tail can be written as some simple customized awk script reading from a FIFO. The C version did not work well on FIFO's. - Security considerations are mentioned in the official HTML spec and applies to all HTML and protocol handlers, so is out-of-scope.
2019-05-02README: reword a bitHiltjo Posthuma
2019-05-02README: fix typo in pathHiltjo Posthuma
2019-05-02README: add security considerations, tweak preface a bitHiltjo Posthuma
2019-04-30improve READMEHiltjo Posthuma
- add preface text. - use "\t" pattern for awk (easier to read and copy-paste). - add a small example to get the most recent enclosure.
2019-04-22README: fix tiny formatting whitespaceHiltjo Posthuma
2019-04-20README: add sfeed_atom aggregate feed exampleHiltjo Posthuma
2019-04-20add sfeed_atom: convert one or more feeds from TSV (back to) AtomHiltjo Posthuma
2019-04-20README: update filter exampleHiltjo Posthuma
- Show how to filter protocol schemes more strictly. For example to allow only http://, https:// and gopher:// (not file://, javascript:, etc). - Filter links and now also enclosures.
2019-04-14sfeed_update: rename fetchfeed to fetchHiltjo Posthuma
... and simplify example in README.
2019-04-07README: change procmail parallel running, improve some wordsHiltjo Posthuma
make the procmail example safer due to account process limits.
2019-01-29document: minor reword, reference sfeedrc(5) in READMEHiltjo Posthuma
2019-01-25README: sfeed_frames still mentioned it output content, remove itHiltjo Posthuma
This was removed before, because of potential security issues in commit b7e288a96418e1ea5e7904ab2896edb3f4615a10 Thanks trqx for the feedback.
2019-01-25documentation improvementsHiltjo Posthuma
Man pages: - sfeed_update: fix: fetchfeed parameter documentation. - sfeed_update: fix/update: urls in sfeedrc.example. - sfeed_update: document maxjobs variable. - sfeedrc: document filter and order functions here. - more semantic keywords: function arguments and some Nm. README: - Document more clearly sfeedrc is a shellscript at the first usage "steps". - Add newsboat OPML export and import to sfeed_update example. - Document the Makefile is POSIX (not some GNU/Makefile). - Add reference to my tool hurl: a HTTP/HTTPS/Gopher file grab client. - Describe the reason/usefulness of the filter example. - Describe how to override curl(1), an optional dependency. With feedback from lich, thanks!
2018-12-14tweak README: move cp style.css from initial step to HTML exampleHiltjo Posthuma
+ change "append" to "change".
2018-10-05README: improve filter example, compile flags orderHiltjo Posthuma