Skip to content

Commit 65065bc

Browse files
committed
- Updating docs
- Adding AM_by_amsk1 theme (previous commint :) )
1 parent 5f31213 commit 65065bc

File tree

4 files changed

+65
-56
lines changed

4 files changed

+65
-56
lines changed

README.html

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1059,9 +1059,9 @@ <h2 id="command-line-options">Command line options <span style="padding-left: 10
10591059
Usage: pyradio [-h] [-c CONFIG_DIR] [-s STATIONS] [-p [PLAY]] [-u USE_PLAYER]
10601060
[-a] [-ls] [-l] [-t THEME] [--show-themes] [--no-themes]
10611061
[--write-theme IN_THEME OUT_THEME,] [--terminal TERMINAL]
1062-
[--terminal-param TERMINAL_PARAM] [-tlp] [-scd] [-ocd]
1063-
[--record] [-U] [-R] [-oc] [-sc] [-cc] [-gc] [--unlock] [-us]
1064-
[-lt] [-d] [-V]
1062+
[--terminal-param TERMINAL_PARAM] [-tlp] [-sd] [-od] [-or]
1063+
[-oc] [-sc] [-cc] [-gc] [-us] [-lt] [-r] [-d] [-ul] [-U] [-R]
1064+
[-V]
10651065

10661066
Curses based Internet radio player
10671067

@@ -1100,24 +1100,26 @@ <h2 id="command-line-options">Command line options <span style="padding-left: 10
11001100
light&quot; (which will result to &quot;pyradio -p 3 -t light&quot;).
11011101
-tlp, --toggle-load-last-playlist
11021102
Toggle autoload last opened playlist.
1103-
-scd, --show-config-dir
1103+
-sd, --show-config-dir
11041104
Print config directory [CONFIG DIR] location and exit.
1105-
-ocd, --open-config-dir
1105+
-od, --open-config-dir
11061106
Open config directory [CONFIG DIR] with default file
11071107
manager.
1108-
--record Turn recording on (not available for VLC player on
1109-
Windows).
1110-
-U, --update Update PyRadio.
1111-
-R, --uninstall Uninstall PyRadio.
1112-
-oc, --open-cache Open the Cache folder
1113-
-sc, --show-cache Show Cache contents
1114-
-cc, --clear-cache Clear Cache contents
1108+
-or, --open-recordings
1109+
Open the Recordings folder.
1110+
-oc, --open-cache Open the Cache folder.
1111+
-sc, --show-cache Show Cache contents.
1112+
-cc, --clear-cache Clear Cache contents.
11151113
-gc, --get-cache Download source code, keep it in the cache and exit.
1116-
--unlock Remove sessions&#39; lock file.
11171114
-us, --update-stations
11181115
Update &quot;stations.csv&quot; (if needed).
11191116
-lt, --log-titles Log titles to file.
1117+
-r, --record Turn recording on (not available for VLC player on
1118+
Windows).
11201119
-d, --debug Start PyRadio in debug mode.
1120+
-ul, --unlock Remove sessions&#39; lock file.
1121+
-U, --update Update PyRadio.
1122+
-R, --uninstall Uninstall PyRadio.
11211123
-V, --version Display version information.</pre>
11221124
<h2 id="controls">Controls <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
11231125
<pre> Main window Playlists window Themes window
@@ -1466,7 +1468,7 @@ <h3 id="changing-player-mid-session">Changing player mid-session</h3>
14661468
<p>If <strong>recording is on</strong> while using the previously activated player, it will remain on with the newly activated one. This actually means that the recording will stop when the old player is stopped and resumed when the new player is activated (creating a new recorder file). There is just one exception to that; selecting <strong>VLC</strong> is not possible on <strong>Windows</strong>, since <strong>VLC</strong> does not support recording on this platform.</p>
14671469
<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> The activated player will not be saved; <strong>PyRadio</strong> will still use the player defined at its config next time it is executed.</p>
14681470
<h3 id="extra-player-parameters">Extra Player Parameters</h3>
1469-
<p>All three supported players can accept a significant number of “<em>command line options</em>”, which are well documented and accessible through man pages (on linux and macOs) or the documentation (on Windows).</p>
1471+
<p>All three supported players can accept a significant number of “<em>command line options</em>”, which are well documented and accessible through man pages (on linux and MacOs) or the documentation (on Windows).</p>
14701472
<p><strong>PyRadio</strong> uses some of these parameters in order to execute and communicate with the players. In particular, the following parameters are in use <strong>by default</strong>:</p>
14711473
<table>
14721474
<colgroup>
@@ -1496,13 +1498,12 @@ <h3 id="extra-player-parameters">Extra Player Parameters</h3>
14961498
</table>
14971499
<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> The user should not use or change the above player parameters. Failing to do so, may render the player <strong><em>unusable</em></strong>.</p>
14981500
<p><strong>PyRadio</strong> provides a way for the user to add extra parameters to the player, either by a command line option, or the “<em>Configuration Window</em>” (under “<em>Player:</em>”).</p>
1499-
<p>This way, 10 sets of parameters can be inserted and made available for selection.</p>
15001501
<h4 id="using-the-configuration-window">Using the Configuration Window</h4>
15011502
<p>When the user uses the configuration window (shown in the following image), he is presented with an interface which will permit him to select the player to use with <strong>PyRadio</strong> and edit its extra parameters.</p>
15021503
<p><a href="https://members.hellug.gr/sng/pyradio/pyradio-player-selection.jpg" target="_blank"><img src="https://members.hellug.gr/sng/pyradio/pyradio-player-selection.jpg" alt="PyRadio Player Selection Window" /></a></p>
15031504

