summaryrefslogtreecommitdiff
path: root/sfeed_frames.1
blob: 5632dc21da9dfa8f0161eae272f5fc91cbc64917 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.Dd August 5, 2015
.Dt SFEED_FRAMES 1
.Os
.Sh NAME
.Nm sfeed_frames
.Nd format feed data to HTML with frames
.Sh SYNOPSIS
.Nm
.Op Ar file...
.Sh DESCRIPTION
.Nm
formats feed data (TSV) from
.Xr sfeed 1
to HTML. It reads TSV data from stdin or
.Ar file
and writes HTML files 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".
.Sh FILES WRITTEN
.Bl -tag -width 13n
.It index.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.
.It menu.html
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_plain 1
.Sh AUTHORS
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
.Sh SECURITY CONSIDERATIONS
Each item file contain the item content formatted as HTML, if the original feed
contains things like Javascripts, tracking cookies, custom styles and such
these will also be displayed. Due to the 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.