summaryrefslogtreecommitdiff
path: root/doc/html/sfeed_frames.1.html
blob: 3825b35691367540e5ed251d211d3cba3e15ba5e (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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<style>
table.head, table.foot { width: 100%; }
td.head-rtitle, td.foot-os { text-align: right; }
td.head-vol { text-align: center; }
table.foot td { width: 50%; }
table.head td { width: 33%; }
div.spacer { margin: 1em 0; }
</style>
<link rel="stylesheet" href="man.css" type="text/css" media="all"/>
<title>
SFEED_FRAMES(1)</title>
</head>
<body>
<div class="mandoc">
<table class="head">
<tbody>
<tr>
<td class="head-ltitle">
SFEED_FRAMES(1)</td>
<td class="head-vol">
General Commands Manual</td>
<td class="head-rtitle">
SFEED_FRAMES(1)</td>
</tr>
</tbody>
</table>
<div class="section">
<h1 id="x4e414d45">NAME</h1> <b class="name">sfeed_frames</b> &#8212; <span class="desc">formats a feeds file to HTML with frames</span></div>
<div class="section">
<h1 id="x53594e4f50534953">SYNOPSIS</h1><table class="synopsis">
<col style="width: 12.00ex;"/>
<col/>
<tbody>
<tr>
<td>
sfeed_frames</td>
<td>
[<span class="opt"><i class="arg">directory path</i></span>]</td>
</tr>
</tbody>
</table>
</div>
<div class="section">
<h1 id="x4445534352495054494f4e">DESCRIPTION</h1> <b class="name">sfeed_frames</b> formats a feeds file (TSV) from <a class="link-man">sfeed_update(1)</a> to HTML. It reads TSV data from stdin and writes HTML to the specified directory. For the exact TSV format see <a class="link-man">sfeed_update(1)</a>.</div>
<div class="section">
<h1 id="x4f5054494f4e53">OPTIONS</h1><dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag">
<dt class="list-tag" style="margin-top: 1.00em;">
<i class="arg">directory path</i></dt>
<dd class="list-tag" style="margin-left: 14.00ex;">
Path to write files to, default is &quot;.&quot;. On success the specified directory will contain the files:<dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag">
<dt class="list-tag" style="margin-top: 1.00em;">
<i class="arg">index.html:</i></dt>
<dd class="list-tag" style="margin-left: 13.00ex;">
this is the main HTML file referencing to the frames (items.html and menu.html).</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<i class="arg">items.html:</i></dt>
<dd class="list-tag" style="margin-left: 13.00ex;">
this contains all the items as HTML links to the local content.</dd>
<dt class="list-tag" style="margin-top: 1.00em;">
<i class="arg">menu.html:</i></dt>
<dd class="list-tag" style="margin-left: 13.00ex;">
menu frame which contains navigation &quot;anchor&quot; links to the feed names (in items.html).</dd>
</dl>
</dd>
</dl>
</div>
<div class="section">
<h1 id="x46494c4520535452554354555245">FILE STRUCTURE</h1> 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.</div>
<div class="section">
<h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man">sfeed_plain(1)</a>, <a class="link-man">sfeed_update(1)</a>, <a class="link-man">sfeed(1)</a></div>
<div class="section">
<h1 id="x415554484f5253">AUTHORS</h1> <span class="author">Hiltjo Posthuma</span> &lt;<a class="link-mail" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>&gt;</div>
<table class="foot">
<tbody>
<tr>
<td class="foot-date">
December 25, 2014</td>
<td class="foot-os">
</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>