summaryrefslogtreecommitdiff
path: root/sfeed_frames.1
blob: 9507bdb77fce71ff7428315d4df970ac56b9ecbf (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
.Dd December 25, 2014
.Dt SFEED_FRAMES 1
.Os
.Sh NAME
.Nm sfeed_frames
.Nd formats a feeds file to HTML with frames
.Sh SYNOPSIS
.Nm
.Op Ar feed...
.Sh DESCRIPTION
.Nm
formats a feeds file (TSV) from
.Xr sfeed_update 1
to HTML. It reads TSV data from stdin and writes HTML to the specified
directory. For the exact TSV format see
.Xr sfeed_update 1 .
.Sh OPTIONS
.Bl -tag -width 14n
.It Ar directory path
Path to write files to, default is ".". On success the specified directory will
contain the files:
.El
.Bl -tag -width 13n
.It Ar index.html:
this is the main HTML file referencing to the frames (items.html and
menu.html).
.It Ar items.html:
this contains all the items as HTML links to the local content.
.It Ar menu.html:
menu frame which contains navigation "anchor" links to the feed names
(in items.html).
.El
.Sh FILE STRUCTURE
Directory for each feed category in the format: path/feedname/itemname.html.
The feedname and item names are normalized, whitespace characters are replaced
with a \-, multiple whitespaces are replaced by a single \- and trailing
whitespace will be removed.
.Sh SEE ALSO
.Xr sfeed 1 ,
.Xr sfeed_plain 1 ,
.Xr sfeed_update 1
.Sh AUTHORS
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org