From c77b5c3a699d129436e5a757973f84265f41e135 Mon Sep 17 00:00:00 2001 From: Hiltjo Posthuma Date: Sun, 4 Jan 2015 16:39:56 +0100 Subject: doc: improve - mandoc: fix mandoc errors and warnings. - remove pre-generated HTML documentation. --- Makefile | 4 +- doc/html/man.css | 114 ---------------------------- doc/html/sfeed.1.html | 113 --------------------------- doc/html/sfeed_frames.1.html | 88 --------------------- doc/html/sfeed_html.1.html | 64 ---------------- doc/html/sfeed_opml_export.1.html | 58 -------------- doc/html/sfeed_opml_import.1.html | 50 ------------ doc/html/sfeed_plain.1.html | 64 ---------------- doc/html/sfeed_stats.1.html | 64 ---------------- doc/html/sfeed_update.1.html | 156 -------------------------------------- doc/html/sfeed_web.1.html | 89 ---------------------- doc/html/sfeed_xmlenc.1.html | 69 ----------------- sfeed.1 | 4 +- sfeed_frames.1 | 3 +- sfeed_html.1 | 2 +- sfeed_opml_export.1 | 40 ++++++---- sfeed_opml_import.1 | 26 ++++--- sfeed_plain.1 | 2 +- sfeed_update.1 | 10 ++- sfeed_web.1 | 5 +- sfeed_xmlenc.1 | 2 +- 21 files changed, 57 insertions(+), 970 deletions(-) delete mode 100644 doc/html/man.css delete mode 100644 doc/html/sfeed.1.html delete mode 100644 doc/html/sfeed_frames.1.html delete mode 100644 doc/html/sfeed_html.1.html delete mode 100644 doc/html/sfeed_opml_export.1.html delete mode 100644 doc/html/sfeed_opml_import.1.html delete mode 100644 doc/html/sfeed_plain.1.html delete mode 100644 doc/html/sfeed_stats.1.html delete mode 100644 doc/html/sfeed_update.1.html delete mode 100644 doc/html/sfeed_web.1.html delete mode 100644 doc/html/sfeed_xmlenc.1.html diff --git a/Makefile b/Makefile index 60e5fcf..bf8751f 100644 --- a/Makefile +++ b/Makefile @@ -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 @@ - - - - - - - -SFEED(1) - - -
- ---- - - - - - - -
-SFEED(1) -OpenBSD Reference Manual -SFEED(1)
-
-

NAME

sfeed — simple RSS and Atom parser
-
-

SYNOPSIS

--- - - - - - -
-sfeed -[suffix string | -v]
-
-
-

DESCRIPTION

sfeed reads RSS or Atom feed data (XML) from stdin. It writes the feed data in a tab-separated format to stdout.
-
-

OPTIONS

-
--v
-
-show program version
-
-
-
-

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.

-The order and format of the fields are:

-
-item timestamp
-
-string, UNIX timestamp in GMT+0
-
-item timestamp
-
-string, date and time in the format: YYYY-mm-dd HH:MM:SS tzname[[+-][HHMM]]
-
-item title
-
-string
-
-item link
-
-string
-
-item content
-
-string
-
-item content-type
-
-string, "html" or "plain"
-
-item id
-
-string
-
-item author
-
-string
-
-feed type
-
-string, "rss" or "atom"
-
-
-
-

SEE ALSO

sh(1), sfeed_update(1)
-
-

AUTHORS

Hiltjo Posthuma <hiltjo@codemadness.org>
- --- - - - - - -
-December 25, 2014 -
-
- - - 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 @@ - - - - - - - -SFEED_FRAMES(1) - - -
- ---- - - - - - - -
-SFEED_FRAMES(1) -OpenBSD Reference Manual -SFEED_FRAMES(1)
-
-

NAME

sfeed_frames — formats a feeds file to HTML with frames
-
-

SYNOPSIS

--- - - - - - -
-sfeed_frames -[directory path]
-
-
-

DESCRIPTION

sfeed_frames 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).
-
-

OPTIONS

