diff options
| author | Hiltjo Posthuma <hiltjo@codemadness.org> | 2015-01-02 15:13:12 +0100 |
|---|---|---|
| committer | Hiltjo Posthuma <hiltjo@codemadness.org> | 2015-01-02 15:13:12 +0100 |
| commit | c61c37abf3b6236cd65690fe8a47bdcd9d66bc13 (patch) | |
| tree | 9e5dc0baf8998373ca345e708dde72ef83a70eb9 /doc/html/sfeed_frames.1.html | |
| parent | 80f1550529e08e71c87e44b38d6cf53171737d57 (diff) | |
doc: use mandoc as source, pre-generate documentation
generate documentation in doc/ . Now there is no hard dependency on mandoc and
systems that don't have it can just copy the files for now.
Diffstat (limited to 'doc/html/sfeed_frames.1.html')
| -rw-r--r-- | doc/html/sfeed_frames.1.html | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/doc/html/sfeed_frames.1.html b/doc/html/sfeed_frames.1.html new file mode 100644 index 0000000..3825b35 --- /dev/null +++ b/doc/html/sfeed_frames.1.html @@ -0,0 +1,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> — <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 ".". 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 "anchor" 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> <<a class="link-mail" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>></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> + |