update sfeed_frames and documentation

Signed-off-by: Hiltjo Posthuma <hiltjo@codemadness.org>

1 files changed, 29 insertions, 0 deletions

diff --git a/sfeed_frames.1 b/sfeed_frames.1
new file mode 100644
index 0000000..0f6d00e
--- /dev/null
+++ b/sfeed_frames.1
@@ -0,0 +1,29 @@
+.TH SFEED 1 sfeed\-VERSION
+.SH NAME
+sfeed_frames \- format feeds file (TSV) from sfeed_update to HTML with frames
+.SH SYNOPSIS
+.B sfeed_frames
+.RB [path]
+.SH OPTIONS
+.TP
+.B [path]
+path to write files to, default is feeds. On success path will contain the
+files: index.html which is the main HTML file which contains the frames,
+items.html which contains all the items as HTML links to the content,
+menu.html which contains links of all the feednames as id to items.html so
+you can jump to those items.
+.SH STRUCTURE
+directory for each feed category in the format: path/feedname/itemname.html
+feedname and item names are normalized, whitespace characters are replaced
+with a \-, multiple whitespace is replaced by a single \- and trailing 
+whitespace is ignored.
+.SH DESCRIPTION
+Format feeds file (TSV) from sfeed_update to HTML. Reads TSV data from
+stdin and writes HTML to the specified directory. For the exact TSV format
+see sfeed_update(1).
+.SH SEE ALSO
+.BR sfeed_plain(1)
+.BR sfeed_update(1)
+.BR sfeed(1)
+.SH BUGS
+Please report them!