randomuser
/
sfeed
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

man page improvements 

- Some rewording and typo fixes.
- Specify in more detail how sfeed_web detects links from HTML code.
This commit is contained in:
Hiltjo Posthuma 2021-07-25 11:46:35 +02:00
parent 8a07c4a3d0
commit 93044ecd31
9 changed files with 46 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
sfeed_atom.1
View File

@ -1,4 +1,4 @@
.Dd March 15, 2020
.Dd July 25, 2021
.Dt SFEED_ATOM 1
.Os
.Sh NAME
@ -6,22 +6,22 @@
.Nd format feed data to an Atom feed
.Sh SYNOPSIS
.Nm
.Op Ar file...
.Op Ar
.Sh DESCRIPTION
.Nm
formats feed data (TSV) from
.Xr sfeed 1
from stdin or
from stdin or for each
.Ar file
to stdout as an Atom (XML) feed.
If one or more
.Ar file
are specified, the basename of the
arguments are specified then the basename of the
.Ar file
is used as the feed name in the output.
If no
.Ar file
parameters are specified and so the data is read from stdin the feed name
arguments are specified and so the data is read from stdin then the feed name
is empty.
.Pp
If

14
sfeed_frames.1
View File

@ -1,4 +1,4 @@
.Dd May 30, 2020
.Dd July 25, 2021
.Dt SFEED_FRAMES 1
.Os
.Sh NAME
@ -6,19 +6,19 @@
.Nd format feed data to HTML with frames
.Sh SYNOPSIS
.Nm
.Op Ar file...
.Op Ar
.Sh DESCRIPTION
.Nm
formats feed data (TSV) from
.Xr sfeed 1
to HTML.
It reads TSV data from stdin or
from stdin or for each
.Ar file
and writes HTML files for the frameset to the current directory.
to HTML.
It writes HTML files for the frameset to the current directory.
If no
.Ar file
parameters are specified and therefore the data is read from stdin then the
menu.html file is not written.
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.

10
sfeed_gopher.1
View File

@ -1,4 +1,4 @@
.Dd January 3, 2021
.Dd July 25, 2021
.Dt SFEED_GOPHER 1
.Os
.Sh NAME
@ -6,18 +6,18 @@
.Nd format feed data to Gopher files
.Sh SYNOPSIS
.Nm
.Op Ar file...
.Op Ar
.Sh DESCRIPTION
.Nm
formats feed data (TSV) from
.Xr sfeed 1
from stdin or
from stdin or for each
.Ar file
to stdout in the raw Gopher output format.
.Pp
If one or more
.Ar file
are specified, the basename of the
arguments are specified then the basename of the
.Ar file
is used as the feed name in the output.
.Nm
@ -26,7 +26,7 @@ the same name as the feedname.
.Pp
If no
.Ar file
parameters are specified and the data is read from stdin then the data is
arguments are specified and so the data is read from stdin then the data is
written to stdout and no files are written.
.Pp
Items with a timestamp from the last day compared to the system time at the

10
sfeed_html.1
View File

@ -1,4 +1,4 @@
.Dd May 30, 2020
.Dd July 25, 2021
.Dt SFEED_HTML 1
.Os
.Sh NAME
@ -6,22 +6,22 @@
.Nd format feed data to HTML
.Sh SYNOPSIS
.Nm
.Op Ar file...
.Op Ar
.Sh DESCRIPTION
.Nm
formats feed data (TSV) from
.Xr sfeed 1
from stdin or
from stdin or for each
.Ar file
to stdout in HTML.
If one or more
.Ar file
are specified, the basename of the
arguments are specified then the basename of the
.Ar file
is used as the feed name in the output.
If no
.Ar file
parameters are specified and so the data is read from stdin the feed name
arguments are specified and so the data is read from stdin then the feed name
is empty.
.Pp
Items with a timestamp from the last day compared to the system time at the

10
sfeed_mbox.1
View File

