sfeed/sfeed_frames.1

.Dd July 31, 2021
.Dt SFEED_FRAMES 1
.Os
.Sh NAME
.Nm sfeed_frames
.Nd format feed data to HTML with frames
.Sh SYNOPSIS
.Nm
.Op Ar
.Sh DESCRIPTION
.Nm
formats feed data (TSV) from
.Xr sfeed 1
from stdin or for each
.Ar file
to HTML.
It writes HTML files for the frameset to the current directory.
If no
.Ar file
arguments are specified and so the data is read from stdin then the menu.html
file is not written.
.Pp
Items with a timestamp from the last day compared to the system time at the
time of formatting are counted and marked as new.
Items are marked as new using a bold markup.
.Pp
There is an example style.css stylesheet file included in the distribution.
.Sh FILES WRITTEN
.Bl -tag -width 13n
.It index.html
The main HTML file referencing the files for the frames: items.html and
menu.html.
.It items.html
The HTML file of the items frame which contains all the item links to the
feeds.
.It menu.html
The HTML file of the menu frame which contains navigation "anchor" links (like
"#feedname") to the feed names in items.html.
.El
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
.Bd -literal
sfeed_frames ~/.sfeed/feeds/*
.Ed
.Sh SEE ALSO
.Xr sfeed 1 ,
.Xr sfeed_html 1 ,
.Xr sfeed_plain 1 ,
.Xr sfeed 5
.Sh AUTHORS
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
man page improvements 2021-07-27 09:25:02 +00:00			`.Dd July 31, 2021`
convert man pages to mandoc 2015-01-02 13:10:48 +00:00			`.Dt SFEED_FRAMES 1`
			`.Os`
			`.Sh NAME`
			`.Nm sfeed_frames`
improve man-pages and documentation 2015-08-05 16:41:27 +00:00			`.Nd format feed data to HTML with frames`
convert man pages to mandoc 2015-01-02 13:10:48 +00:00			`.Sh SYNOPSIS`
			`.Nm`
man page improvements - Some rewording and typo fixes. - Specify in more detail how sfeed_web detects links from HTML code. 2021-07-25 09:46:35 +00:00			`.Op Ar`
convert man pages to mandoc 2015-01-02 13:10:48 +00:00			`.Sh DESCRIPTION`
			`.Nm`
improve man-pages and documentation 2015-08-05 16:41:27 +00:00			`formats feed data (TSV) from`
update and improve documentation (WIP) 2015-07-31 19:54:36 +00:00			`.Xr sfeed 1`
man page improvements - Some rewording and typo fixes. - Specify in more detail how sfeed_web detects links from HTML code. 2021-07-25 09:46:35 +00:00			`from stdin or for each`
improve man-pages and documentation 2015-08-05 16:41:27 +00:00			`.Ar file`
man page improvements - Some rewording and typo fixes. - Specify in more detail how sfeed_web detects links from HTML code. 2021-07-25 09:46:35 +00:00			`to HTML.`
			`It writes HTML files for the frameset to the current directory.`
improve man-pages and documentation 2015-08-05 16:41:27 +00:00			`If no`
			`.Ar file`
man page improvements - Some rewording and typo fixes. - Specify in more detail how sfeed_web detects links from HTML code. 2021-07-25 09:46:35 +00:00			`arguments are specified and so the data is read from stdin then the menu.html`
			`file is not written.`
documentation: document "new" items in format programs 2019-07-20 18:49:32 +00:00			`.Pp`
			`Items with a timestamp from the last day compared to the system time at the`
			`time of formatting are counted and marked as new.`
man page improvements 2021-07-27 09:25:02 +00:00			`Items are marked as new using a bold markup.`
sfeed_frames.1/sfeed_html.1: reference the style.css example file 2021-05-30 10:06:58 +00:00			`.Pp`
			`There is an example style.css stylesheet file included in the distribution.`
improve man-pages and documentation 2015-08-05 16:41:27 +00:00			`.Sh FILES WRITTEN`
convert man pages to mandoc 2015-01-02 13:10:48 +00:00			`.Bl -tag -width 13n`
update documentation, dont use semantic Ar for non-arguments 2015-09-23 21:48:15 +00:00			`.It index.html`
man page improvements 2021-07-27 09:25:02 +00:00			`The main HTML file referencing the files for the frames: items.html and`
			`menu.html.`
update documentation, dont use semantic Ar for non-arguments 2015-09-23 21:48:15 +00:00			`.It items.html`
man page improvements 2021-07-27 09:25:02 +00:00			`The HTML file of the items frame which contains all the item links to the`
			`feeds.`
update documentation, dont use semantic Ar for non-arguments 2015-09-23 21:48:15 +00:00			`.It menu.html`
man page improvements 2021-07-27 09:25:02 +00:00			`The HTML file of the menu frame which contains navigation "anchor" links (like`
			`"#feedname") to the feed names in items.html.`
doc: improve - mandoc: fix mandoc errors and warnings. - remove pre-generated HTML documentation. 2015-01-04 15:39:56 +00:00			`.El`
man pages (section 1): document exit status Document it so it can be relied upon in scripts. 2020-03-15 14:04:56 +00:00			`.Sh EXIT STATUS`
			`.Ex -std`
man page improvements 2021-07-27 09:25:02 +00:00			`.Sh EXAMPLES`
			`.Bd -literal`
			`sfeed_frames ~/.sfeed/feeds/*`
			`.Ed`
convert man pages to mandoc 2015-01-02 13:10:48 +00:00			`.Sh SEE ALSO`
doc: fix warnings (mandoc -Tlint) and regenerate old man-style (make doc-oldman). 2015-05-24 20:50:33 +00:00			`.Xr sfeed 1 ,`
sfeed_frames: overhaul sfeed_frames used to write HTML pages for each entry for each feed. This can be useful but had security issues, because the context of the content changes. sfeed_frames is now a HTML version which works better with browsers that don't support CSS or tables well like w3m and lynx. It is now an alternative for sfeed_html. - Don't reference and embed HTML content for security reasons. This was documented under "SECURITY CONSIDERATIONS" in the man page. - Tighten pledge(2). - Simplify 2018-08-16 12:16:58 +00:00			`.Xr sfeed_html 1 ,`
man pages: reference sfeed(5) in format programs, reword sfeed(5) description 2019-07-20 09:16:00 +00:00			`.Xr sfeed_plain 1 ,`
			`.Xr sfeed 5`
convert man pages to mandoc 2015-01-02 13:10:48 +00:00			`.Sh AUTHORS`
			`.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org`