commit c61c37abf3b6236cd65690fe8a47bdcd9d66bc13 parent 80f1550529e08e71c87e44b38d6cf53171737d57 Author: Hiltjo Posthuma <hiltjo@codemadness.org> Date: Fri, 2 Jan 2015 15:13:12 +0100 doc: use mandoc as source, pre-generate documentation generate documentation in doc/ . Now there is no hard dependency on mandoc and systems that don't have it can just copy the files for now. Diffstat:
| M | Makefile | | | 6 | ++++-- |
| M | README | | | 7 | ++++--- |
| A | doc/html/man.css | | | 114 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/html/sfeed.1.html | | | 108 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/html/sfeed_frames.1.html | | | 90 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/html/sfeed_html.1.html | | | 66 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/html/sfeed_opml_export.1.html | | | 60 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/html/sfeed_opml_import.1.html | | | 52 | ++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/html/sfeed_plain.1.html | | | 68 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/html/sfeed_update.1.html | | | 160 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/html/sfeed_web.1.html | | | 92 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/html/sfeed_xmlenc.1.html | | | 72 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/man/sfeed.1 | | | 53 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/man/sfeed_frames.1 | | | 52 | ++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/man/sfeed_html.1 | | | 21 | +++++++++++++++++++++ |
| A | doc/man/sfeed_opml_export.1 | | | 16 | ++++++++++++++++ |
| A | doc/man/sfeed_opml_import.1 | | | 11 | +++++++++++ |
| A | doc/man/sfeed_plain.1 | | | 23 | +++++++++++++++++++++++ |
| A | doc/man/sfeed_update.1 | | | 101 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/man/sfeed_web.1 | | | 40 | ++++++++++++++++++++++++++++++++++++++++ |
| A | doc/man/sfeed_xmlenc.1 | | | 25 | +++++++++++++++++++++++++ |
21 files changed, 1232 insertions(+), 5 deletions(-)
diff --git a/Makefile b/Makefile @@ -76,16 +76,18 @@ dist: $(BIN) (cd release/${VERSION}; \ tar -czf ../../sfeed-${VERSION}.tar.gz .) +doc: doc-html doc-oldman + # man to HTML: make sure to copy the mandoc example stylesheet to # doc/html/man.css . doc-html: $(MAN1) mkdir -p doc/html - for m in $(MAN1); do mandoc -Thtml -Ostyle=man.css $$m > doc/html/$$m.html; done + for m in $(MAN1); do mandoc -Ios="" -Thtml -Ostyle=man.css $$m > doc/html/$$m.html; done # legacy man pages, if you want semantic mandoc pages just copy them. doc-oldman: $(MAN1) mkdir -p doc/man - for m in $(MAN1); do mandoc -Tman $$m > doc/man/$$m; done + for m in $(MAN1); do mandoc -Ios="" -Tman $$m > doc/man/$$m; done ${OBJ}: config.mk diff --git a/README b/README @@ -9,9 +9,6 @@ Dependencies - C compiler (C99). - libc (recommended: C99 and POSIX >= 200809). -- mandoc for documentation: http://mdocml.bsd.lv/ . If your host - system doesn't have mandoc you can convert the pages to the legacy format - with mandoc -Tman (make doc-oldman). Optional dependencies @@ -26,6 +23,10 @@ Optional dependencies used by sfeed_update. If the text in your RSS/Atom feeds are already UTF-8 encoded then you don't need this. For an alternative minimal iconv implementation: http://git.etalabs.net/cgit/noxcuse/tree/src/iconv.c +- mandoc for documentation: http://mdocml.bsd.lv/ . If your host + system doesn't have mandoc you can copy the legacy man-pages from doc/man + to your $MANPATH. For the most up-to-date documentation you can convert + the pages to the legacy format with mandoc -Tman (make doc-oldman). Platforms tested diff --git a/doc/html/man.css b/doc/html/man.css @@ -0,0 +1,114 @@ +/* $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 @@ -0,0 +1,108 @@ +<!DOCTYPE html> +<html> +<head> +<meta charset="utf-8"/> +<style> +table.head, table.foot { width: 100%; } +td.head-rtitle, td.foot-os { text-align: right; } +td.head-vol { text-align: center; } +table.foot td { width: 50%; } +table.head td { width: 33%; } +div.spacer { margin: 1em 0; } +</style> +<link rel="stylesheet" href="man.css" type="text/css" media="all"/> +<title> +SFEED(1)</title> +</head> +<body> +<div class="mandoc"> +<table class="head"> +<tbody> +<tr> +<td class="head-ltitle"> +SFEED(1)</td> +<td class="head-vol"> +General Commands Manual</td> +<td class="head-rtitle"> +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></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="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.<div class="spacer"> +</div> +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 class="foot"> +<tbody> +<tr> +<td class="foot-date"> +December 25, 2014</td> +<td class="foot-os"> +</td> +</tr> +</tbody> +</table> +</div> +</body> +</html> + diff --git a/doc/html/sfeed_frames.1.html b/doc/html/sfeed_frames.1.html @@ -0,0 +1,90 @@ +<!DOCTYPE html> +<html> +<head> +<meta charset="utf-8"/> +<style> +table.head, table.foot { width: 100%; } +td.head-rtitle, td.foot-os { text-align: right; } +td.head-vol { text-align: center; } +table.foot td { width: 50%; } +table.head td { width: 33%; } +div.spacer { margin: 1em 0; } +</style> +<link rel="stylesheet" href="man.css" type="text/css" media="all"/> +<title> +SFEED_FRAMES(1)</title> +</head> +<body> +<div class="mandoc"> +<table class="head"> +<tbody> +<tr> +<td class="head-ltitle"> +SFEED_FRAMES(1)</td> +<td class="head-vol"> +General Commands Manual</td> +<td class="head-rtitle"> +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 class="foot"> +<tbody> +<tr> +<td class="foot-date"> +December 25, 2014</td> +<td class="foot-os"> +</td> +</tr> +</tbody> +</table> +</div> +</body> +</html> + diff --git a/doc/html/sfeed_html.1.html b/doc/html/sfeed_html.1.html @@ -0,0 +1,66 @@ +<!DOCTYPE html> +<html> +<head> +<meta charset="utf-8"/> +<style> +table.head, table.foot { width: 100%; } +td.head-rtitle, td.foot-os { text-align: right; } +td.head-vol { text-align: center; } +table.foot td { width: 50%; } +table.head td { width: 33%; } +div.spacer { margin: 1em 0; } +</style> +<link rel="stylesheet" href="man.css" type="text/css" media="all"/> +<title> +SFEED_HTML(1)</title> +</head> +<body> +<div class="mandoc"> +<table class="head"> +<tbody> +<tr> +<td class="head-ltitle"> +SFEED_HTML(1)</td> +<td class="head-vol"> +General Commands Manual</td> +<td class="head-rtitle"> +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 class="foot"> +<tbody> +<tr> +<td class="foot-date"> +December 25, 2014</td> +<td class="foot-os"> +</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 @@ -0,0 +1,60 @@ +<!DOCTYPE html> +<html> +<head> +<meta charset="utf-8"/> +<style> +table.head, table.foot { width: 100%; } +td.head-rtitle, td.foot-os { text-align: right; } +td.head-vol { text-align: center; } +table.foot td { width: 50%; } +table.head td { width: 33%; } +div.spacer { margin: 1em 0; } +</style> +<link rel="stylesheet" href="man.css" type="text/css" media="all"/> +<title> +SFEED(1)</title> +</head> +<body> +<div class="mandoc"> +<table class="head"> +<tbody> +<tr> +<td class="head-ltitle"> +SFEED(1)</td> +<td class="head-vol"> +General Commands Manual</td> +<td class="head-rtitle"> +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 class="foot"> +<tr> +<td class="foot-date"> +sfeed-0.9</td> +<td class="foot-os"> +</td> +</tr> +</table> +</div> +</body> +</html> + diff --git a/doc/html/sfeed_opml_import.1.html b/doc/html/sfeed_opml_import.1.html @@ -0,0 +1,52 @@ +<!DOCTYPE html> +<html> +<head> +<meta charset="utf-8"/> +<style> +table.head, table.foot { width: 100%; } +td.head-rtitle, td.foot-os { text-align: right; } +td.head-vol { text-align: center; } +table.foot td { width: 50%; } +table.head td { width: 33%; } +div.spacer { margin: 1em 0; } +</style> +<link rel="stylesheet" href="man.css" type="text/css" media="all"/> +<title> +SFEED(1)</title> +</head> +<body> +<div class="mandoc"> +<table class="head"> +<tbody> +<tr> +<td class="head-ltitle"> +SFEED(1)</td> +<td class="head-vol"> +General Commands Manual</td> +<td class="head-rtitle"> +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 class="foot"> +<tr> +<td class="foot-date"> +sfeed-0.9</td> +<td class="foot-os"> +</td> +</tr> +</table> +</div> +</body> +</html> + diff --git a/doc/html/sfeed_plain.1.html b/doc/html/sfeed_plain.1.html @@ -0,0 +1,68 @@ +<!DOCTYPE html> +<html> +<head> +<meta charset="utf-8"/> +<style> +table.head, table.foot { width: 100%; } +td.head-rtitle, td.foot-os { text-align: right; } +td.head-vol { text-align: center; } +table.foot td { width: 50%; } +table.head td { width: 33%; } +div.spacer { margin: 1em 0; } +</style> +<link rel="stylesheet" href="man.css" type="text/css" media="all"/> +<title> +SFEED_PLAIN(1)</title> +</head> +<body> +<div class="mandoc"> +<table class="head"> +<tbody> +<tr> +<td class="head-ltitle"> +SFEED_PLAIN(1)</td> +<td class="head-vol"> +General Commands Manual</td> +<td class="head-rtitle"> +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 style="height: 1.00em;"> + </div> +</div> +<table class="foot"> +<tbody> +<tr> +<td class="foot-date"> +December 25, 2014</td> +<td class="foot-os"> +</td> +</tr> +</tbody> +</table> +</div> +</body> +</html> + diff --git a/doc/html/sfeed_update.1.html b/doc/html/sfeed_update.1.html @@ -0,0 +1,160 @@ +<!DOCTYPE html> +<html> +<head> +<meta charset="utf-8"/> +<style> +table.head, table.foot { width: 100%; } +td.head-rtitle, td.foot-os { text-align: right; } +td.head-vol { text-align: center; } +table.foot td { width: 50%; } +table.head td { width: 33%; } +div.spacer { margin: 1em 0; } +</style> +<link rel="stylesheet" href="man.css" type="text/css" media="all"/> +<title> +SFEED_UPDATE(1)</title> +</head> +<body> +<div class="mandoc"> +<table class="head"> +<tbody> +<tr> +<td class="head-ltitle"> +SFEED_UPDATE(1)</td> +<td class="head-vol"> +General Commands Manual</td> +<td class="head-rtitle"> +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.<div class="spacer"> +</div> +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:<div class="spacer"> +</div> +<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 class="foot"> +<tbody> +<tr> +<td class="foot-date"> +December 25, 2014</td> +<td class="foot-os"> +</td> +</tr> +</tbody> +</table> +</div> +</body> +</html> + diff --git a/doc/html/sfeed_web.1.html b/doc/html/sfeed_web.1.html @@ -0,0 +1,92 @@ +<!DOCTYPE html> +<html> +<head> +<meta charset="utf-8"/> +<style> +table.head, table.foot { width: 100%; } +td.head-rtitle, td.foot-os { text-align: right; } +td.head-vol { text-align: center; } +table.foot td { width: 50%; } +table.head td { width: 33%; } +div.spacer { margin: 1em 0; } +</style> +<link rel="stylesheet" href="man.css" type="text/css" media="all"/> +<title> +SFEED_WEB(1)</title> +</head> +<body> +<div class="mandoc"> +<table class="head"> +<tbody> +<tr> +<td class="head-ltitle"> +SFEED_WEB(1)</td> +<td class="head-vol"> +General Commands Manual</td> +<td class="head-rtitle"> +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:<div class="spacer"> +</div> +<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 class="foot"> +<tbody> +<tr> +<td class="foot-date"> +December 25, 2014</td> +<td class="foot-os"> +</td> +</tr> +</tbody> +</table> +</div> +</body> +</html> + diff --git a/doc/html/sfeed_xmlenc.1.html b/doc/html/sfeed_xmlenc.1.html @@ -0,0 +1,72 @@ +<!DOCTYPE html> +<html> +<head> +<meta charset="utf-8"/> +<style> +table.head, table.foot { width: 100%; } +td.head-rtitle, td.foot-os { text-align: right; } +td.head-vol { text-align: center; } +table.foot td { width: 50%; } +table.head td { width: 33%; } +div.spacer { margin: 1em 0; } +</style> +<link rel="stylesheet" href="man.css" type="text/css" media="all"/> +<title> +SFEED_XMLENC(1)</title> +</head> +<body> +<div class="mandoc"> +<table class="head"> +<tbody> +<tr> +<td class="head-ltitle"> +SFEED_XMLENC(1)</td> +<td class="head-vol"> +General Commands Manual</td> +<td class="head-rtitle"> +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:<div class="spacer"> +</div> +<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 class="foot"> +<tbody> +<tr> +<td class="foot-date"> +December 25, 2014</td> +<td class="foot-os"> +</td> +</tr> +</tbody> +</table> +</div> +</body> +</html> + diff --git a/doc/man/sfeed.1 b/doc/man/sfeed.1 @@ -0,0 +1,53 @@ +.TH "SFEED" "1" "December 25, 2014" "" "General Commands Manual" +.nh +.if n .ad l +.SH "NAME" +\fBsfeed\fR +\- simple RSS and Atom parser +.SH "SYNOPSIS" +.HP 6n +\fBsfeed\fR +[\fIsuffix\ string\fR] +.SH "DESCRIPTION" +\fBsfeed\fR +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" +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: +.TP 19n +\fIitem timestamp\fR +string, UNIX timestamp in GMT+0 +.TP 19n +\fIitem timestamp\fR +string, date and time in the format: YYYY-mm-dd HH:MM:SS tzname[+-]HHMM +.TP 19n +\fIitem title\fR +string +.TP 19n +\fIitem link\fR +string +.TP 19n +\fIitem content\fR +string +.TP 19n +\fIitem content\-type\fR +.br +string, "html" or "plain" +.TP 19n +\fIitem id\fR +string +.TP 19n +\fIitem author\fR +string +.TP 19n +\fIfeed type\fR +string, "rss" or "atom" +.SH "SEE ALSO" +sh(1), +sfeed_update(1) +.SH "AUTHORS" +Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_frames.1 b/doc/man/sfeed_frames.1 @@ -0,0 +1,52 @@ +.TH "SFEED_FRAMES" "1" "December 25, 2014" "" "General Commands Manual" +.nh +.if n .ad l +.SH "NAME" +\fBsfeed_frames\fR +\- formats a feeds file to HTML with frames +.SH "SYNOPSIS" +.HP 13n +\fBsfeed_frames\fR +[\fIdirectory\ path\fR] +.SH "DESCRIPTION" +\fBsfeed_frames\fR +formats a feeds file (TSV) from +sfeed_update(1) +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 "OPTIONS" +.TP 16n +\fIdirectory path\fR +Path to write files to, default is ".". On success the specified directory will +contain the files: +.PP +.RS 16n +.PD 0 +.TP 15n +\fIindex.html:\fR +this is the main HTML file referencing to the frames (items.html and +menu.html). +.PD +.TP 15n +\fIitems.html:\fR +this contains all the items as HTML links to the local content. +.TP 15n +\fImenu.html:\fR +menu frame which contains navigation "anchor" links to the feed names +(in items.html). +.PD 0 +.PP +.RE +.PD +.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 whitespaces are replaced by a single \- and trailing +whitespace will be removed. +.SH "SEE ALSO" +sfeed_plain(1), +sfeed_update(1), +sfeed(1) +.SH "AUTHORS" +Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_html.1 b/doc/man/sfeed_html.1 @@ -0,0 +1,21 @@ +.TH "SFEED_HTML" "1" "December 25, 2014" "" "General Commands Manual" +.nh +.if n .ad l +.SH "NAME" +\fBsfeed_html\fR +\- formats a feeds file to HTML +.SH "SYNOPSIS" +.HP 11n +\fBsfeed_html\fR +.SH "DESCRIPTION" +\fBsfeed_html\fR +formats a feeds file (TSV) from +sfeed_update(1) +to HTML. It reads TSV data from stdin and writes HTML to stdout. For the exact TSV format see +sfeed_update(1). +.SH "SEE ALSO" +sfeed_plain(1), +sfeed_update(1), +sfeed(1) +.SH "AUTHORS" +Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_opml_export.1 b/doc/man/sfeed_opml_export.1 @@ -0,0 +1,16 @@ +.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! diff --git a/doc/man/sfeed_opml_import.1 b/doc/man/sfeed_opml_import.1 @@ -0,0 +1,11 @@ +.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! diff --git a/doc/man/sfeed_plain.1 b/doc/man/sfeed_plain.1 @@ -0,0 +1,23 @@ +.TH "SFEED_PLAIN" "1" "December 25, 2014" "" "General Commands Manual" +.nh +.if n .ad l +.SH "NAME" +\fBsfeed_plain\fR +\- formats a feeds file to plain text +.SH "SYNOPSIS" +.HP 12n +\fBsfeed_plain\fR +.SH "DESCRIPTION" +\fBsfeed_plain\fR +formats a feeds file (TSV) from +sfeed_update(1) +to plain text. It reads TSV data from stdin and writes formatted plain text to +stdout. For the exact TSV format see +sfeed_update(1). +.SH "SEE ALSO" +sfeed_html(1), +sfeed_update(1), +sfeed(1) +.SH "AUTHORS" +Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> +.sp diff --git a/doc/man/sfeed_update.1 b/doc/man/sfeed_update.1 @@ -0,0 +1,101 @@ +.TH "SFEED_UPDATE" "1" "December 25, 2014" "" "General Commands Manual" +.nh +.if n .ad l +.SH "NAME" +\fBsfeed_update\fR +\- update feeds and merge with old feeds +.SH "SYNOPSIS" +.HP 13n +\fBsfeed_update\fR +[\fIconfigfile\fR] +.SH "DESCRIPTION" +\fBsfeed_update\fR +updates feeds and merges the new data with the previous feeds. This is the file +$HOME/.sfeed/feeds by default. +.SH "OPTIONS" +.TP 19n +\fIconfigfile\fR +config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default +see the +\fIFILES READ\fR +section for more information. +.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. +.PP +The order and format of the fields are: +.TP 19n +\fIitem timestamp\fR +string, UNIX timestamp in GMT+0 +.TP 19n +\fIitem timestamp\fR +string, date and time in the format: YYYY-mm-dd HH:MM:SS tzname[+-]HHMM +.TP 19n +\fIitem title\fR +string +.TP 19n +\fIitem link\fR +string +.TP 19n +\fIitem content\fR +string +.TP 19n +\fIitem content\-type\fR +.br +string, "html" or "plain" +.TP 19n +\fIitem id\fR +string +.TP 19n +\fIitem author\fR +string +.TP 19n +\fIfeed type\fR +string, "rss" or "atom" +.SH "EXTRA FIELDS" +Extra fields added by sfeed_update: +.TP 19n +\fIfeed name\fR +string +.TP 19n +\fIfeed url\fR +string +.TP 19n +\fIitem baseurl site\fR +string +.SH "FILES READ" +.TP 19n +\fIsfeedrc\fR +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. +.SH "FILES WRITTEN" +.TP 19n +\fIfeeds\fR +Tab-separated format containing all feeds. +The sfeed_update script merges new items with this file. +.TP 19n +\fIfeeds.new\fR +Temporary file used by sfeed_update to merge items. +.SH "EXAMPLES" +To update feeds and format the feeds file: +.nf +.sp +.RS 0n +sfeed_update "configfile" +sfeed_plain < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.txt +sfeed_html < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.html +.RE +.fi +.SH "SEE ALSO" +sh(1), +sfeed_plain(1), +sfeed_html(1) +.SH "AUTHORS" +Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_web.1 b/doc/man/sfeed_web.1 @@ -0,0 +1,40 @@ +.TH "SFEED_WEB" "1" "December 25, 2014" "" "General Commands Manual" +.nh +.if n .ad l +.SH "NAME" +\fBsfeed_web\fR +\- finds urls to feeds from a HTML webpage +.SH "SYNOPSIS" +.HP 10n +\fBsfeed_web\fR +[\fIbaseurl\fR] +.SH "DESCRIPTION" +\fBsfeed_web\fR +reads the HTML website as XML or HTML data from stdin and writes the found +urls to stdout. +.SH "OPTIONS" +.TP 10n +\fIbaseurl\fR +optional base url to use for found feed urls that are relative. +.SH "OUTPUT FORMAT" +content\-type<space>url<newline> +.TP 15n +\fIcontent\-type\fR +Usually application/atom+xml or application/rss+xml. +.TP 15n +\fIurl\fR +Found url to the feed. If the url is relative and the baseurl option is +specified then the url is changed accordingly. +.SH "EXAMPLES" +Get urls from xkcd website: +.nf +.sp +.RS 0n +wget http://www.xkcd.com -q -O - | sfeed_web "http://www.xkcd.com/" +.RE +.fi +.SH "SEE ALSO" +sh(1), +sfeed_update(1) +.SH "AUTHORS" +Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR> diff --git a/doc/man/sfeed_xmlenc.1 b/doc/man/sfeed_xmlenc.1 @@ -0,0 +1,25 @@ +.TH "SFEED_XMLENC" "1" "December 25, 2014" "" "General Commands Manual" +.nh +.if n .ad l +.SH "NAME" +\fBsfeed_xmlenc\fR +\- get text\-encoding from XML +.SH "SYNOPSIS" +.HP 13n +\fBsfeed_xmlenc\fR +.SH "DESCRIPTION" +\fBsfeed_xmlenc\fR +reads XML data from stdin and writes the found text\-encoding to stdout. +.SH "EXAMPLES" +Get text\-encoding from xkcd Atom feed: +.nf +.sp +.RS 0n +wget http://www.xkcd.com/atom.xml -q -O - | sfeed_xmlenc +.RE +.fi +.SH "SEE ALSO" +sh(1), +sfeed_update(1) +.SH "AUTHORS" +Hiltjo Posthuma <\fIhiltjo@codemadness.org\fR>