commit 7cf4f47e3b3c3cdf1a5df83c41005c134c9b2dcb
parent 6e9d9b07e2066fa7cf6506a9f4924ba98b8d1c2e
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Thu, 8 May 2014 12:16:36 +0000
man pages: improve wording
Signed-off-by: Hiltjo Posthuma <hiltjo@codemadness.org>
Diffstat:
3 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/sfeed.1 b/sfeed.1
@@ -6,7 +6,7 @@ sfeed \- simple RSS and Atom parser
.SH DESCRIPTION
Read XML RSS or Atom feed data from stdin. Write feed data in a
tab-separated format to stdout.
-.SH TAB-SEPARATED FORMAT
+.SH TAB-SEPARATED FORMAT FIELDS
The items are saved in a TSV-like format except newlines, tabs and
backslash are escaped with \\ (\\n, \\t and \\\\). Carriage returns (\\r) are
removed.
@@ -26,7 +26,7 @@ string
.B item content
string
.TP
-.B item contenttype
+.B item content\-type
string (html or plain)
.TP
.B item id
diff --git 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
diff --git a/sfeed_update.1 b/sfeed_update.1
@@ -11,12 +11,12 @@ config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default
.SH DESCRIPTION
.TP
Update feeds and merge with old feeds in the file $HOME/.sfeed/feeds by default.
-.SH TAB-SEPARATED FORMAT
+.SH TAB-SEPARATED FORMAT FIELDS
The items are saved in a TSV-like format except newlines, tabs and
backslash are escaped with \\ (\\n, \\t and \\\\). Carriage returns (\\r) are
removed.
.TP
-.B item timestamp (unix timestamp in GMT+0)
+.B timestamp (unix timestamp in GMT+0)
string
.TP
.B item timestamp (formatted)
@@ -31,7 +31,7 @@ string
.B item content
string
.TP
-.B item contenttype
+.B item content\-type
string (html or plain)
.TP
.B item id