-
-directory path
-
-Path to write files to, default is ".". On success the specified directory will contain the files:
-
-index.html:
-
-this is the main HTML file referencing to the frames (items.html and menu.html).
-
-items.html:
-
-this contains all the items as HTML links to the local content.
-
-menu.html:
-
-menu frame which contains navigation "anchor" links to the feed names (in items.html).
-
-
-
-
-
-

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.
-
-

SEE ALSO

sfeed_plain(1), sfeed_update(1), sfeed(1)
-
-

AUTHORS

Hiltjo Posthuma <hiltjo@codemadness.org>
- --- - - - - - -
-December 25, 2014 -
-
- - - 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 @@ - - - - - - - -SFEED_HTML(1) - - -
- ---- - - - - - - -
-SFEED_HTML(1) -OpenBSD Reference Manual -SFEED_HTML(1)
-
-

NAME

sfeed_html — formats a feeds file to HTML
-
-

SYNOPSIS

--- - - - - - -
-sfeed_html -
-
-
-

DESCRIPTION

sfeed_html 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).
-
-

SEE ALSO

sfeed_plain(1), sfeed_update(1), sfeed(1)
-
-

AUTHORS

Hiltjo Posthuma <hiltjo@codemadness.org>
- --- - - - - - -
-December 25, 2014 -
-
- - - 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 @@ - - - - - - - -SFEED(1) - - -
- ---- - - - - - - -
-SFEED(1) -OpenBSD Reference Manual -SFEED(1)
-
-

NAME

sfeed_opml_export - generate an OPML file based on a sfeedrc config file
-
-

SYNOPSIS

sfeed_opml_export [configfile]
-
-

OPTIONS

-
-[configfile]
-
-config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default (see FILES READ section for more information).
-
-
-
-

DESCRIPTION

Parse the specified config file and output OPML XML data to stdout.
-
-

SEE ALSO

sfeed_update(1)
-
-

BUGS

Please report them!
- --- - - - -
-sfeed-0.9 -
-
- - - 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 @@ - - - - - - - -SFEED(1) - - -
- ---- - - - - - - -
-SFEED(1) -OpenBSD Reference Manual -SFEED(1)
-
-

NAME

sfeed_opml_import - generate a sfeedrc config file based on an OPML file
-
-

SYNOPSIS

sfeed_opml_import
-
-

DESCRIPTION

It reads the OPML XML data from stdin and writes the config file text to stdout.
-
-

SEE ALSO

sfeed_update(1)
-
-

BUGS

Please report them!
- --- - - - -
-sfeed-0.9 -
-
- - - 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 @@ - - - - - - - -SFEED_PLAIN(1) - - -
- ---- - - - - - - -
-SFEED_PLAIN(1) -OpenBSD Reference Manual -SFEED_PLAIN(1)
-
-

NAME

sfeed_plain — formats a feeds file to plain text
-
-

SYNOPSIS

--- - - - - - -
-sfeed_plain -
-
-
-

DESCRIPTION

sfeed_plain 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).
-
-

SEE ALSO

sfeed_html(1), sfeed_update(1), sfeed(1)
-
-

AUTHORS

Hiltjo Posthuma <hiltjo@codemadness.org>
- --- - - - - - -
-December 25, 2014 -
-
- - - 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 @@ - - - - - - - -SFEED_STATS(1) - - -
- ---- - - - - - - -
-SFEED_STATS(1) -OpenBSD Reference Manual -SFEED_STATS(1)
-
-

NAME

sfeed_stats — formats a feeds file to show a plain text summary
-
-

SYNOPSIS

--- - - - - - -
-sfeed_stats -
-
-
-

DESCRIPTION

sfeed_stats formats a feeds file (TSV) from sfeed_update(1) 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 sfeed_update(1).
-
-

SEE ALSO

sfeed_update(1), sfeed(1)
-
-

AUTHORS

Hiltjo Posthuma <hiltjo@codemadness.org>
- --- - - - - - -
-January 3, 2015 -
-
- - - 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 @@ - - - - - - - -SFEED_UPDATE(1) - - -
- ---- - - - - - - -
-SFEED_UPDATE(1) -OpenBSD Reference Manual -SFEED_UPDATE(1)
-
-

NAME

sfeed_update — update feeds and merge with old feeds
-
-

SYNOPSIS

--- - - - - - -
-sfeed_update -[configfile]
-
-
-

