summaryrefslogtreecommitdiff
path: root/sfeed.1
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2015-01-02 14:10:48 +0100
committerHiltjo Posthuma <hiltjo@codemadness.org>2015-01-02 14:10:48 +0100
commit7e023925f48b26c1492d9fd2342c5447174e93a4 (patch)
treea039551a83ecc26e13e6823a7b0e16dd034eb0bb /sfeed.1
parent2be71dd69d7a54ff076cdfaa3905b5f0e818bc03 (diff)
convert man pages to mandoc
Diffstat (limited to 'sfeed.1')
-rw-r--r--sfeed.171
1 files changed, 36 insertions, 35 deletions
diff --git a/sfeed.1 b/sfeed.1
index 5c42620..f641b83 100644
--- a/sfeed.1
+++ b/sfeed.1
@@ -1,44 +1,45 @@
-.TH SFEED 1 sfeed\-0.9
-.SH NAME
-sfeed \- simple RSS and Atom parser
-.SH SYNOPSIS
-.B sfeed
-.SH DESCRIPTION
-Read XML RSS or Atom feed data from stdin. Write feed data in a
+.Dd December 25, 2014
+.Dt SFEED 1
+.Os
+.Sh NAME
+.Nm sfeed
+.Nd simple RSS and Atom parser
+.Sh SYNOPSIS
+.Nm sfeed
+.Op Ar suffix string
+.Sh DESCRIPTION
+.Nm
+reads RSS or Atom feed data (XML) from stdin. It writes the feed data in a
tab-separated format to stdout.
-.SH TAB-SEPARATED FORMAT FIELDS
+.Sh TAB-SEPARATED FORMAT FIELDS
+.Pp
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)
+.Pp
+The order and format of the fields are:
+.Pp
+.Bl -tag -width 17n
+.It Ar item timestamp
+string, UNIX timestamp in GMT+0
+.It Ar item timestamp
+string, date and time in the format: YYYY-mm-dd HH:MM:SS tzname[+-]HHMM
+.It Ar item title
string
-.TP
-.B item timestamp (formatted)
-string (YYYY-mm-dd HH:MM:SS tzname[+-]HHMM)
-.TP
-.B item title
+.It Ar item link
string
-.TP
-.B item link
+.It Ar item content
string
-.TP
-.B item content
+.It Ar item content\-type
+string, "html" or "plain"
+.It Ar item id
string
-.TP
-.B item content\-type
-string (html or plain)
-.TP
-.B item id
+.It Ar item author
string
-.TP
-.B item author
-string
-.TP
-.B feed type
-string (rss or atom)
-.SH SEE ALSO
-.BR sh(1)
-.BR sfeed_update(1)
-.SH BUGS
-Please report them!
+.It Ar feed type
+string, "rss" or "atom"
+.Sh SEE ALSO
+.Xr sh 1 ,
+.Xr sfeed_update 1
+.Sh AUTHORS
+.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org