Skip to content

Commit 308dbb1

Browse files
committed
- Shortcuts window:
* implementing "r" (load saved) and "d" (load default) * TAB is not accepted as a shortcut * digits (1-9) will be asscpted * the window will close only by pressing the Cancel button - DEVEL: updating what_tag to use get__shortcuts_and_classes.py - updating docs
1 parent 874e1f1 commit 308dbb1

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

docs/index.html

+26-3
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ <h2 id="table-of-contents">Table of Contents <span style="padding-left: 10px;"><
5151
<li><a href="#controls">Controls</a>
5252
<ul>
5353
<li><a href="#global-shortcuts">Global shortcuts</a></li>
54+
<li><a href="#customizing-key-bindings">Customizing key bindings</a></li>
5455
</ul></li>
5556
<li><a href="#html-help">HTML help</a></li>
5657
<li><a href="#pyradio-modes">PyRadio Modes</a>
@@ -142,6 +143,7 @@ <h2 id="table-of-contents">Table of Contents <span style="padding-left: 10px;"><
142143
<ul>
143144
<li><a href="#remote-control-client">Remote Control Client</a></li>
144145
</ul></li>
146+
<li><a href="#playing-a-station-in-the-terminal">Playing a station in the terminal</a></li>
145147
<li><a href="#debug-mode">Debug mode</a></li>
146148
<li><a href="#reporting-bugs">Reporting bugs</a></li>
147149
<li><a href="#packaging-pyradio">Packaging PyRadio</a></li>
@@ -159,6 +161,7 @@ <h2 id="features">Features <span style="padding-left: 10px;"><sup style="font-si
159161
<li>Station editor (add/edit) with <a href="#cjk-characters-support">CJK characters support</a></li>
160162
<li>Configuration editor</li>
161163
<li>Search function</li>
164+
<li>Customizable key bindings</li>
162165
<li>Easy installation / updating</li>
163166
<li>Runs on Linux, macOS and Windows</li>
164167
</ul>
@@ -184,6 +187,13 @@ <h2 id="requirements">Requirements <span style="padding-left: 10px;"><sup style=
184187
<h2 id="changelog">Changelog <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
185188
<pre style="height: 200px;">
186189

