summaryrefslogtreecommitdiff
path: root/sfeed_frames.1
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2018-08-16 14:16:58 +0200
committerHiltjo Posthuma <hiltjo@codemadness.org>2018-08-16 14:16:58 +0200
commitb7e288a96418e1ea5e7904ab2896edb3f4615a10 (patch)
tree4aab3d82483978899bb3583319cb737c604f74c4 /sfeed_frames.1
parenta3b6627ae945c11af92c8bb079bf4a12b8ae4c28 (diff)
sfeed_frames: overhaul
sfeed_frames used to write HTML pages for each entry for each feed. This can be useful but had security issues, because the context of the content changes. sfeed_frames is now a HTML version which works better with browsers that don't support CSS or tables well like w3m and lynx. It is now an alternative for sfeed_html. - Don't reference and embed HTML content for security reasons. This was documented under "SECURITY CONSIDERATIONS" in the man page. - Tighten pledge(2). - Simplify
Diffstat (limited to 'sfeed_frames.1')
-rw-r--r--sfeed_frames.131
1 files changed, 8 insertions, 23 deletions
diff --git a/sfeed_frames.1 b/sfeed_frames.1
index 4dc1515..0bf6f04 100644
--- a/sfeed_frames.1
+++ b/sfeed_frames.1
@@ -1,4 +1,4 @@
-.Dd August 5, 2015
+.Dd August 16, 2018
.Dt SFEED_FRAMES 1
.Os
.Sh NAME
@@ -14,39 +14,24 @@ formats feed data (TSV) from
to HTML.
It reads TSV data from stdin or
.Ar file
-and writes HTML files to the current directory.
+and writes HTML files for the frameset to the current directory.
If no
.Ar file
parameters are specified and therefore the data is read from stdin then the
-feed name is named "unnamed".
+menu.html file is not written.
.Sh FILES WRITTEN
.Bl -tag -width 13n
.It index.html
-The main HTML file referencing to the frames items.html and
-menu.html.
+The main HTML file referencing to the frames items.html and menu.html.
.It items.html
-Contains all the items as HTML links to the local content.
+The items frame contains all the item HTML links to the remote content.
.It menu.html
-Menu frame which contains navigation "anchor" links to the feed names
-in items.html.
+The menu frame which contains navigation "anchor" links to the feed names in
+items.html.
.El
-.Sh FILE STRUCTURE
-Items for each feed category are in the format: feedname/itemname.html.
-The feedname and item names are normalized, whitespace characters are replaced
-with a - character, multiple whitespaces are replaced by a single - character
-and trailing whitespace will be removed.
-The itemname is based on the title of the items.
-The feedname and title is truncated to a maximum of 128 bytes.
-The maximum length of the path is PATH_MAX or filesystem-specific (truncated).
.Sh SEE ALSO
.Xr sfeed 1 ,
+.Xr sfeed_html 1 ,
.Xr sfeed_plain 1
.Sh AUTHORS
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
-.Sh SECURITY CONSIDERATIONS
-Each item content file contains the content formatted as HTML, if the feed data
-contains HTML like Javascripts, tracking cookies, custom styles and such
-these will also be displayed.
-Due to the crazy nature of "the web" these things are complex to filter.
-Some security and privacy can be gained by using an adblocker, script blocker
-and to set your browser settings more strictly.