man page improvements
This commit is contained in:
parent
7199cd10a9
commit
702fd51930
23
sfeed.1
23
sfeed.1
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 6, 2021
|
.Dd July 29, 2021
|
||||||
.Dt SFEED 1
|
.Dt SFEED 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -11,21 +11,18 @@
|
||||||
.Nm
|
.Nm
|
||||||
reads RSS or Atom feed data (XML) from stdin.
|
reads RSS or Atom feed data (XML) from stdin.
|
||||||
It writes the feed data in a TAB-separated format to stdout.
|
It writes the feed data in a TAB-separated format to stdout.
|
||||||
A
|
|
||||||
.Ar baseurl
|
|
||||||
can be specified if the links or enclosures in the feed are relative URLs.
|
|
||||||
If the
|
If the
|
||||||
.Ar baseurl
|
.Ar baseurl
|
||||||
is a valid absolute URL then the relative links or enclosures will be
|
argument is a valid absolute URL then the relative links or enclosures will be
|
||||||
made absolute.
|
made an absolute URL.
|
||||||
.Sh TAB-SEPARATED FORMAT FIELDS
|
.Sh TAB-SEPARATED FORMAT FIELDS
|
||||||
The items are output per line in a TSV-like format.
|
The items are output per line in a TAB-separated format.
|
||||||
.Pp
|
.Pp
|
||||||
The fields: title, id, author are not allowed to have newlines and TABs, all
|
For the fields title, id and author each whitespace character is replaced by a
|
||||||
whitespace characters are replaced by a single space character.
|
SPACE character.
|
||||||
Control characters are removed.
|
Control characters are removed.
|
||||||
.Pp
|
.Pp
|
||||||
The content field can contain newlines and is escaped.
|
The content field can contain newlines and these are escaped.
|
||||||
TABs, newlines and '\\' are escaped with '\\', so it becomes: '\\t', '\\n'
|
TABs, newlines and '\\' are escaped with '\\', so it becomes: '\\t', '\\n'
|
||||||
and '\\\\'.
|
and '\\\\'.
|
||||||
Other whitespace characters except spaces are removed.
|
Other whitespace characters except spaces are removed.
|
||||||
|
@ -66,7 +63,5 @@ curl -s 'https://codemadness.org/atom.xml' | sfeed
|
||||||
.Sh AUTHORS
|
.Sh AUTHORS
|
||||||
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
|
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
|
||||||
.Sh CAVEATS
|
.Sh CAVEATS
|
||||||
If a timezone is not in the RFC-822 or RFC-3339 format it is not supported and
|
If a timezone for the timestamp field is not in the RFC822 or RFC3339 format it
|
||||||
the UNIX timestamp is interpreted as UTC+0.
|
is not supported and the timezone is interpreted as UTC+0.
|
||||||
.Pp
|
|
||||||
HTML in titles is treated as plain-text.
|
|
||||||
|
|
16
sfeed.5
16
sfeed.5
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 6, 2021
|
.Dd July 29, 2021
|
||||||
.Dt SFEED 5
|
.Dt SFEED 5
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -10,13 +10,13 @@
|
||||||
.Xr sfeed 1
|
.Xr sfeed 1
|
||||||
writes the feed data in a TAB-separated format to stdout.
|
writes the feed data in a TAB-separated format to stdout.
|
||||||
.Sh TAB-SEPARATED FORMAT FIELDS
|
.Sh TAB-SEPARATED FORMAT FIELDS
|
||||||
The items are output per line in a TSV-like format.
|
The items are output per line in a TAB-separated format.
|
||||||
.Pp
|
.Pp
|
||||||
The fields: title, id, author are not allowed to have newlines and TABs, all
|
For the fields title, id and author each whitespace character is replaced by a
|
||||||
whitespace characters are replaced by a single space character.
|
SPACE character.
|
||||||
Control characters are removed.
|
Control characters are removed.
|
||||||
.Pp
|
.Pp
|
||||||
The content field can contain newlines and is escaped.
|
The content field can contain newlines and these are escaped.
|
||||||
TABs, newlines and '\\' are escaped with '\\', so it becomes: '\\t', '\\n'
|
TABs, newlines and '\\' are escaped with '\\', so it becomes: '\\t', '\\n'
|
||||||
and '\\\\'.
|
and '\\\\'.
|
||||||
Other whitespace characters except spaces are removed.
|
Other whitespace characters except spaces are removed.
|
||||||
|
@ -49,7 +49,5 @@ Item, categories, multiple values are separated by |.
|
||||||
.Sh AUTHORS
|
.Sh AUTHORS
|
||||||
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
|
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
|
||||||
.Sh CAVEATS
|
.Sh CAVEATS
|
||||||
If a timezone is not in the RFC-822 or RFC-3339 format it is not supported and
|
If a timezone for the timestamp field is not in the RFC822 or RFC3339 format it
|
||||||
the UNIX timestamp is interpreted as UTC+0.
|
is not supported and the timezone is interpreted as UTC+0.
|
||||||
.Pp
|
|
||||||
HTML in titles is treated as plain-text.
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 25, 2021
|
.Dd July 31, 2021
|
||||||
.Dt SFEED_ATOM 1
|
.Dt SFEED_ATOM 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -28,10 +28,13 @@ If
|
||||||
.Nm
|
.Nm
|
||||||
is reading from one or more
|
is reading from one or more
|
||||||
.Ar file
|
.Ar file
|
||||||
it will prefix the entry title with the feed name which is the basename of the
|
arguments it will prefix the entry title with "[feed name] ".
|
||||||
input file.
|
|
||||||
.Sh EXIT STATUS
|
.Sh EXIT STATUS
|
||||||
.Ex -std
|
.Ex -std
|
||||||
|
.Sh EXAMPLES
|
||||||
|
.Bd -literal
|
||||||
|
sfeed_atom ~/.sfeed/feeds/*
|
||||||
|
.Ed
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr sfeed 1 ,
|
.Xr sfeed 1 ,
|
||||||
.Xr sfeed_plain 1 ,
|
.Xr sfeed_plain 1 ,
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 25, 2021
|
.Dd July 31, 2021
|
||||||
.Dt SFEED_FRAMES 1
|
.Dt SFEED_FRAMES 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -22,20 +22,27 @@ file is not written.
|
||||||
.Pp
|
.Pp
|
||||||
Items with a timestamp from the last day compared to the system time at the
|
Items with a timestamp from the last day compared to the system time at the
|
||||||
time of formatting are counted and marked as new.
|
time of formatting are counted and marked as new.
|
||||||
|
Items are marked as new using a bold markup.
|
||||||
.Pp
|
.Pp
|
||||||
There is an example style.css stylesheet file included in the distribution.
|
There is an example style.css stylesheet file included in the distribution.
|
||||||
.Sh FILES WRITTEN
|
.Sh FILES WRITTEN
|
||||||
.Bl -tag -width 13n
|
.Bl -tag -width 13n
|
||||||
.It index.html
|
.It index.html
|
||||||
The main HTML file referencing to the frames items.html and menu.html.
|
The main HTML file referencing the files for the frames: items.html and
|
||||||
|
menu.html.
|
||||||
.It items.html
|
.It items.html
|
||||||
The items frame contains all the item HTML links to the remote content.
|
The HTML file of the items frame which contains all the item links to the
|
||||||
|
feeds.
|
||||||
.It menu.html
|
.It menu.html
|
||||||
The menu frame which contains navigation "anchor" links to the feed names in
|
The HTML file of the menu frame which contains navigation "anchor" links (like
|
||||||
items.html.
|
"#feedname") to the feed names in items.html.
|
||||||
.El
|
.El
|
||||||
.Sh EXIT STATUS
|
.Sh EXIT STATUS
|
||||||
.Ex -std
|
.Ex -std
|
||||||
|
.Sh EXAMPLES
|
||||||
|
.Bd -literal
|
||||||
|
sfeed_frames ~/.sfeed/feeds/*
|
||||||
|
.Ed
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr sfeed 1 ,
|
.Xr sfeed 1 ,
|
||||||
.Xr sfeed_html 1 ,
|
.Xr sfeed_html 1 ,
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 25, 2021
|
.Dd July 31, 2021
|
||||||
.Dt SFEED_GOPHER 1
|
.Dt SFEED_GOPHER 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -22,7 +22,8 @@ arguments are specified then the basename of the
|
||||||
is used as the feed name in the output.
|
is used as the feed name in the output.
|
||||||
.Nm
|
.Nm
|
||||||
creates an index file named "index" and for each feed it creates a file with
|
creates an index file named "index" and for each feed it creates a file with
|
||||||
the same name as the feedname.
|
the same name as the basename of the feed
|
||||||
|
.Ar file .
|
||||||
.Pp
|
.Pp
|
||||||
If no
|
If no
|
||||||
.Ar file
|
.Ar file
|
||||||
|
@ -31,6 +32,7 @@ written to stdout and no files are written.
|
||||||
.Pp
|
.Pp
|
||||||
Items with a timestamp from the last day compared to the system time at the
|
Items with a timestamp from the last day compared to the system time at the
|
||||||
time of formatting are counted and marked as new.
|
time of formatting are counted and marked as new.
|
||||||
|
Items are marked as new with the prefix "N".
|
||||||
.Sh ENVIRONMENT
|
.Sh ENVIRONMENT
|
||||||
.Bl -tag -width Ds
|
.Bl -tag -width Ds
|
||||||
.It Ev SFEED_GOPHER_PATH
|
.It Ev SFEED_GOPHER_PATH
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 25, 2021
|
.Dd July 31, 2021
|
||||||
.Dt SFEED_HTML 1
|
.Dt SFEED_HTML 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -26,10 +26,15 @@ is empty.
|
||||||
.Pp
|
.Pp
|
||||||
Items with a timestamp from the last day compared to the system time at the
|
Items with a timestamp from the last day compared to the system time at the
|
||||||
time of formatting are counted and marked as new.
|
time of formatting are counted and marked as new.
|
||||||
|
Items are marked as new using a bold markup.
|
||||||
.Pp
|
.Pp
|
||||||
There is an example style.css stylesheet file included in the distribution.
|
There is an example style.css stylesheet file included in the distribution.
|
||||||
.Sh EXIT STATUS
|
.Sh EXIT STATUS
|
||||||
.Ex -std
|
.Ex -std
|
||||||
|
.Sh EXAMPLES
|
||||||
|
.Bd -literal
|
||||||
|
sfeed_html ~/.sfeed/feeds/*
|
||||||
|
.Ed
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr sfeed 1 ,
|
.Xr sfeed 1 ,
|
||||||
.Xr sfeed_frames 1 ,
|
.Xr sfeed_frames 1 ,
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 25, 2021
|
.Dd July 29, 2021
|
||||||
.Dt SFEED_MBOX 1
|
.Dt SFEED_MBOX 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -33,7 +33,7 @@ See the README file for some examples.
|
||||||
To make further filtering simpler some custom headers are set:
|
To make further filtering simpler some custom headers are set:
|
||||||
.Bl -tag -width Ds
|
.Bl -tag -width Ds
|
||||||
.It X-Feedname
|
.It X-Feedname
|
||||||
The feedname, this is the basename of the
|
The feed name, this is the basename of the feed
|
||||||
.Ar file .
|
.Ar file .
|
||||||
.El
|
.El
|
||||||
.Sh ENVIRONMENT VARIABLES
|
.Sh ENVIRONMENT VARIABLES
|
||||||
|
|
|
@ -26,6 +26,7 @@ is empty.
|
||||||
.Pp
|
.Pp
|
||||||
Items with a timestamp from the last day compared to the system time at the
|
Items with a timestamp from the last day compared to the system time at the
|
||||||
time of formatting are marked as new.
|
time of formatting are marked as new.
|
||||||
|
Items are marked as new with the prefix "N".
|
||||||
.Pp
|
.Pp
|
||||||
.Nm
|
.Nm
|
||||||
aligns the output.
|
aligns the output.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 25, 2021
|
.Dd July 31, 2021
|
||||||
.Dt SFEED_TWTXT 1
|
.Dt SFEED_TWTXT 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -23,8 +23,18 @@ If no
|
||||||
.Ar file
|
.Ar file
|
||||||
arguments are specified and so the data is read from stdin then the feed name
|
arguments are specified and so the data is read from stdin then the feed name
|
||||||
is empty.
|
is empty.
|
||||||
|
.Pp
|
||||||
|
If
|
||||||
|
.Nm
|
||||||
|
is reading from one or more
|
||||||
|
.Ar file
|
||||||
|
arguments it will prefix the entry title with "[feed name] ".
|
||||||
.Sh EXIT STATUS
|
.Sh EXIT STATUS
|
||||||
.Ex -std
|
.Ex -std
|
||||||
|
.Sh EXAMPLES
|
||||||
|
.Bd -literal
|
||||||
|
curl -s 'https://codemadness.org/atom.xml' | sfeed | sfeed_twtxt
|
||||||
|
.Ed
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr sfeed 1 ,
|
.Xr sfeed 1 ,
|
||||||
.Xr sfeed_plain 1 ,
|
.Xr sfeed_plain 1 ,
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 22, 2021
|
.Dd August 3, 2021
|
||||||
.Dt SFEED_UPDATE 1
|
.Dt SFEED_UPDATE 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -11,7 +11,7 @@
|
||||||
.Nm
|
.Nm
|
||||||
writes TAB-separated feed files and merges new items with the items in any
|
writes TAB-separated feed files and merges new items with the items in any
|
||||||
existing files.
|
existing files.
|
||||||
The items are stored in one file per feed in the directory
|
The items are stored as one file per feed in the directory
|
||||||
.Pa $HOME/.sfeed/feeds
|
.Pa $HOME/.sfeed/feeds
|
||||||
by default.
|
by default.
|
||||||
The directory can be changed in the
|
The directory can be changed in the
|
||||||
|
@ -42,7 +42,8 @@ format containing all items per feed.
|
||||||
The
|
The
|
||||||
.Nm
|
.Nm
|
||||||
script merges new items with this file.
|
script merges new items with this file.
|
||||||
The feedname cannot contain '/' characters, they will be replaced with '_'.
|
The feed name cannot contain the '/' character because it is a path separator,
|
||||||
|
they will be replaced with '_'.
|
||||||
.El
|
.El
|
||||||
.Sh ENVIRONMENT VARIABLES
|
.Sh ENVIRONMENT VARIABLES
|
||||||
.Bl -tag -width Ds
|
.Bl -tag -width Ds
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 25, 2021
|
.Dd July 27, 2021
|
||||||
.Dt SFEED_WEB 1
|
.Dt SFEED_WEB 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -9,12 +9,12 @@
|
||||||
.Op Ar baseurl
|
.Op Ar baseurl
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
.Nm
|
.Nm
|
||||||
reads the HTML website as XML or HTML data from stdin and writes the found
|
reads the HTML data of the webpage from stdin and writes the found URLs to
|
||||||
URLs to stdout.
|
stdout.
|
||||||
.Pp
|
.Pp
|
||||||
Such a link reference in HTML code looks like:
|
Such a link reference in HTML code looks like:
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
<link rel="alternate" href="atom.xml" type="application/atom+xml" />
|
<link rel="alternate" href="atom.xml" type="application/atom+xml" />
|
||||||
.Ed
|
.Ed
|
||||||
.Sh OPTIONS
|
.Sh OPTIONS
|
||||||
.Bl -tag -width 8n
|
.Bl -tag -width 8n
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 6, 2021
|
.Dd August 3, 2021
|
||||||
.Dt SFEEDRC 5
|
.Dt SFEEDRC 5
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -35,7 +35,8 @@ function, its arguments are:
|
||||||
.It Fa name
|
.It Fa name
|
||||||
Name of the feed, this is also used as the filename for the TAB-separated
|
Name of the feed, this is also used as the filename for the TAB-separated
|
||||||
feed file.
|
feed file.
|
||||||
The feedname cannot contain '/' characters, they will be replaced with '_'.
|
The feed name cannot contain the '/' character because it is a path separator,
|
||||||
|
they will be replaced with '_'.
|
||||||
.It Fa feedurl
|
.It Fa feedurl
|
||||||
URL to fetch the RSS/Atom data from, usually a HTTP or HTTPS URL.
|
URL to fetch the RSS/Atom data from, usually a HTTP or HTTPS URL.
|
||||||
.It Op Fa basesiteurl
|
.It Op Fa basesiteurl
|
||||||
|
|
Loading…
Reference in New Issue