1504-
<p>Each of the supported players can have up to 11 sets of extra parameters (the first one is the default).</p>
1505-
<p>The user can add (“<strong>a</strong>”) a new parameter, edit (“<strong>e</strong>”) an existing set and delete (“<strong>x</strong>” or “<strong>DEL</strong>”) one.</p>
1505+
<p>For each of the supported players the existing profiles (not for <em>VLC</em>) and existing extra parameters will be displayed.</p>
1506+
<p>The user can add (“<strong>a</strong>”) a new parameter, edit (“<strong>e</strong>”) an existing set and delete (“<strong>x</strong>” or “<strong>DEL</strong>”) one; profiles cannot be edited or deleted, though.</p>
15061507
<h2 id="player-connection-protocol">Player connection protocol <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
15071508
<p>Most radio stations use plain old http protocol to broadcast, but some of them use https.</p>
15081509
<p>Experience has shown that playing a <strong>https</strong> radio station depends on the combination of the station’s configuration and the player used.</p>
@@ -1603,6 +1604,12 @@ <h2 id="pyradio-themes">PyRadio Themes <span style="padding-left: 10px;"><sup st
16031604
</ol>
16041605
<p>Furthermore, a number of themes (these are actual files saved in the <strong>themes</strong> installation directory) are also available:</p>
16051606
<ul>
1607+
<li><strong>AM_by_amski1</strong><br />
1608+
A simple green on dark theme, created for Window.</li>
1609+
<li><strong>blue-by-boxer</strong><br />
1610+
A reddish on blue theme by user <strong>Boxer</strong> at <a target="_blank" href="https://forum.maboxlinux.org/">Mabox Forum</a>.</li>
1611+
<li><strong>catppuccin-frappe</strong>, <strong>catppuccin-latte</strong>, <strong>catppuccin-macchiato</strong> and <strong>catppuccin-mocha</strong><br />
1612+
Four themes by the <a target="_blank" href="https://github.com/catppuccin">Catppuccin community</a>.</li>
16061613
<li><strong>classic_by_obsdg</strong><br />
16071614
A clasic theme by <a target="_blank" href="https://github.com/OpenBSDGuy">The OpenBSD Guy</a>, originally created on <a target="_blank" href="https://www.openbsd.org/">OpenBSD</a>.</li>
16081615
<li><strong>cupcake_by_edunfelt</strong> and <strong>fairyflossy_by_edunfelt</strong><br />
@@ -1613,10 +1620,6 @@ <h2 id="pyradio-themes">PyRadio Themes <span style="padding-left: 10px;"><sup st
16131620
A theme by user <a target="_blank" href="https://forum.maboxlinux.org/u/ben_chile">ben_chile</a> created on the <a target="_blank" href="https://maboxlinux.org">Mabox Linux</a> Forum.</li>
16141621
<li><strong>pastel_based_by_sng</strong><br />
16151622
A dim but colorful theme.</li>
1616-
<li><strong>catppuccin-frappe</strong>, <strong>catppuccin-latte</strong>, <strong>catppuccin-macchiato</strong> and <strong>catppuccin-mocha</strong><br />
1617-
Four themes by the <a target="_blank" href="https://github.com/catppuccin">Catppuccin community</a>.</li>
1618-
<li><strong>blue-by-boxer</strong><br />
1619-
A reddish on blue theme by user <strong>Boxer</strong> at <a target="_blank" href="https://forum.maboxlinux.org/">Mabox Forum</a>.</li>
16201623
</ul>
16211624
<p>Contrary to the old styling method, which was terminal and palette dependent, a new styling method has been implemented; actual CSS colors can now be defined.</p>
16221625
<p>Theme sample / template:</p>

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,9 @@ $ pyradio -h
140140
Usage: pyradio [-h] [-c CONFIG_DIR] [-s STATIONS] [-p [PLAY]] [-u USE_PLAYER]
141141
[-a] [-ls] [-l] [-t THEME] [--show-themes] [--no-themes]
142142
[--write-theme IN_THEME OUT_THEME,] [--terminal TERMINAL]
143-
[--terminal-param TERMINAL_PARAM] [-tlp] [-scd] [-ocd]
144-
[--record] [-U] [-R] [-oc] [-sc] [-cc] [-gc] [--unlock] [-us]
145-
[-lt] [-d] [-V]
143+
[--terminal-param TERMINAL_PARAM] [-tlp] [-sd] [-od] [-or]
144+
[-oc] [-sc] [-cc] [-gc] [-us] [-lt] [-r] [-d] [-ul] [-U] [-R]
145+
[-V]
146146
147147
Curses based Internet radio player
148148
@@ -181,24 +181,26 @@ Options:
181181
light" (which will result to "pyradio -p 3 -t light").
182182
-tlp, --toggle-load-last-playlist
183183
Toggle autoload last opened playlist.
184-
-scd, --show-config-dir
184+
-sd, --show-config-dir
185185
Print config directory [CONFIG DIR] location and exit.
186-
-ocd, --open-config-dir
186+
-od, --open-config-dir
187187
Open config directory [CONFIG DIR] with default file
188188
manager.
189-
--record Turn recording on (not available for VLC player on
190-
Windows).
191-
-U, --update Update PyRadio.
192-
-R, --uninstall Uninstall PyRadio.
193-
-oc, --open-cache Open the Cache folder
194-
-sc, --show-cache Show Cache contents
195-
-cc, --clear-cache Clear Cache contents
189+
-or, --open-recordings
190+
Open the Recordings folder.
191+
-oc, --open-cache Open the Cache folder.
192+
-sc, --show-cache Show Cache contents.
193+
-cc, --clear-cache Clear Cache contents.
196194
-gc, --get-cache Download source code, keep it in the cache and exit.
197-
--unlock Remove sessions' lock file.
198195
-us, --update-stations
199196
Update "stations.csv" (if needed).
200197
-lt, --log-titles Log titles to file.
198+
-r, --record Turn recording on (not available for VLC player on
199+
Windows).
201200
-d, --debug Start PyRadio in debug mode.
201+
-ul, --unlock Remove sessions' lock file.
202+
-U, --update Update PyRadio.
203+
-R, --uninstall Uninstall PyRadio.
202204
-V, --version Display version information.
203205
```
204206

@@ -664,7 +666,7 @@ If **recording is on** while using the previously activated player, it will rema
664666

665667
### Extra Player Parameters
666668

667-
All three supported players can accept a significant number of "*command line options*", which are well documented and accessible through man pages (on linux and macOs) or the documentation (on Windows).
669+
All three supported players can accept a significant number of "*command line options*", which are well documented and accessible through man pages (on linux and MacOs) or the documentation (on Windows).
668670

669671
**PyRadio** uses some of these parameters in order to execute and communicate with the players. In particular, the following parameters are in use **by default**:
670672

@@ -678,17 +680,15 @@ All three supported players can accept a significant number of "*command line op
678680

679681
**PyRadio** provides a way for the user to add extra parameters to the player, either by a command line option, or the "*Configuration Window*" (under "*Player:*").
680682

681-
This way, 10 sets of parameters can be inserted and made available for selection.
682-
683683
#### Using the Configuration Window
684684

685685
When the user uses the configuration window (shown in the following image), he is presented with an interface which will permit him to select the player to use with **PyRadio** and edit its extra parameters.
686686

687687
![PyRadio Player Selection Window](https://members.hellug.gr/sng/pyradio/pyradio-player-selection.jpg)
688688

689-
Each of the supported players can have up to 11 sets of extra parameters (the first one is the default).
689+
For each of the supported players the existing profiles (not for *VLC*) and existing extra parameters will be displayed.
690690

691-
The user can add ("**a**") a new parameter, edit ("**e**") an existing set and delete ("**x**" or "**DEL**") one.
691+
The user can add ("**a**") a new parameter, edit ("**e**") an existing set and delete ("**x**" or "**DEL**") one; profiles cannot be edited or deleted, though.
692692

693693
## Player connection protocol
694694

@@ -845,6 +845,12 @@ A theme for light terminal background settings.
845845

846846
Furthermore, a number of themes (these are actual files saved in the **themes** installation directory) are also available:
847847

848+
- **AM_by_amski1** \
849+
A simple green on dark theme, created for Window.
850+
- **blue-by-boxer** \
851+
A reddish on blue theme by user **Boxer** at [Mabox Forum](https://forum.maboxlinux.org/).
852+
- **catppuccin-frappe**, **catppuccin-latte**, **catppuccin-macchiato** and **catppuccin-mocha** \
853+
Four themes by the [Catppuccin community](https://github.com/catppuccin).
848854
- **classic_by_obsdg** \
849855
A clasic theme by [The OpenBSD Guy](https://github.com/OpenBSDGuy), originally created on [OpenBSD](https://www.openbsd.org/).
850856
- **cupcake_by_edunfelt** and **fairyflossy_by_edunfelt** \
@@ -855,10 +861,6 @@ Two themes based on the [gruvbox](https://github.com/morhetz/gruvbox) theme.
855861
A theme by user [ben_chile](https://forum.maboxlinux.org/u/ben_chile) created on the [Mabox Linux](https://maboxlinux.org) Forum.
856862
- **pastel_based_by_sng** \
857863
A dim but colorful theme.
858-
- **catppuccin-frappe**, **catppuccin-latte**, **catppuccin-macchiato** and **catppuccin-mocha** \
859-
Four themes by the [Catppuccin community](https://github.com/catppuccin).
860-
- **blue-by-boxer** \
861-
A reddish on blue theme by user **Boxer** at [Mabox Forum](https://forum.maboxlinux.org/).
862864

863865
Contrary to the old styling method, which was terminal and palette dependent, a new styling method has been implemented; actual CSS colors can now be defined.
864866

pyradio.1

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.\" Copyright (C) 2018-2023 Spiros Georgaras <[email protected]>
33
.\" This manual is freely distributable under the terms of the GPL.
44
.\"
5-
.TH pyradio 1 "August 2023" pyradio
5+
.TH pyradio 1 "October 2023" pyradio
66

77
.SH Name
88
.PP
@@ -49,16 +49,12 @@ Use this terminal for Desktop file instead of the auto-detected one. Use "none"
4949
Use this as \fBpyradio\fR parameter in the Desktop File. Please replace hyphens with underscores when passing the parameter, for example: \fI--terminal-param\fR "\fB_p 3 _t light\fR" (which will result to "\fIpyradio \fB-p 3 -t light\fR").
5050
.IP \fB-tlp\fR,\ \fB--toggle-load-last-playlist
5151
Toggle autoload last opened playlist.
52-
.IP \fB-scd\fR,\fB--show-config-dir\fR
52+
.IP \fB-sd\fR,\fB--show-config-dir\fR
5353
Print config directory (\fI[CONFIG DIR]\fR) location and exit.
54-
.IP \fB-ocd\fR,\fB--open-config-dir\fR
54+
.IP \fB-od\fR,\fB--open-config-dir\fR
5555
Open config directory (\fI[CONFIG DIR]\fR) with default file manager.
56-
.IP \fB|\ \fR(\fBVertical\ line\fR\ or\ \fBPipe\ symbol\fR)
57-
Enable / disable recording.
58-
.IP \fB-U\fR,\ \fB--update\fR
59-
Update \fBpyradio\fR.
60-
.IP \fB-R\fR,\ \fB--uninstall\fR
61-
Uninstall \fBpyradio\fR.
56+
.IP \fB-or\fR,\fB--open-recordings\fR
57+
Open the Recordings folder.
6258
.IP \fB-oc\fR,\ \fB--open-cache\fR
6359
Open the Cache folder.
6460
.IP \fB-sc\fR,\ \fB--show-cache\fR
@@ -67,16 +63,24 @@ Show Cache contents.
6763
Clear Cache contents.
6864
.IP \fB-gc\fR,\ \fB--get-cache\fR
6965
Download source code, keep it in the cache and exit.
70-
.IP \fB--unlock
71-
Remove sessions' lock file.
7266
.IP \fB-us\fR,\ \fB--update_stations
7367
Update "\fIstations.csv\fR" (if needed).
7468
.IP \fB-lt\fR,\ \fB--log-titles\fR
7569
Log titles to file.
70+
.IP \fB-r\fR,\ \fB--record\fR
71+
Turn recording on (not available for VLC player on Windows).
7672
.IP \fB-d\fR,\fB\ \--debug
7773
Enable \fBDEBUG MODE\fR.
74+
.IP \fB-ul\fR,\ \fB--unlock\fR
75+
Remove sessions' lock file.
76+
.IP \fB-U\fR,\ \fB--update\fR
77+
Update \fBpyradio\fR.
78+
.IP \fB-R\fR,\ \fB--uninstall\fR
79+
Uninstall \fBpyradio\fR.
80+
.IP \fB-V\fR,\fB\ \--version\fR
81+
Display version information.
7882
.IP \fB-h\fR,\fB\ \--help
79-
Show usage information and exit.
83+
Display usage information and exit.
8084

8185
.RE
8286
.PP

pyradio_rb.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" Copyright (C) 2018-2023 Spiros Georgaras <[email protected]>
22
.\" This manual is freely distributable under the terms of the GPL.
33
.\"
4-
.TH pyradio_rb 1 "January 2023" pyradio
4+
.TH pyradio_rb 1 "October 2023" pyradio
55

66
.SH Name
77
.PP

0 commit comments

Comments
 (0)