DESCRIPTION

sfeed_update updates feeds and merges the new data with the previous feeds. This is the file $HOME/.sfeed/feeds by default.
-
-

OPTIONS

-
-configfile
-
-config file, if not specified uses the location $HOME/.sfeed/sfeedrc by default see the FILES READ section for more information.
-
-
-
-

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.

-The order and format of the fields are:

-
-item timestamp
-
-string, UNIX timestamp in GMT+0
-
-item timestamp
-
-string, date and time in the format: YYYY-mm-dd HH:MM:SS tzname[[+-][HHMM]]
-
-item title
-
-string
-
-item link
-
-string
-
-item content
-
-string
-
-item content-type
-
-string, "html" or "plain"
-
-item id
-
-string
-
-item author
-
-string
-
-feed type
-
-string, "rss" or "atom"
-
-
-
-

EXTRA FIELDS

Extra fields added by sfeed_update:
-
-feed name
-
-string
-
-feed url
-
-string
-
-item baseurl site
-
-string
-
-
-
-

FILES READ

-
-sfeedrc
-
-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.
-
-
-
-

FILES WRITTEN

-
-feeds
-
-Tab-separated format containing all feeds. The sfeed_update script merges new items with this file.
-
-feeds.new
-
-Temporary file used by sfeed_update to merge items.
-
-
-
-

EXAMPLES

To update feeds and format the feeds file:

-

-sfeed_update "configfile" 
-sfeed_plain < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.txt 
-sfeed_html < $HOME/.sfeed/feeds > $HOME/.sfeed/feeds.html
-
-
-

SEE ALSO

sh(1), sfeed_plain(1), sfeed_html(1)
-
-

AUTHORS

Hiltjo Posthuma <hiltjo@codemadness.org>
- --- - - - - - -
-December 25, 2014 -
-
- - - 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 @@ - - - - - - - -SFEED_WEB(1) - - -
- ---- - - - - - - -
-SFEED_WEB(1) -OpenBSD Reference Manual -SFEED_WEB(1)
-
-

NAME

sfeed_web — finds urls to feeds from a HTML webpage
-
-

SYNOPSIS

--- - - - - - -
-sfeed_web -[baseurl]
-
-
-

DESCRIPTION

sfeed_web reads the HTML website as XML or HTML data from stdin and writes the found urls to stdout.
-
-

OPTIONS

-
-baseurl
-
-optional base url to use for found feed urls that are relative.
-
-
-
-

OUTPUT FORMAT

content-type<space>url<newline>
-
-content-type
-
-Usually application/atom+xml or application/rss+xml.
-
-url
-
-Found url to the feed. If the url is relative and the baseurl option is specified then the url is changed accordingly.
-
-
-
-

EXAMPLES

Get urls from xkcd website:

-

-wget http://www.xkcd.com -q -O - | sfeed_web "http://www.xkcd.com/"
-
-
-

SEE ALSO

sh(1), sfeed_update(1)
-
-

AUTHORS

Hiltjo Posthuma <hiltjo@codemadness.org>
- --- - - - - - -
-December 25, 2014 -
-
- - - 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 @@ - - - - - - - -SFEED_XMLENC(1) - - -
- ---- - - - - - - -
-SFEED_XMLENC(1) -OpenBSD Reference Manual -SFEED_XMLENC(1)
-
-

NAME

sfeed_xmlenc — get text-encoding from XML
-
-

SYNOPSIS

--- - - - - - -
-sfeed_xmlenc -
-
-
-

DESCRIPTION

sfeed_xmlenc reads XML data from stdin and writes the found text-encoding to stdout.
-
-

EXAMPLES

Get text-encoding from xkcd Atom feed:

-

-wget http://www.xkcd.com/atom.xml -q -O - | sfeed_xmlenc
-
-
-

SEE ALSO

sh(1), sfeed_update(1)
-
-

AUTHORS

Hiltjo Posthuma <hiltjo@codemadness.org>
- --- - - - - - -
-December 25, 2014 -
-
- - - diff --git a/sfeed.1 b/sfeed.1 index e371930..31fd661 100644 --- a/sfeed.1 +++ b/sfeed.1 @@ -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\-typeurl .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 -- cgit v1.2.3