summaryrefslogtreecommitdiff
path: root/sfeed_frames.1
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2014-05-08 12:16:36 +0000
committerHiltjo Posthuma <hiltjo@codemadness.org>2014-05-08 12:16:36 +0000
commit7cf4f47e3b3c3cdf1a5df83c41005c134c9b2dcb (patch)
tree7621bcfe04d34f7db46a821a762fb8097a9e6040 /sfeed_frames.1
parent6e9d9b07e2066fa7cf6506a9f4924ba98b8d1c2e (diff)
man pages: improve wording
Signed-off-by: Hiltjo Posthuma <hiltjo@codemadness.org>
Diffstat (limited to 'sfeed_frames.1')
-rw-r--r--sfeed_frames.118
1 files changed, 9 insertions, 9 deletions
diff --git a/sfeed_frames.1 b/sfeed_frames.1
index 8ef81db..acaffa6 100644
--- a/sfeed_frames.1
+++ b/sfeed_frames.1
@@ -7,18 +7,18 @@ sfeed_frames \- format feeds file (TSV) from sfeed_update to HTML with frames
.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
+Path to write files to, default is ".". On success path will contain the
+files: index.html which is the main HTML file with the frames,
+items.html which contains all the items as HTML links to the local content,
+menu.html which contains navigation anchor links with the feed names
+(to items.html).
+.SH 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 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
+Format feeds file (TSV) from sfeed_update to HTML. It reads TSV data from
stdin and writes HTML to the specified directory. For the exact TSV format
see sfeed_update(1).
.SH SEE ALSO