diff options
| -rw-r--r-- | Makefile | 4 | ||||
| -rw-r--r-- | doc/html/man.css | 114 | ||||
| -rw-r--r-- | doc/html/sfeed.1.html | 113 | ||||
| -rw-r--r-- | doc/html/sfeed_frames.1.html | 88 | ||||
| -rw-r--r-- | doc/html/sfeed_html.1.html | 64 | ||||
| -rw-r--r-- | doc/html/sfeed_opml_export.1.html | 58 | ||||
| -rw-r--r-- | doc/html/sfeed_opml_import.1.html | 50 | ||||
| -rw-r--r-- | doc/html/sfeed_plain.1.html | 64 | ||||
| -rw-r--r-- | doc/html/sfeed_stats.1.html | 64 | ||||
| -rw-r--r-- | doc/html/sfeed_update.1.html | 156 | ||||
| -rw-r--r-- | doc/html/sfeed_web.1.html | 89 | ||||
| -rw-r--r-- | doc/html/sfeed_xmlenc.1.html | 69 | ||||
| -rw-r--r-- | sfeed.1 | 4 | ||||
| -rw-r--r-- | sfeed_frames.1 | 3 | ||||
| -rw-r--r-- | sfeed_html.1 | 2 | ||||
| -rw-r--r-- | sfeed_opml_export.1 | 40 | ||||
| -rw-r--r-- | sfeed_opml_import.1 | 26 | ||||
| -rw-r--r-- | sfeed_plain.1 | 2 | ||||
| -rw-r--r-- | sfeed_update.1 | 10 | ||||
| -rw-r--r-- | sfeed_web.1 | 5 | ||||
| -rw-r--r-- | sfeed_xmlenc.1 | 2 |
21 files changed, 57 insertions, 970 deletions
@@ -71,7 +71,7 @@ dist: $(BIN) doc (cd release/${VERSION}; \ tar -czf ../../sfeed-${VERSION}.tar.gz .) -doc: doc-html doc-oldman +doc: doc-oldman # man to HTML: make sure to copy the mandoc example stylesheet to # doc/html/man.css . @@ -138,4 +138,4 @@ uninstall: # removing manual pages. for m in $(MAN1); do rm -f ${DESTDIR}${MANPREFIX}/man1/$$m; done -.PHONY: all clean dist install uninstall doc-html doc-oldman doc +.PHONY: all clean dist doc doc-html doc-oldman install uninstall diff --git a/doc/html/man.css b/doc/html/man.css deleted file mode 100644 index 905412b..0000000 --- a/doc/html/man.css +++ /dev/null @@ -1,114 +0,0 @@ -/* $Id: example.style.css,v 1.54 2014/12/10 22:19:45 schwarze Exp $ */ -/* - * This is an example style-sheet provided for mandoc(1) and the -Thtml - * or -Txhtml output mode. - * It mimics the appearance of the legacy man.cgi output. - * See mdoc(7) and man(7) for macro explanations. - */ - -div.mandoc { min-width: 102ex; - width: 102ex; - font-family: monospace; } /* This is the outer node of all mandoc -T[x]html documents. */ -div.mandoc h1 { margin-bottom: 0ex; font-size: inherit; margin-left: -4ex; } /* Section header (Sh, SH). */ -div.mandoc h2 { margin-bottom: 0ex; font-size: inherit; margin-left: -2ex; } /* Sub-section header (Ss, SS). */ -div.mandoc table { width: 100%; margin-top: 0ex; margin-bottom: 0ex; } /* All tables. */ -div.mandoc td { vertical-align: top; } /* All table cells. */ -div.mandoc p { } /* Paragraph: Pp, Lp. */ -div.mandoc blockquote { margin-left: 5ex; margin-top: 0ex; margin-bottom: 0ex; } /* D1, Dl. */ -div.mandoc div.section { margin-bottom: 2ex; margin-left: 5ex; } /* Sections (Sh, SH). */ -div.mandoc div.subsection { } /* Sub-sections (Ss, SS). */ -div.mandoc table.synopsis { } /* SYNOPSIS section table. */ -div.mandoc table.foot { } /* Document footer. */ -div.mandoc td.foot-date { width: 50%; } /* Document footer: date. */ -div.mandoc td.foot-os { width: 50%; - text-align: right; } /* Document footer: OS/source. */ -div.mandoc table.head { } /* Document header. */ -div.mandoc td.head-ltitle { width: 10%; } /* Document header: left-title. */ -div.mandoc td.head-vol { width: 80%; - text-align: center; } /* Document header: volume. */ -div.mandoc td.head-rtitle { width: 10%; - text-align: right; } /* Document header: right-title. */ -div.mandoc .display { } /* All Bd, D1, Dl. */ -div.mandoc .list { } /* All Bl. */ -div.mandoc i { } /* Italic: BI, IB, I, (implicit). */ -div.mandoc b { } /* Bold: SB, BI, IB, BR, RB, B, (implicit). */ -div.mandoc small { } /* Small: SB, SM. */ -div.mandoc .emph { font-style: italic; font-weight: normal; } /* Emphasis: Em, Bl -emphasis. */ -div.mandoc .symb { font-style: normal; font-weight: bold; } /* Symbolic: Sy, Ms, Bf -symbolic. */ -div.mandoc .lit { font-style: normal; font-weight: normal; font-family: monospace; } /* Literal: Dl, Li, Ql, Bf -literal, Bl -literal, Bl -unfilled. */ -div.mandoc i.addr { font-weight: normal; } /* Address (Ad). */ -div.mandoc i.arg { font-weight: normal; } /* Command argument (Ar). */ -div.mandoc span.author { } /* Author name (An). */ -div.mandoc b.cmd { font-style: normal; } /* Command (Cm). */ -div.mandoc b.config { font-style: normal; } /* Config statement (Cd). */ -div.mandoc span.define { } /* Defines (Dv). */ -div.mandoc span.desc { } /* Nd. After em-dash. */ -div.mandoc b.diag { font-style: normal; } /* Diagnostic (Bl -diag). */ -div.mandoc span.env { } /* Environment variables (Ev). */ -div.mandoc span.errno { } /* Error string (Er). */ -div.mandoc i.farg { font-weight: normal; } /* Function argument (Fa, Fn). */ -div.mandoc i.file { font-weight: normal; } /* File (Pa). */ -div.mandoc b.flag { font-style: normal; } /* Flag (Fl, Cm). */ -div.mandoc b.fname { font-style: normal; } /* Function name (Fa, Fn, Rv). */ -div.mandoc i.ftype { font-weight: normal; } /* Function types (Ft, Fn). */ -div.mandoc b.includes { font-style: normal; } /* Header includes (In). */ -div.mandoc span.lib { } /* Library (Lb). */ -div.mandoc i.link-sec { font-weight: normal; } /* Section links (Sx). */ -div.mandoc b.macro { font-style: normal; } /* Macro-ish thing (Fd). */ -div.mandoc b.name { font-style: normal; } /* Name of utility (Nm). */ -div.mandoc span.opt { } /* Options (Op, Oo/Oc). */ -div.mandoc span.ref { } /* Citations (Rs). */ -div.mandoc span.ref-auth { } /* Reference author (%A). */ -div.mandoc i.ref-book { font-weight: normal; } /* Reference book (%B). */ -div.mandoc span.ref-city { } /* Reference city (%C). */ -div.mandoc span.ref-date { } /* Reference date (%D). */ -div.mandoc i.ref-issue { font-weight: normal; } /* Reference issuer/publisher (%I). */ -div.mandoc i.ref-jrnl { font-weight: normal; } /* Reference journal (%J). */ -div.mandoc span.ref-num { } /* Reference number (%N). */ -div.mandoc span.ref-opt { } /* Reference optionals (%O). */ -div.mandoc span.ref-page { } /* Reference page (%P). */ -div.mandoc span.ref-corp { } /* Reference corporate/foreign author (%Q). */ -div.mandoc span.ref-rep { } /* Reference report (%R). */ -div.mandoc span.ref-title { text-decoration: underline; } /* Reference title (%T). */ -div.mandoc span.ref-vol { } /* Reference volume (%V). */ -div.mandoc span.type { font-style: italic; font-weight: normal; } /* Variable types (Vt). */ -div.mandoc span.unix { } /* Unices (Ux, Ox, Nx, Fx, Bx, Bsx, Dx). */ -div.mandoc b.utility { font-style: normal; } /* Name of utility (Ex). */ -div.mandoc b.var { font-style: normal; } /* Variables (Rv). */ -div.mandoc a.link-ext { } /* Off-site link (Lk). */ -div.mandoc a.link-includes { } /* Include-file link (In). */ -div.mandoc a.link-mail { } /* Mailto links (Mt). */ -div.mandoc a.link-man { } /* Manual links (Xr). */ -div.mandoc a.link-ref { } /* Reference section links (%Q). */ -div.mandoc a.link-sec { } /* Section links (Sx). */ -div.mandoc dl.list-diag { } /* Formatting for lists. See mdoc(7). */ -div.mandoc dt.list-diag { } -div.mandoc dd.list-diag { } -div.mandoc dl.list-hang { } -div.mandoc dt.list-hang { } -div.mandoc dd.list-hang { } -div.mandoc dl.list-inset { } -div.mandoc dt.list-inset { } -div.mandoc dd.list-inset { } -div.mandoc dl.list-ohang { } -div.mandoc dt.list-ohang { } -div.mandoc dd.list-ohang { margin-left: 0ex; } -div.mandoc dl.list-tag { } -div.mandoc dt.list-tag { } -div.mandoc dd.list-tag { } -div.mandoc table.list-col { } -div.mandoc tr.list-col { } -div.mandoc td.list-col { } -div.mandoc ul.list-bul { list-style-type: disc; padding-left: 1em; } -div.mandoc li.list-bul { } -div.mandoc ul.list-dash { list-style-type: none; padding-left: 0em; } -div.mandoc li.list-dash:before { content: "\2014 "; } -div.mandoc ul.list-hyph { list-style-type: none; padding-left: 0em; } -div.mandoc li.list-hyph:before { content: "\2013 "; } -div.mandoc ul.list-item { list-style-type: none; padding-left: 0em; } -div.mandoc li.list-item { } -div.mandoc ol.list-enum { padding-left: 2em; } -div.mandoc li.list-enum { } -div.mandoc span.eqn { } /* Equation modes. See eqn(7). */ -div.mandoc table.tbl { } /* Table modes. See tbl(7). */ -div.mandoc div.spacer { margin: 1em 0; } diff --git a/doc/html/sfeed.1.html b/doc/html/sfeed.1.html deleted file mode 100644 index 15f35e6..0000000 --- a/doc/html/sfeed.1.html +++ /dev/null @@ -1,113 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<meta name="resource-type" content="document"> -<link rel="stylesheet" href="man.css" type="text/css" media="all"> -<title> -SFEED(1)</title> -</head> -<body> -<div class="mandoc"> -<table summary="Document Header" class="head" width="100%"> -<col width="30%"> -<col width="30%"> -<col width="30%"> -<tbody> -<tr> -<td class="head-ltitle"> -SFEED(1)</td> -<td class="head-vol" align="center"> -OpenBSD Reference Manual</td> -<td class="head-rtitle" align="right"> -SFEED(1)</td> -</tr> -</tbody> -</table> -<div class="section"> -<h1 id="x4e414d45">NAME</h1> <b class="name">sfeed</b> — <span class="desc">simple RSS and Atom parser</span></div> -<div class="section"> -<h1 id="x53594e4f50534953">SYNOPSIS</h1><table class="synopsis"> -<col style="width: 5.00ex;"> -<col> -<tbody> -<tr> -<td> -sfeed</td> -<td> -[<span class="opt"><i class="arg">suffix string</i> | <b class="flag">-</b><i class="arg">v</i></span>]</td> -</tr> -</tbody> -</table> -</div> -<div class="section"> -<h1 id="x4445534352495054494f4e">DESCRIPTION</h1> <b class="name">sfeed</b> reads RSS or Atom feed data (XML) from stdin. It writes the feed data in a tab-separated format to stdout.</div> -<div class="section"> -<h1 id="x4f5054494f4e53">OPTIONS</h1><dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> -<dt class="list-tag" style="margin-top: 1.00em;"> -<b class="flag">-v</b></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -show program version</dd> -</dl> -</div> -<div class="section"> -<h1 id="x5441421e53455041524154454420464f524d4154204649454c4453">TAB-SEPARATED FORMAT FIELDS</h1> 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.<p> -The order and format of the fields are:<dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item timestamp</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string, UNIX timestamp in GMT+0</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item timestamp</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string, date and time in the format: YYYY-mm-dd HH:MM:SS tzname[[+-][HHMM]]</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item title</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item link</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item content</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item content-type</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string, "html" or "plain"</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item id</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item author</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">feed type</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string, "rss" or "atom"</dd> -</dl> -</div> -<div class="section"> -<h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man">sh(1)</a>, <a class="link-man">sfeed_update(1)</a></div> -<div class="section"> -<h1 id="x415554484f5253">AUTHORS</h1> <span class="author">Hiltjo Posthuma</span> <<a class="link-mail" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>></div> -<table summary="Document Footer" class="foot" width="100%"> -<col width="50%"> -<col width="50%"> -<tbody> -<tr> -<td class="foot-date"> -December 25, 2014</td> -<td class="foot-os" align="right"> -</td> -</tr> -</tbody> -</table> -</div> -</body> -</html> - diff --git a/doc/html/sfeed_frames.1.html b/doc/html/sfeed_frames.1.html deleted file mode 100644 index 636f14a..0000000 --- a/doc/html/sfeed_frames.1.html +++ /dev/null @@ -1,88 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<meta name="resource-type" content="document"> -<link rel="stylesheet" href="man.css" type="text/css" media="all"> -<title> -SFEED_FRAMES(1)</title> -</head> -<body> -<div class="mandoc"> -<table summary="Document Header" class="head" width="100%"> -<col width="30%"> -<col width="30%"> -<col width="30%"> -<tbody> -<tr> -<td class="head-ltitle"> -SFEED_FRAMES(1)</td> -<td class="head-vol" align="center"> -OpenBSD Reference Manual</td> -<td class="head-rtitle" align="right"> -SFEED_FRAMES(1)</td> -</tr> -</tbody> -</table> -<div class="section"> -<h1 id="x4e414d45">NAME</h1> <b class="name">sfeed_frames</b> — <span class="desc">formats a feeds file to HTML with frames</span></div> -<div class="section"> -<h1 id="x53594e4f50534953">SYNOPSIS</h1><table class="synopsis"> -<col style="width: 12.00ex;"> -<col> -<tbody> -<tr> -<td> -sfeed_frames</td> -<td> -[<span class="opt"><i class="arg">directory path</i></span>]</td> -</tr> -</tbody> -</table> -</div> -<div class="section"> -<h1 id="x4445534352495054494f4e">DESCRIPTION</h1> <b class="name">sfeed_frames</b> formats a feeds file (TSV) from <a class="link-man">sfeed_update(1)</a> to HTML. It reads TSV data from stdin and writes HTML to the specified directory. For the exact TSV format see <a class="link-man">sfeed_update(1)</a>.</div> -<div class="section"> -<h1 id="x4f5054494f4e53">OPTIONS</h1><dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">directory path</i></dt> -<dd class="list-tag" style="margin-left: 14.00ex;"> -Path to write files to, default is ".". On success the specified directory will contain the files:<dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">index.html:</i></dt> -<dd class="list-tag" style="margin-left: 13.00ex;"> -this is the main HTML file referencing to the frames (items.html and menu.html).</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">items.html:</i></dt> -<dd class="list-tag" style="margin-left: 13.00ex;"> -this contains all the items as HTML links to the local content.</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">menu.html:</i></dt> -<dd class="list-tag" style="margin-left: 13.00ex;"> -menu frame which contains navigation "anchor" links to the feed names (in items.html).</dd> -</dl> -</dd> -</dl> -</div> -<div class="section"> -<h1 id="x46494c4520535452554354555245">FILE STRUCTURE</h1> 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.</div> -<div class="section"> -<h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man">sfeed_plain(1)</a>, <a class="link-man">sfeed_update(1)</a>, <a class="link-man">sfeed(1)</a></div> -<div class="section"> -<h1 id="x415554484f5253">AUTHORS</h1> <span class="author">Hiltjo Posthuma</span> <<a class="link-mail" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>></div> -<table summary="Document Footer" class="foot" width="100%"> -<col width="50%"> -<col width="50%"> -<tbody> -<tr> -<td class="foot-date"> -December 25, 2014</td> -<td class="foot-os" align="right"> -</td> -</tr> -</tbody> -</table> -</div> -</body> -</html> - diff --git a/doc/html/sfeed_html.1.html b/doc/html/sfeed_html.1.html deleted file mode 100644 index dfbc936..0000000 --- a/doc/html/sfeed_html.1.html +++ /dev/null @@ -1,64 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<meta name="resource-type" content="document"> -<link rel="stylesheet" href="man.css" type="text/css" media="all"> -<title> -SFEED_HTML(1)</title> -</head> -<body> -<div class="mandoc"> -<table summary="Document Header" class="head" width="100%"> -<col width="30%"> -<col width="30%"> -<col width="30%"> -<tbody> -<tr> -<td class="head-ltitle"> -SFEED_HTML(1)</td> -<td class="head-vol" align="center"> -OpenBSD Reference Manual</td> -<td class="head-rtitle" align="right"> -SFEED_HTML(1)</td> -</tr> -</tbody> -</table> -<div class="section"> -<h1 id="x4e414d45">NAME</h1> <b class="name">sfeed_html</b> — <span class="desc">formats a feeds file to HTML</span></div> -<div class="section"> -<h1 id="x53594e4f50534953">SYNOPSIS</h1><table class="synopsis"> -<col style="width: 10.00ex;"> -<col> -<tbody> -<tr> -<td> -sfeed_html</td> -<td> -</td> -</tr> -</tbody> -</table> -</div> -<div class="section"> -<h1 id="x4445534352495054494f4e">DESCRIPTION</h1> <b class="name">sfeed_html</b> formats a feeds file (TSV) from <a class="link-man">sfeed_update(1)</a> to HTML. It reads TSV data from stdin and writes HTML to stdout. For the exact TSV format see <a class="link-man">sfeed_update(1)</a>.</div> -<div class="section"> -<h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man">sfeed_plain(1)</a>, <a class="link-man">sfeed_update(1)</a>, <a class="link-man">sfeed(1)</a></div> -<div class="section"> -<h1 id="x415554484f5253">AUTHORS</h1> <span class="author">Hiltjo Posthuma</span> <<a class="link-mail" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>></div> -<table summary="Document Footer" class="foot" width="100%"> -<col width="50%"> -<col width="50%"> -<tbody> -<tr> -<td class="foot-date"> -December 25, 2014</td> -<td class="foot-os" align="right"> -</td> -</tr> -</tbody> -</table> -</div> -</body> -</html> - diff --git a/doc/html/sfeed_opml_export.1.html b/doc/html/sfeed_opml_export.1.html deleted file mode 100644 index 6e9de88..0000000 --- a/doc/html/sfeed_opml_export.1.html +++ /dev/null @@ -1,58 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<meta name="resource-type" content="document"> -<link rel="stylesheet" href="man.css" type="text/css" media="all"> -<title> -SFEED(1)</title> -</head> -<body> -<div class="mandoc"> -<table summary="Document Header" class="head" width="100%"> -<col width="30%"> -<col width="30%"> -<col width="30%"> -<tbody> -<tr> -<td class="head-ltitle"> -SFEED(1)</td> -<td class="head-vol" align="center"> -OpenBSD Reference Manual</td> -<td class="head-rtitle" align="right"> -SFEED(1)</td> -</tr> -</tbody> -</table> -<div class="section"> -<h1>NAME</h1> sfeed_opml_export - generate an OPML file based on a sfeedrc config file</div> -<div class="section"> -<h1>SYNOPSIS</h1> <b>sfeed_opml_export</b> [configfile]</div> -<div class="section"> -<h1>OPTIONS</h1><dl> -<dt> -<b>[configfile]</b></dt> -<dd> -config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default (see FILES READ section for more information).</dd> -</dl> -</div> -<div class="section"> -<h1>DESCRIPTION</h1> Parse the specified config file and output OPML XML data to stdout.</div> -<div class="section"> -<h1>SEE ALSO</h1> <b>sfeed_update(1)</b></div> -<div class="section"> -<h1>BUGS</h1> Please report them!</div> -<table summary="Document Footer" class="foot" width="100%"> -<col width="50%"> -<col width="50%"> -<tr> -<td class="foot-date"> -sfeed-0.9</td> -<td class="foot-os" align="right"> -</td> -</tr> -</table> -</div> -</body> -</html> - diff --git a/doc/html/sfeed_opml_import.1.html b/doc/html/sfeed_opml_import.1.html deleted file mode 100644 index 121d82e..0000000 --- a/doc/html/sfeed_opml_import.1.html +++ /dev/null @@ -1,50 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<meta name="resource-type" content="document"> -<link rel="stylesheet" href="man.css" type="text/css" media="all"> -<title> -SFEED(1)</title> -</head> -<body> -<div class="mandoc"> -<table summary="Document Header" class="head" width="100%"> -<col width="30%"> -<col width="30%"> -<col width="30%"> -<tbody> -<tr> -<td class="head-ltitle"> -SFEED(1)</td> -<td class="head-vol" align="center"> -OpenBSD Reference Manual</td> -<td class="head-rtitle" align="right"> -SFEED(1)</td> -</tr> -</tbody> -</table> -<div class="section"> -<h1>NAME</h1> sfeed_opml_import - generate a sfeedrc config file based on an OPML file</div> -<div class="section"> -<h1>SYNOPSIS</h1> <b>sfeed_opml_import</b></div> -<div class="section"> -<h1>DESCRIPTION</h1> It reads the OPML XML data from stdin and writes the config file text to stdout.</div> -<div class="section"> -<h1>SEE ALSO</h1> <b>sfeed_update(1)</b></div> -<div class="section"> -<h1>BUGS</h1> Please report them!</div> -<table summary="Document Footer" class="foot" width="100%"> -<col width="50%"> -<col width="50%"> -<tr> -<td class="foot-date"> -sfeed-0.9</td> -<td class="foot-os" align="right"> -</td> -</tr> -</table> -</div> -</body> -</html> - diff --git a/doc/html/sfeed_plain.1.html b/doc/html/sfeed_plain.1.html deleted file mode 100644 index 61dd952..0000000 --- a/doc/html/sfeed_plain.1.html +++ /dev/null @@ -1,64 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<meta name="resource-type" content="document"> -<link rel="stylesheet" href="man.css" type="text/css" media="all"> -<title> -SFEED_PLAIN(1)</title> -</head> -<body> -<div class="mandoc"> -<table summary="Document Header" class="head" width="100%"> -<col width="30%"> -<col width="30%"> -<col width="30%"> -<tbody> -<tr> -<td class="head-ltitle"> -SFEED_PLAIN(1)</td> -<td class="head-vol" align="center"> -OpenBSD Reference Manual</td> -<td class="head-rtitle" align="right"> -SFEED_PLAIN(1)</td> -</tr> -</tbody> -</table> -<div class="section"> -<h1 id="x4e414d45">NAME</h1> <b class="name">sfeed_plain</b> — <span class="desc">formats a feeds file to plain text</span></div> -<div class="section"> -<h1 id="x53594e4f50534953">SYNOPSIS</h1><table class="synopsis"> -<col style="width: 11.00ex;"> -<col> -<tbody> -<tr> -<td> -sfeed_plain</td> -<td> -</td> -</tr> -</tbody> -</table> -</div> -<div class="section"> -<h1 id="x4445534352495054494f4e">DESCRIPTION</h1> <b class="name">sfeed_plain</b> formats a feeds file (TSV) from <a class="link-man">sfeed_update(1)</a> to plain text. It reads TSV data from stdin and writes formatted plain text to stdout. For the exact TSV format see <a class="link-man">sfeed_update(1)</a>.</div> -<div class="section"> -<h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man">sfeed_html(1)</a>, <a class="link-man">sfeed_update(1)</a>, <a class="link-man">sfeed(1)</a></div> -<div class="section"> -<h1 id="x415554484f5253">AUTHORS</h1> <span class="author">Hiltjo Posthuma</span> <<a class="link-mail" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>></div> -<table summary="Document Footer" class="foot" width="100%"> -<col width="50%"> -<col width="50%"> -<tbody> -<tr> -<td class="foot-date"> -December 25, 2014</td> -<td class="foot-os" align="right"> -</td> -</tr> -</tbody> -</table> -</div> -</body> -</html> - diff --git a/doc/html/sfeed_stats.1.html b/doc/html/sfeed_stats.1.html deleted file mode 100644 index 285454d..0000000 --- a/doc/html/sfeed_stats.1.html +++ /dev/null @@ -1,64 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<meta name="resource-type" content="document"> -<link rel="stylesheet" href="man.css" type="text/css" media="all"> -<title> -SFEED_STATS(1)</title> -</head> -<body> -<div class="mandoc"> -<table summary="Document Header" class="head" width="100%"> -<col width="30%"> -<col width="30%"> -<col width="30%"> -<tbody> -<tr> -<td class="head-ltitle"> -SFEED_STATS(1)</td> -<td class="head-vol" align="center"> -OpenBSD Reference Manual</td> -<td class="head-rtitle" align="right"> -SFEED_STATS(1)</td> -</tr> -</tbody> -</table> -<div class="section"> -<h1 id="x4e414d45">NAME</h1> <b class="name">sfeed_stats</b> — <span class="desc">formats a feeds file to show a plain text summary</span></div> -<div class="section"> -<h1 id="x53594e4f50534953">SYNOPSIS</h1><table class="synopsis"> -<col style="width: 11.00ex;"> -<col> -<tbody> -<tr> -<td> -sfeed_stats</td> -<td> -</td> -</tr> -</tbody> -</table> -</div> -<div class="section"> -<h1 id="x4445534352495054494f4e">DESCRIPTION</h1> <b class="name">sfeed_stats</b> formats a feeds file (TSV) from <a class="link-man">sfeed_update(1)</a> to a plain text summary with: the total amount of items, amount of new items, the timestamp of the last item. It reads TSV data from stdin and writes formatted plain text to stdout. For the exact TSV format see <a class="link-man">sfeed_update(1)</a>.</div> -<div class="section"> -<h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man">sfeed_update(1)</a>, <a class="link-man">sfeed(1)</a></div> -<div class="section"> -<h1 id="x415554484f5253">AUTHORS</h1> <span class="author">Hiltjo Posthuma</span> <<a class="link-mail" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>></div> -<table summary="Document Footer" class="foot" width="100%"> -<col width="50%"> -<col width="50%"> -<tbody> -<tr> -<td class="foot-date"> -January 3, 2015</td> -<td class="foot-os" align="right"> -</td> -</tr> -</tbody> -</table> -</div> -</body> -</html> - diff --git a/doc/html/sfeed_update.1.html b/doc/html/sfeed_update.1.html deleted file mode 100644 index cd4ae08..0000000 --- a/doc/html/sfeed_update.1.html +++ /dev/null @@ -1,156 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<meta name="resource-type" content="document"> -<link rel="stylesheet" href="man.css" type="text/css" media="all"> -<title> -SFEED_UPDATE(1)</title> -</head> -<body> -<div class="mandoc"> -<table summary="Document Header" class="head" width="100%"> -<col width="30%"> -<col width="30%"> -<col width="30%"> -<tbody> -<tr> -<td class="head-ltitle"> -SFEED_UPDATE(1)</td> -<td class="head-vol" align="center"> -OpenBSD Reference Manual</td> -<td class="head-rtitle" align="right"> -SFEED_UPDATE(1)</td> -</tr> -</tbody> -</table> -<div class="section"> -<h1 id="x4e414d45">NAME</h1> <b class="name">sfeed_update</b> — <span class="desc">update feeds and merge with old feeds</span></div> -<div class="section"> -<h1 id="x53594e4f50534953">SYNOPSIS</h1><table class="synopsis"> -<col style="width: 12.00ex;"> -<col> -<tbody> -<tr> -<td> -sfeed_update</td> -<td> -[<span class="opt"><i class="arg">configfile</i></span>]</td> -</tr> -</tbody> -</table> -</div> -<div class="section"> -<h1 id="x4445534352495054494f4e">DESCRIPTION</h1> <b class="name">sfeed_update</b> updates feeds and merges the new data with the previous feeds. This is the file $HOME/.sfeed/feeds by default.</div> -<div class="section"> -<h1 id="x4f5054494f4e53">OPTIONS</h1><dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">configfile</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default see the <i class="link-sec"><a class="link-sec" href="#x46494c45532052454144">FILES READ</a></i> section for more information.</dd> -</dl> -</div> -<div class="section"> -<h1 id="x5441421e53455041524154454420464f524d4154204649454c4453">TAB-SEPARATED FORMAT FIELDS</h1> 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.<p> -The order and format of the fields are:<dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item timestamp</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string, UNIX timestamp in GMT+0</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item timestamp</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string, date and time in the format: YYYY-mm-dd HH:MM:SS tzname[[+-][HHMM]]</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item title</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item link</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item content</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item content-type</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string, "html" or "plain"</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item id</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item author</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">feed type</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string, "rss" or "atom"</dd> -</dl> -</div> -<div class="section"> -<h1 id="x4558545241204649454c4453">EXTRA FIELDS</h1> Extra fields added by sfeed_update:<dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">feed name</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">feed url</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">item baseurl site</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -string</dd> -</dl> -</div> -<div class="section"> -<h1 id="x46494c45532052454144">FILES READ</h1><dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">sfeedrc</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -Config file, see the sfeedrc.example file for an example. This file is evaluated as a shellscript in sfeed_update. You can for example override the fetchfeed() function to use wget, fetch or an other download program or you can override the merge() function to change the merge logic. The function feeds() is called to fetch the feeds. By default the function feed() is executed as a parallel job to speedup updating.</dd> -</dl> -</div> -<div class="section"> -<h1 id="x46494c4553205752495454454e">FILES WRITTEN</h1><dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">feeds</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -Tab-separated format containing all feeds. The sfeed_update script merges new items with this file.</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">feeds.new</i></dt> -<dd class="list-tag" style="margin-left: 17.00ex;"> -Temporary file used by sfeed_update to merge items.</dd> -</dl> -</div> -<div class="section"> -<h1 id="x4558414d504c4553">EXAMPLES</h1> To update feeds and format the feeds file:<p> -<pre style="margin-left: 0.00ex;" class="lit display"> -sfeed_update "configfile" -sfeed_plain < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.txt -sfeed_html < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.html</pre> -</div> -<div class="section"> -<h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man">sh(1)</a>, <a class="link-man">sfeed_plain(1)</a>, <a class="link-man">sfeed_html(1)</a></div> -<div class="section"> -<h1 id="x415554484f5253">AUTHORS</h1> <span class="author">Hiltjo Posthuma</span> <<a class="link-mail" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>></div> -<table summary="Document Footer" class="foot" width="100%"> -<col width="50%"> -<col width="50%"> -<tbody> -<tr> -<td class="foot-date"> -December 25, 2014</td> -<td class="foot-os" align="right"> -</td> -</tr> -</tbody> -</table> -</div> -</body> -</html> - diff --git a/doc/html/sfeed_web.1.html b/doc/html/sfeed_web.1.html deleted file mode 100644 index a0e562d..0000000 --- a/doc/html/sfeed_web.1.html +++ /dev/null @@ -1,89 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<meta name="resource-type" content="document"> -<link rel="stylesheet" href="man.css" type="text/css" media="all"> -<title> -SFEED_WEB(1)</title> -</head> -<body> -<div class="mandoc"> -<table summary="Document Header" class="head" width="100%"> -<col width="30%"> -<col width="30%"> -<col width="30%"> -<tbody> -<tr> -<td class="head-ltitle"> -SFEED_WEB(1)</td> -<td class="head-vol" align="center"> -OpenBSD Reference Manual</td> -<td class="head-rtitle" align="right"> -SFEED_WEB(1)</td> -</tr> -</tbody> -</table> -<div class="section"> -<h1 id="x4e414d45">NAME</h1> <b class="name">sfeed_web</b> — <span class="desc">finds urls to feeds from a HTML webpage</span></div> -<div class="section"> -<h1 id="x53594e4f50534953">SYNOPSIS</h1><table class="synopsis"> -<col style="width: 9.00ex;"> -<col> -<tbody> -<tr> -<td> -sfeed_web</td> -<td> -[<span class="opt"><i class="arg">baseurl</i></span>]</td> -</tr> -</tbody> -</table> -</div> -<div class="section"> -<h1 id="x4445534352495054494f4e">DESCRIPTION</h1> <b class="name">sfeed_web</b> reads the HTML website as XML or HTML data from stdin and writes the found urls to stdout.</div> -<div class="section"> -<h1 id="x4f5054494f4e53">OPTIONS</h1><dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">baseurl</i></dt> -<dd class="list-tag" style="margin-left: 8.00ex;"> -optional base url to use for found feed urls that are relative.</dd> -</dl> -</div> -<div class="section"> -<h1 id="x4f555450555420464f524d4154">OUTPUT FORMAT</h1> content-type<space>url<newline><dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag"> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">content-type</i></dt> -<dd class="list-tag" style="margin-left: 13.00ex;"> -Usually application/atom+xml or application/rss+xml.</dd> -<dt class="list-tag" style="margin-top: 1.00em;"> -<i class="arg">url</i></dt> -<dd class="list-tag" style="margin-left: 13.00ex;"> -Found url to the feed. If the url is relative and the baseurl option is specified then the url is changed accordingly.</dd> -</dl> -</div> -<div class="section"> -<h1 id="x4558414d504c4553">EXAMPLES</h1> Get urls from xkcd website:<p> -<pre style="margin-left: 0.00ex;" class="lit display"> -wget http://www.xkcd.com -q -O - | sfeed_web "http://www.xkcd.com/"</pre> -</div> -<div class="section"> -<h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man">sh(1)</a>, <a class="link-man">sfeed_update(1)</a></div> -<div class="section"> -<h1 id="x415554484f5253">AUTHORS</h1> <span class="author">Hiltjo Posthuma</span> <<a class="link-mail" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>></div> -<table summary="Document Footer" class="foot" width="100%"> -<col width="50%"> -<col width="50%"> -<tbody> -<tr> -<td class="foot-date"> -December 25, 2014</td> -<td class="foot-os" align="right"> -</td> -</tr> -</tbody> -</table> -</div> -</body> -</html> - diff --git a/doc/html/sfeed_xmlenc.1.html b/doc/html/sfeed_xmlenc.1.html deleted file mode 100644 index cf723e3..0000000 --- a/doc/html/sfeed_xmlenc.1.html +++ /dev/null @@ -1,69 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<meta name="resource-type" content="document"> -<link rel="stylesheet" href="man.css" type="text/css" media="all"> -<title> -SFEED_XMLENC(1)</title> -</head> -<body> -<div class="mandoc"> -<table summary="Document Header" class="head" width="100%"> -<col width="30%"> -<col width="30%"> -<col width="30%"> -<tbody> -<tr> -<td class="head-ltitle"> -SFEED_XMLENC(1)</td> -<td class="head-vol" align="center"> -OpenBSD Reference Manual</td> -<td class="head-rtitle" align="right"> -SFEED_XMLENC(1)</td> -</tr> -</tbody> -</table> -<div class="section"> -<h1 id="x4e414d45">NAME</h1> <b class="name">sfeed_xmlenc</b> — <span class="desc">get text-encoding from XML</span></div> -<div class="section"> -<h1 id="x53594e4f50534953">SYNOPSIS</h1><table class="synopsis"> -<col style="width: 12.00ex;"> -<col> -<tbody> -<tr> -<td> -sfeed_xmlenc</td> -<td> -</td> -</tr> -</tbody> -</table> -</div> -<div class="section"> -<h1 id="x4445534352495054494f4e">DESCRIPTION</h1> <b class="name">sfeed_xmlenc</b> reads XML data from stdin and writes the found text-encoding to stdout.</div> -<div class="section"> -<h1 id="x4558414d504c4553">EXAMPLES</h1> Get text-encoding from xkcd Atom feed:<p> -<pre style="margin-left: 0.00ex;" class="lit display"> -wget http://www.xkcd.com/atom.xml -q -O - | sfeed_xmlenc</pre> -</div> -<div class="section"> -<h1 id="x53454520414c534f">SEE ALSO</h1> <a class="link-man">sh(1)</a>, <a class="link-man">sfeed_update(1)</a></div> -<div class="section"> -<h1 id="x415554484f5253">AUTHORS</h1> <span class="author">Hiltjo Posthuma</span> <<a class="link-mail" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>></div> -<table summary="Document Footer" class="foot" width="100%"> -<col width="50%"> -<col width="50%"> -<tbody> -<tr> -<td class="foot-date"> -December 25, 2014</td> -<td class="foot-os" align="right"> -</td> -</tr> -</tbody> -</table> -</div> -</body> -</html> - @@ -15,14 +15,13 @@ tab-separated format to stdout. .Bl -tag -width 17n .It Fl v show program version +.El .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. .Pp The order and format of the fields are: -.Pp .Bl -tag -width 17n .It Ar item timestamp string, UNIX timestamp in GMT+0 @@ -42,6 +41,7 @@ string string .It Ar feed type string, "rss" or "atom" +.El .Sh SEE ALSO .Xr sh 1 , .Xr sfeed_update 1 diff --git a/sfeed_frames.1 b/sfeed_frames.1 index 5a3668e..42680b5 100644 --- a/sfeed_frames.1 +++ b/sfeed_frames.1 @@ -19,6 +19,7 @@ directory. For the exact TSV format see .It Ar directory path Path to write files to, default is ".". On success the specified directory will contain the files: +.El .Bl -tag -width 13n .It Ar index.html: this is the main HTML file referencing to the frames (items.html and @@ -28,8 +29,8 @@ this contains all the items as HTML links to the local content. .It Ar menu.html: menu frame which contains navigation "anchor" links to the feed names (in items.html). +.El .Sh FILE STRUCTURE -.Pp 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 diff --git a/sfeed_html.1 b/sfeed_html.1 index ece679e..de4df1d 100644 --- a/sfeed_html.1 +++ b/sfeed_html.1 @@ -5,7 +5,7 @@ .Nm sfeed_html .Nd formats a feeds file to HTML .Sh SYNOPSIS -.Nm sfeed_html +.Nm .Sh DESCRIPTION .Nm formats a feeds file (TSV) from diff --git a/sfeed_opml_export.1 b/sfeed_opml_export.1 index 0369b86..69b3177 100644 --- a/sfeed_opml_export.1 +++ b/sfeed_opml_export.1 @@ -1,16 +1,24 @@ -.TH SFEED 1 sfeed\-0.9 -.SH NAME -sfeed_opml_export \- generate an OPML file based on a sfeedrc config file -.SH SYNOPSIS -.B sfeed_opml_export -.RB [configfile] -.SH OPTIONS -.TP -.B [configfile] -config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default (see FILES READ section for more information). -.SH DESCRIPTION -Parse the specified config file and output OPML XML data to stdout. -.SH SEE ALSO -.BR sfeed_update(1) -.SH BUGS -Please report them! +.Dd December 25, 2014 +.Dt SFEED_OPML_EXPORT 1 +.Os +.Sh NAME +.Nm sfeed_opml_export +.Nd generate an OPML file based on a sfeedrc config file +.Sh SYNOPSIS +.Nm +.Op Ar config file +.Sh DESCRIPTION +.Nm +parses the specified config file and output OPML XML data to stdout. +.Sh OPTIONS +.Bl -tag -width 17n +.It Op config file +default: "$HOME/.sfeed/sfeedrc", see the +.Xr sfeed_update 1 +.Sx FILES READ +section for more information. +.El +.Sh SEE ALSO +.Xr sfeed_update 1 +.Sh AUTHORS +.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org diff --git a/sfeed_opml_import.1 b/sfeed_opml_import.1 index a1b5060..a9e0509 100644 --- a/sfeed_opml_import.1 +++ b/sfeed_opml_import.1 @@ -1,11 +1,15 @@ -.TH SFEED 1 sfeed\-0.9 -.SH NAME -sfeed_opml_import \- generate a sfeedrc config file based on an OPML file -.SH SYNOPSIS -.B sfeed_opml_import -.SH DESCRIPTION -It reads the OPML XML data from stdin and writes the config file text to stdout. -.SH SEE ALSO -.BR sfeed_update(1) -.SH BUGS -Please report them! +.Dd December 25, 2014 +.Dt SFEED_OPML_IMPORT 1 +.Os +.Sh NAME +.Nm sfeed_opml_import +.Nd generate a sfeedrc config file based on an OPML file +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +.Nm +reads the OPML XML data from stdin and writes the config file text to stdout. +.Sh SEE ALSO +.Xr sfeed_update 1 +.Sh AUTHORS +.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org diff --git a/sfeed_plain.1 b/sfeed_plain.1 index 688b5f6..cdef601 100644 --- a/sfeed_plain.1 +++ b/sfeed_plain.1 @@ -5,7 +5,7 @@ .Nm sfeed_plain .Nd formats a feeds file to plain text .Sh SYNOPSIS -.Nm sfeed_plain +.Nm .Sh DESCRIPTION .Nm formats a feeds file (TSV) from diff --git a/sfeed_update.1 b/sfeed_update.1 index 4ffb52a..ad50883 100644 --- a/sfeed_update.1 +++ b/sfeed_update.1 @@ -18,14 +18,13 @@ config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default see the .Sx FILES READ section for more information. +.El .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. .Pp The order and format of the fields are: -.Pp .Bl -tag -width 17n .It Ar item timestamp string, UNIX timestamp in GMT+0 @@ -45,8 +44,8 @@ string string .It Ar feed type string, "rss" or "atom" +.El .Sh EXTRA FIELDS -.Pp Extra fields added by sfeed_update: .Bl -tag -width 17n .It Ar feed name @@ -55,6 +54,7 @@ string string .It Ar item baseurl site string +.El .Sh FILES READ .Bl -tag -width 17n .It Ar sfeedrc @@ -66,6 +66,7 @@ override the merge() function to change the merge logic. The function feeds() is called to fetch the feeds. By default the function feed() is executed as a parallel job to speedup updating. +.El .Sh FILES WRITTEN .Bl -tag -width 17n .It Ar feeds @@ -73,13 +74,14 @@ Tab-separated format containing all feeds. The sfeed_update script merges new items with this file. .It Ar feeds.new Temporary file used by sfeed_update to merge items. +.El .Sh EXAMPLES -.Pp To update feeds and format the feeds file: .Bd -literal sfeed_update "configfile" sfeed_plain < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.txt sfeed_html < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.html +.Ed .Sh SEE ALSO .Xr sh 1 , .Xr sfeed_plain 1 , diff --git a/sfeed_web.1 b/sfeed_web.1 index 473a1a1..d05407b 100644 --- a/sfeed_web.1 +++ b/sfeed_web.1 @@ -15,8 +15,8 @@ urls to stdout. .Bl -tag -width 8n .It Ar baseurl optional base url to use for found feed urls that are relative. +.El .Sh OUTPUT FORMAT -.Pp content\-type<space>url<newline> .Bl -tag -width 13n .It Ar content\-type @@ -24,11 +24,12 @@ Usually application/atom+xml or application/rss+xml. .It Ar url Found url to the feed. If the url is relative and the baseurl option is specified then the url is changed accordingly. +.El .Sh EXAMPLES -.Pp Get urls from xkcd website: .Bd -literal wget http://www.xkcd.com -q -O - | sfeed_web "http://www.xkcd.com/" +.Ed .Sh SEE ALSO .Xr sh 1 , .Xr sfeed_update 1 diff --git a/sfeed_xmlenc.1 b/sfeed_xmlenc.1 index 656cc68..ce624e8 100644 --- a/sfeed_xmlenc.1 +++ b/sfeed_xmlenc.1 @@ -10,10 +10,10 @@ .Nm reads XML data from stdin and writes the found text\-encoding to stdout. .Sh EXAMPLES -.Pp Get text\-encoding from xkcd Atom feed: .Bd -literal wget http://www.xkcd.com/atom.xml -q -O - | sfeed_xmlenc +.Ed .Sh SEE ALSO .Xr sh 1 , .Xr sfeed_update 1 |