summaryrefslogtreecommitdiff
path: root/sfeed_frames.1
blob: 9053e434d31a9cd3cf7843c27b9c24d5f7e50f7d (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 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 so the data is read from stdin the feed name
is named "unnamed".
.Sh FILES WRITTEN
.Bl -tag -width 13n
.It Ar index.html
The main HTML file referencing to the frames items.html and
menu.html.
.It Ar items.html
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
Items for each feed category is in the format: 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. The itemname is based on the title of the items.
The feedname and title is truncated to a maximum of 128 characters. The
maximum length of the path is PATH_MAX or filesystem-specific.
.Sh SEE ALSO
.Xr sfeed 1 ,
.Xr sfeed_plain 1
.Sh AUTHORS
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org