@ -1,4 +1,4 @@
.Dd July 6, 2020
.Dd July 25, 2021
.Dt SFEED_MBOX 1
.Os
.Sh NAME
@ -6,22 +6,22 @@
.Nd format feed data to mboxrd
.Sh SYNOPSIS
.Nm
.Op Ar file...
.Op Ar
.Sh DESCRIPTION
.Nm
formats feed data (TSV) from
.Xr sfeed 1
from stdin or
from stdin or for each
.Ar file
to stdout in the mboxrd format.
If one or more
.Ar file
are specified, the basename of the
arguments are specified then the basename of the
.Ar file
is used as the feed name in the output.
If no
.Ar file
parameters are specified and so the data is read from stdin the feed name
arguments are specified and so the data is read from stdin then the feed name
is empty.
The mbox data can be further processed by tools like
.Xr procmail 1

10
sfeed_plain.1
View File

@ -1,4 +1,4 @@
.Dd January 1, 2021
.Dd July 25, 2021
.Dt SFEED_PLAIN 1
.Os
.Sh NAME
@ -6,22 +6,22 @@
.Nd format feed data to a plain-text list
.Sh SYNOPSIS
.Nm
.Op Ar file...
.Op Ar
.Sh DESCRIPTION
.Nm
formats feed data (TSV) from
.Xr sfeed 1
from stdin or
from stdin or for each
.Ar file
to stdout as a plain-text list.
If one or more
.Ar file
are specified, the basename of the
arguments are specified then the basename of the
.Ar file
is used as the feed name in the output.
If no
.Ar file
parameters are specified and so the data is read from stdin the feed name
arguments are specified and so the data is read from stdin then the feed name
is empty.
.Pp
Items with a timestamp from the last day compared to the system time at the

10
sfeed_twtxt.1
View File

@ -1,4 +1,4 @@
.Dd March 15, 2020
.Dd July 25, 2021
.Dt SFEED_TWTXT 1
.Os
.Sh NAME
@ -6,22 +6,22 @@
.Nd format feed data to a twtxt feed
.Sh SYNOPSIS
.Nm
.Op Ar file...
.Op Ar
.Sh DESCRIPTION
.Nm
formats feed data (TSV) from
.Xr sfeed 1
from stdin or
from stdin or for each
.Ar file
to stdout as a twtxt feed.
If one or more
.Ar file
are specified, the basename of the
arguments are specified then the basename of the
.Ar file
is used as the feed name in the output.
If no
.Ar file
parameters are specified and so the data is read from stdin the feed name
arguments are specified and so the data is read from stdin then the feed name
is empty.
.Sh EXIT STATUS
.Ex -std

9
sfeed_web.1
View File

@ -1,4 +1,4 @@
.Dd July 24, 2021
.Dd July 25, 2021
.Dt SFEED_WEB 1
.Os
.Sh NAME
@ -11,6 +11,11 @@
.Nm
reads the HTML website as XML or HTML data from stdin and writes the found
URLs to stdout.
.Pp
Such a link reference in HTML code looks like:
.Bd -literal
<link rel="alternate" href="atom.xml" type="application/atom+xml" />
.Ed
.Sh OPTIONS
.Bl -tag -width 8n
.It Ar baseurl
@ -33,7 +38,7 @@ Usually application/atom+xml or application/rss+xml.
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
Get URLs from xkcd website:
Get URLs from a website:
.Bd -literal
curl -s -L 'https://codemadness.org/' | sfeed_web 'https://codemadness.org/'
.Ed

4
sfeed_xmlenc.1
View File

@ -1,4 +1,4 @@
.Dd July 24, 2021
.Dd July 25, 2021
.Dt SFEED_XMLENC 1
.Os
.Sh NAME
@ -14,7 +14,7 @@ which are not allowed in an encoding-name.
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
Get text-encoding from xkcd Atom feed:
Get text-encoding from an Atom feed:
.Bd -literal
curl -s -L 'https://codemadness.org/atom.xml' | sfeed_xmlenc
.Ed