From c61c37abf3b6236cd65690fe8a47bdcd9d66bc13 Mon Sep 17 00:00:00 2001 From: Hiltjo Posthuma Date: Fri, 2 Jan 2015 15:13:12 +0100 Subject: 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. --- doc/html/sfeed_frames.1.html | 90 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 doc/html/sfeed_frames.1.html (limited to 'doc/html/sfeed_frames.1.html') 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 @@ + + + + + + + +SFEED_FRAMES(1) + + +
+ + + + + + + + +
+SFEED_FRAMES(1) +General Commands Manual +SFEED_FRAMES(1)
+
+

NAME

sfeed_frames — formats a feeds file to HTML with frames
+
+

SYNOPSIS

+++ + + + + + +
+sfeed_frames +[directory path]
+
+
+

DESCRIPTION

sfeed_frames formats a feeds file (TSV) from sfeed_update(1) to HTML. It reads TSV data from stdin and writes HTML to the specified directory. For the exact TSV format see sfeed_update(1).
+
+

OPTIONS

+
+directory path
+
+Path to write files to, default is ".". On success the specified directory will contain the files:
+
+index.html:
+
+this is the main HTML file referencing to the frames (items.html and menu.html).
+
+items.html:
+
+this contains all the items as HTML links to the local content.
+
+menu.html:
+
+menu frame which contains navigation "anchor" links to the feed names (in items.html).
+
+
+
+
+
+

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.
+
+

SEE ALSO

sfeed_plain(1), sfeed_update(1), sfeed(1)
+
+

AUTHORS

Hiltjo Posthuma <hiltjo@codemadness.org>
+ + + + + + + +
+December 25, 2014 +
+
+ + + -- cgit v1.2.3