190+
2024-10-17 s-n-g
191+
* version 0.9.3.11.2 (BUG FIX) - 0.9.3.12-beta2
192+
* Implementing the Shortcuts Window, making it possible to customize
193+
PyRadio's key bindings
194+
* fixing install.py (#262)
195+
* implementing #252
196+
187197
2024-10-17 s-n-g
188198
* version 0.9.3.11.1 (BUG FIX) - 0.9.3.12-beta1
189199
* adding -sdd (--show_dirs) command line parameter
@@ -1319,9 +1329,9 @@ <h2 id="installation">Installation <span style="padding-left: 10px;"><sup style=
13191329
Furthermore, please refrain from using any third-party packaging methods, such as <strong>Snap</strong> or <strong>AppImage</strong>. I am not affiliated with these services or projects, and I cannot guarantee the functionality or version of <strong>PyRadio</strong> provided through them. Additionally, I am unable to offer support for any issues related to these packaging methods.</p>
13201330
<h2 id="command-line-options">Command line options <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
13211331
<pre># pyradio -h
1322-
Usage: pyradio [-h] [-c CONFIG_DIR] [-p [STATION_NUMBER]] [-u PLAYER] [-l]
1323-
[-lt] [-sds] [-sd] [-od] [-pc] [-d] [-ul] [-us] [-U] [-R] [-V]
1324-
[-ls] [-s PLAYLIST] [-tlp] [-t THEME] [--show-themes]
1332+
Usage: pyradio [-h] [-c CONFIG_DIR] [-p [STATION_NUMBER]] [-x] [-u PLAYER]
1333+
[-l] [-lt] [-sds] [-sd] [-od] [-pc] [-d] [-ul] [-us] [-U] [-R]
1334+
[-V] [-ls] [-s PLAYLIST] [-tlp] [-t THEME] [--show-themes]
13251335
[--no-themes] [--write-theme IN_THEME OUT_THEME,]
13261336
[--terminal TERMINAL] [--terminal-param TERMINAL_PARAM] [-oc]
13271337
[-sc] [-cc] [-gc] [-r] [-or] [-lr] [-mkv MKV_FILE]
@@ -1339,6 +1349,9 @@ <h2 id="command-line-options">Command line options <span style="padding-left: 10
13391349
-p [STATION_NUMBER], --play [STATION_NUMBER]
13401350
Start and play.The value is num station or empty for
13411351
random.
1352+
-x, --external-player
1353+
Play station in external player. Can be combined with
1354+
--play.
13421355
-u PLAYER, --use-player PLAYER
13431356
Use specified player. A comma-separated list can be
13441357
used to specify detection order. Supported players:
@@ -1437,6 +1450,7 @@ <h2 id="command-line-options">Command line options <span style="padding-left: 10
14371450
a message that it is already running).
14381451
</pre>
14391452
<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>
1453+
<p>The following list shows a <strong>default</strong> key bindings list used within the program.</p>
14401454
<pre> Main window Playlists window Themes window
14411455
-------------------------------------------------------------------------------------------------------------------------------------
14421456
Up/Down/j/k/
@@ -1529,6 +1543,9 @@ <h3 id="global-shortcuts">Global shortcuts</h3>
15291543
<p><strong>Notes</strong></p>
15301544
<p class="indented">[1] Function not available when in <strong>Playlist</strong> and <strong>Registers</strong> mode. More info on <em>PyRadio’s modes</em> below.</p>
15311545
<p class="indented">[2] Function not available in the <strong>RadioBrowser</strong> Search window.</p>
1546+
<h3 id="customizing-key-bindings">Customizing key bindings</h3>
1547+
<p><strong>PyRadio</strong> provides the possibility to customize the key bindings above.</p>
1548+
<p>Just open the configuration window and navigate to <strong>Keyboard Shortcuts</strong>. Please do read the help screen provided therein (press “*?” to get to it).</p>
15321549
<h2 id="html-help">HTML help <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
15331550
<p>While in <strong>PyRadio</strong> main window, one can open the HTML (offline) help using “<strong>\h</strong>”.</p>
15341551
<p>This is just a helper function for windows users who cannot use the man pages, but is still available for all platforms.</p>
@@ -2136,6 +2153,12 @@ <h2 id="remote-control-server">Remote Control Server <span style="padding-left:
21362153
<h3 id="remote-control-client">Remote Control Client</h3>
21372154
<p><strong>PyRadio</strong> comes with its own client, which will make it easier to communicate with the <strong>Remote Control Server</strong>.</p>
21382155
<p>For more information, please refer to <a href="client.html">the relevant page</a>.</p>
2156+
<h2 id="playing-a-station-in-the-terminal">Playing a station in the terminal <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
2157+
<p>A user request <a target="_blank" href="https://github.com/coderholic/pyradio/issues/252">Shortcut to quit pyradio and launch standalone player (e.g. mpv) with currently selected station</a> lead to the possibility to use any player in the terminal.</p>
2158+
<p>This action will be triggered by pressing “<em>X</em>”.</p>
2159+
<p>After the player stops, <strong>PyRadio</strong> will stop as well.</p>
2160+
<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> On Windows, <strong>mpv</strong> and <strong>VLC</strong> will open a new player window instead of executing in the terminal.</p>
2161+
<p>In addition, a command line parameter has been added “<em>-x</em>” (“<em>–exteranl-player</em>”) which when used in conjuction with the “<em>-p</em>” (“<em>–play</em>”) command line parameter, will instruct <strong>PyRadio</strong> to play a station and terminate after the playback stops.</p>
21392162
<h2 id="debug-mode">Debug mode <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
21402163
<p>Adding the “<strong>-d</strong>” option to the command line will instruct <strong>PyRadio</strong> to enter <em>Debug mode</em>, which means that it will print debug messages to a file. This file will always reside in the user’s home directory and will be named <em>pyradio.log</em>.</p>
21412164
<p>In case of a bug or a glitch, please include this file to the issue you will <a target="_blank" href="https://github.com/coderholic/pyradio/issues">open at github</a>.</p>

0 commit comments

Comments
 (0)