Skip to content

Commit

Permalink
Stop using ronn to generate the man pages.
Browse files Browse the repository at this point in the history
ronn is unmaintained and it is a pain to install it now.
  • Loading branch information
mlj committed Jan 20, 2025
1 parent 5bce058 commit e97b179
Show file tree
Hide file tree
Showing 8 changed files with 280 additions and 256 deletions.
4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@ config.status
config.sub
aclocal.m4
po
castget.1
castget.1.html
castgetrc.5
castgetrc.5.html
.libs
.deps
*.o
Expand Down
12 changes: 0 additions & 12 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ SUBDIRS = tests src
EXTRA_DIST = \
castgetrc.example \
castget.1 \
castget.1.ronn \
castgetrc.5 \
castgetrc.5.ronn \
CHANGES.md \
ChangeLog.old

Expand All @@ -33,13 +31,3 @@ man_MANS = \
castgetrc.5

AUTOMAKE_OPTIONS = foreign

.PHONY: html

html: castget.1.html castgetrc.5.html

%.html: %.ronn
ronn --manual="User Commands" --organization="castget @VERSION@" --html $< > $@

%: %.ronn
ronn --manual="User Commands" --organization="castget @VERSION@" --roff $< > $@
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,6 @@ make
make install
```

You will also need [ronn](http://rtomayko.github.io/ronn/), which is used to
build the man pages. Prebuilt man pages are included in the distribution.

### Building from Dockerfile

A Dockerfile is available in contrib folder.
Expand Down
140 changes: 140 additions & 0 deletions castget.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
.TH "CASTGET" "1" "January 2025" "castget 2.0.1" "User Commands"
.
.SH "NAME"
\fBcastget\fR \- download RSS enclosures
.
.SH "SYNOPSIS"
\fBcastget\fR [\fIOPTION\fR\.\.\.] [\fICHANNEL IDENTIFIER\fR\.\.\.]
.
.SH "DESCRIPTION"
\fBcastget\fR downloads RSS enclosures, for example podcasts, from RSS feeds\.
.
.P
RSS feeds are assigned \fIchannel identifier\fRs in the configuration file \fB\.castgetrc\fR\. Channels to be processed by \fBcastget\fR are indicated by supplying the channel identifiers as arguments\. If no channel identifiers are provided, all available channels are processed\.
.
.P
If run without any options, \fBcastget\fR will perform the default action on all channels to be processed\. The default action is to download any enclosure not already downloaded\. Other actions may be performed by supplying one or more options as arguments\.
.
.SH "OPTIONS"
.
.SS "Operations"
.
.TP
\fB\-c\fR, \fB\-\-catchup\fR
Catch up with channels and exit\.
.
.TP
\fB\-l\fR, \fB\-\-list\fR
List available enclosures that have not yet been downloaded, and exit\.
.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display help and exit\.
.
.TP
\fB\-V\fR, \fB\-\-version\fR
Output version information and exit\.
.
.SS "Operation filters"
.
.TP
\fB\-n\fR, \fB\-\-new\-only\fR
Restrict operation to new channels only, i\.e\. to channels that have never been downloaded from or been caught up with before\. Note that if a channel is added to the configuration and subsequently removed, its download history is preserved\. This means that a channel that has been removed from the configuration file will not be considered as \'new\' if it is added to the configuration again at a later time\.
.
.TP
\fB\-1\fR, \fB\-\-first\-only\fR
Restrict operation to the most recent item in each channel only\.
.
.TP
\fB\-f\fR \fIpattern\fR, \fB\-\-filter\fR=\fIpattern\fR
Restrict operation to enclosures whose download URLs match the regular expression \fBpattern\fR\. Note that this will override any regular expression filters given in the configuration file\.
.
.SS "Global options"
.
.TP
\fB\-r\fR, \fB\-\-resume\fR
Resume aborted downloads\. Make sure not to use this option if the RSS feed uses the same filename for multiple enclosures as this will corrupt existing downloads\.
.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Do not print anything except error messages\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print detailed progress information\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Print (lots of) connection debug information\.
.
.TP
\fB\-p\fR, \fB\-\-progress\-bar\fR
Print a progress bar when downloading enclosures\.
.
.TP
\fB\-C\fR \fIfilename\fR, \fB\-\-rcfile\fR=\fIfilename\fR
Override the default filename for the configuration file\.
.
.SH "EXAMPLES"
.
.TP
Download all enclosures not already downloaded:
.
.IP
$ castget
.
.TP
Download all enclosures not already downloaded from channel \fBfoobar\fR and be verbose:
.
.IP
$ castget \-v foobar
.
.TP
List all enclosures not already downloaded:
.
.IP
$ castget \-l
.
.TP
Catch up with channel \fBfoobar\fR:
.
.IP
$ castget \-c foobar
.
.TP
List the first available enclosure in all new channels:
.
.IP
$ castget \-1 \-n \-l
.
.TP
Catch up with items that match the regular expression \fBFreddies0[67]\fR in the channel \fBfrederator\fR:
.
.IP
$ castget \-c \-f "Freddies0[67]" frederator
.
.SH "HTTP PROXY"
.
.TP
To use a HTTP proxy, set the environment variable \fBhttp_proxy\fR:
.
.IP
http_proxy=http://your\.proxy\.server:port/ castget
.
.SH "SEE ALSO"
castgetrc(5)
.
.SH "BUGS"
Please see the castget home page \fIhttp://mlj\.github\.io/castget\fR for instructions on how to submit bug reports\.
.
.SH "AUTHORS"
Marius L\. Jøhndal, Jick Nan\.
.
.SH "COPYRIGHT"
Castget is Copyright (C) 2005\-2021 Marius L\. Jøhndal\.
.
.P
Castget is Copyright (C) 2007 Jick Nan\.
.
.P
This is free software; see the source for copying conditions\. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\.
125 changes: 0 additions & 125 deletions castget.1.ronn

This file was deleted.

Loading

0 comments on commit e97b179

Please sign in to comment.