commit d204e2373cc9f7e3f3afa3d4f2afb7976f67b4ae
parent 7ed31cfe093fa52711f0bdd407abc1e4d67f11b3
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Fri, 5 Jun 2020 17:19:39 +0200
update man pages a bit for the recent changes
Diffstat:
3 files changed, 14 insertions(+), 18 deletions(-)
diff --git a/tscrape.1 b/tscrape.1
@@ -1,14 +1,14 @@
-.Dd March 20, 2020
+.Dd June 05, 2020
.Dt TSCRAPE 1
.Os
.Sh NAME
.Nm tscrape
-.Nd Twitter scraper
+.Nd Twitter parser
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
.Nm
-reads the Twitter HTML page and scrapes the data into a
+reads the Twitter JSON API data and converts the data into a
TAB-separated format to stdout.
.Sh TAB-SEPARATED FORMAT FIELDS
The items are saved in a TSV-like format.
@@ -37,10 +37,6 @@ Item is pinned or not? 0 or 1.
.El
.Sh EXIT STATUS
.Ex -std
-.Sh EXAMPLES
-.Bd -literal -offset left
-curl -H 'User-Agent:' -s 'https://twitter.com/namehere' | tscrape
-.Ed
.Sh SEE ALSO
.Xr curl 1
.Sh AUTHORS
diff --git a/tscrape.5 b/tscrape.5
@@ -1,4 +1,4 @@
-.Dd March 20, 2020
+.Dd June 05, 2020
.Dt TSCRAPE 5
.Os
.Sh NAME
diff --git a/tscraperc.5 b/tscraperc.5
@@ -25,7 +25,7 @@ The default is 8.
.It Fn feeds
This function is the required "main" entry-point function called from
.Xr tscrape_update 1 .
-.It Fn feed "name" "feedurl"
+.It Fn feed "name" "twittername"
Inside the
.Fn feeds
function feeds can be defined by calling the
@@ -36,8 +36,8 @@ function, its arguments are:
Name of the feed, this is also used as the filename for the TAB-separated
feed file.
The feedname cannot contain '/' characters, they will be replaced with '_'.
-.It Fa feedurl
-Url to fetch the data from, usually a HTTP or HTTPS url.
+.It Fa twittername
+Name of Twitter account to fetch data from.
.El
.El
.Sh OVERRIDE FUNCTIONS
@@ -46,13 +46,13 @@ Because
is a shellscript each function can be overridden to change its behaviour,
notable functions are:
.Bl -tag -width Ds
-.It Fn fetch "name" "url" "feedfile"
+.It Fn fetch "name" "twittername" "feedfile"
Fetch feed from url and writes data to stdout, its arguments are:
.Bl -tag -width Ds
.It Fa name
Specified name in configuration file (useful for logging).
-.It Fa url
-Url to fetch.
+.It Fa twittername
+Name of Twitter account to fetch data from.
.It Fa feedfile
Used feedfile (useful for comparing modification times).
.El
@@ -95,10 +95,10 @@ shown below:
# list of feeds to fetch:
feeds() {
- # feed <name> <feedurl>
- feed "Rich Felker" "https://twitter.com/richfelker"
- feed "Internet of shit" "https://twitter.com/internetofshit"
- feed "Donald Trump" "https://twitter.com/realdonaldtrump"
+ # feed <name> <twittername>
+ feed "Rich Felker" "richfelker"
+ feed "Internet of shit" "internetofshit"
+ feed "Donald Trump" "realdonaldtrump"
}
.Ed
.Sh SEE ALSO
