You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<h2id="table-of-contents">Table of contents <spanstyle="padding-left: 10px;"><supstyle="font-size: 50%"><ahref="#" title="Go to top of the page">Top</a></sup></style></h2>
<li>MPV, MPlayer or VLC installed and in your path.</li>
169
57
</ul>
170
58
<h2id="installation">Installation <spanstyle="padding-left: 10px;"><supstyle="font-size: 50%"><ahref="#" title="Go to top of the page">Top</a></sup></style></h2>
171
-
<p>The best way to install <strong>PyRadio</strong> is via a distribution package, if one exists (e.g.<em>Arch Linux</em> and derivatives can install <atarget="_blank" href="https://aur.archlinux.org/packages/pyradio-git/">pyradio-git</a> from AUR).</p>
59
+
<p>The best way to install <strong>PyRadio</strong> is via a distribution package, if one exists (e.g.<em>Arch Linux</em> and derivatives can install <atarget="_blank" href="https://aur.archlinux.org/packages/pyradio-git/">pyradio-git</a> from AUR).</p>
172
60
<p>In any other case, and since <strong>PyRadio</strong> is currently not available via pip, you will have to <ahref="build.html">build it from source</a>.</p>
173
61
<h2id="command-line-options">Command line options <spanstyle="padding-left: 10px;"><supstyle="font-size: 50%"><ahref="#" title="Go to top of the page">Top</a></sup></style></h2>
/ n N Search, go to next / previous result [Valid] [Valid]
235
123
J Create a jump tag
236
124
<n>^U <n>^D Move station up / down. - -
125
+
' \ y Get into Registers, Extra Commands y (yank) is not applicable -
126
+
and Yank modes, respectively
237
127
? Show keys help [Valid] [Valid]
238
128
# Redraw window [Valid] [Valid]
239
129
Esc/q Quit - -
240
130
Esc/q/Left/h - Cancel / close window Cancel / close window</pre>
241
131
<p>The same logic applies to all <strong>PyRadio</strong> windows.</p>
242
132
<pstyle="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> All windows - except the <em>Search window</em> - support changing the volume and muting / unmuting the player (provided that <strong>PyRadio</strong> is actually connected to a station).</p>
133
+
<pstyle="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> When inserting numbers (either to jump to a station or to move a station), the number will be displayed at the right bottom corner of the window, suffixed by a “<em>G</em>”, i.e. pressing <em>35</em> will display <em>[35G]</em>.</p>
134
+
<pstyle="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> When tagging a station position for a move action (by pressing “<strong>J</strong>”), the position will be displayed at the right bottom corner of the window, suffixed by a “<em>J</em>”, i.e. pressing “<em>J</em>” on position <em>35</em> will display <em>[35J]</em>.</p>
243
135
<h2id="pyradios-modes">PyRadio’s Modes <spanstyle="padding-left: 10px;"><supstyle="font-size: 50%"><ahref="#" title="Go to top of the page">Top</a></sup></style></h2>
244
136
<p><strong>PyRadio</strong> has the following primary modes:</p>
<p>The functions available through the <em>secondary modes</em> are content dependent, so you can see what command is available by pressing “<strong>?</strong>” while within a secondary mode. Pressing any other key will exit the secondary mode.</p>
259
151
<h2id="config-file">Config file <spanstyle="padding-left: 10px;"><supstyle="font-size: 50%"><ahref="#" title="Go to top of the page">Top</a></sup></style></h2>
260
-
<p><strong>PyRadio</strong> upon its execution tries to read its configuration file (i.e.<em>~/.config/pyradio/config</em>). If this file is not found, it will be created. If an error occurs while parsing it, an error message will be displayed and <strong>PyRadio</strong> will terminate.</p>
152
+
<p><strong>PyRadio</strong> upon its execution tries to read its configuration file (i.e.<em>~/.config/pyradio/config</em>). If this file is not found, it will be created. If an error occurs while parsing it, an error message will be displayed and <strong>PyRadio</strong> will terminate.</p>
261
153
<p>The file contains parameters such as the player to use, the playlist to load etc. It is heavily commented (as you can see <ahref="pyradio/config">here</a>), so that manual editing is really easy. The best practice to manually edit this file is executing <strong>PyRadio</strong> with the <strong>-ocd</strong> command line option, which will open the configuration directory in your file manager, and then edit it using your preferable text editor.</p>
262
154
<p>The file can also be altered while <strong>PyRadio</strong> is running by pressing “<strong>c</strong>”, which will open the “<strong>Configuration window</strong>”. This window presents all <strong>PyRadio</strong> options and provide the way to change them and finally save them by pressing “<strong>s</strong>”.</p>
263
155
<p>In any case, <strong>PyRadio</strong> will save the file before exiting (or in case Ctrl-C is pressed) if needed (e.g. if a config parameter has been changed during its execution).</p>
264
156
<p>If saving the configuration file fails, <strong>PyRadio</strong> will create a back up file and terminate. When restarted, <strong>PyRadio</strong> will try to restore previously used settings from the said back up file.</p>
265
157
<h2id="about-playlist-files">About Playlist files <spanstyle="padding-left: 10px;"><supstyle="font-size: 50%"><ahref="#" title="Go to top of the page">Top</a></sup></style></h2>
266
158
<p><strong>PyRadio</strong> reads the stations to use from a CSV file, where each line contains two columns, the first being the station name and the second being the stream URL.</p>
267
159
<p>Optionally, a third column can be inserted, stating the encoding used by the station (more on this at <ahref="#specifying-stations-encoding">Specifying stations’ encoding</a>).</p>
268
-
<p><strong>PyRadio</strong> will by default load the user’s stations file (e.g.<em>~/.config/pyradio/stations.csv</em>) to read the stations from. If this file is not found, it will be created and populated with a default set of stations.</p>
160
+
<p><strong>PyRadio</strong> will by default load the user’s stations file (e.g.<em>~/.config/pyradio/stations.csv</em>) to read the stations from. If this file is not found, it will be created and populated with a default set of stations.</p>
269
161
<pstyle="margin: 1.5em 4em 0 4em; text-indent: -2em;"><strong>Tip:</strong> If you already have a custom <em>stations.csv</em> file, but want to update it with <strong>PyRadio</strong>’s default one, you just rename it, run <strong>PyRadio</strong> (so that the default one get created) and then merge the two files.</p>
270
-
<pstyle="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> Older versions used to use <strong>~/.pyradio</strong> as default stations file. If this file is found, it will be copied to use’s config directory (e.g.<strong>~/.config/pyradio</strong>) and renamed to <strong>stations.csv</strong> or if this file exists, to <strong>pyradio.csv</strong>. In this case, this file will be the default one.</p>
162
+
<pstyle="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> Older versions used to use <strong>~/.pyradio</strong> as default stations file. If this file is found, it will be copied to use’s config directory (e.g.<strong>~/.config/pyradio</strong>) and renamed to <strong>stations.csv</strong> or if this file exists, to <strong>pyradio.csv</strong>. In this case, this file will be the default one.</p>
271
163
<h3id="specifying-a-playlist-to-load-command-line">Specifying a playlist to load (command line)</h3>
272
164
<p><strong>PyRadio</strong> will normally load its default playlist file, as described above, upon its execution. A different file can be loaded when the <strong>-s</strong> command line option is used.</p>
273
165
<p>The <strong>-s</strong> option will accept:</p>
<p>This would be useful in the case where most of your stations do not use <strong>utf-8</strong>. Instead of editing the playlist and add the encoding to each and every affected station, you just set it globally.</p>
372
264
<h3id="finding-the-right-encoding">Finding the right encoding</h3>
<p>replacing <strong>2.7</strong> with specific version: <strong>3.0</strong> up to current python version.</p>
376
268
<h2id="player-detection-selection">Player detection / selection <spanstyle="padding-left: 10px;"><supstyle="font-size: 50%"><ahref="#" title="Go to top of the page">Top</a></sup></style></h2>
377
269
<p><strong>PyRadio</strong> is basically built around the existence of a valid media player it can use. Thus, it will auto detect the existence of its supported players upon its execution.</p>
<p>This is done by typing “<strong>v</strong>” right after setting a desired volume level.</p>
391
283
<h3id="mpv">MPV</h3>
392
284
<p>MPV uses profiles to customize its behavior.</p>
393
-
<p><strong>PyRadio</strong> defines a profile called “<strong>[pyradio]</strong>” in MPV’s configuration file (e.g.<em>~/.config/mpv/mpv.conf</em>). This profile will be used every time playback is started.</p>
285
+
<p><strong>PyRadio</strong> defines a profile called “<strong>[pyradio]</strong>” in MPV’s configuration file (e.g.<em>~/.config/mpv/mpv.conf</em>). This profile will be used every time playback is started.</p>
394
286
<p>Example:</p>
395
287
<pre>volume=100
396
288
397
289
[pyradio]
398
290
volume=50</pre>
399
291
<h3id="mplayer">MPlayer</h3>
400
292
<p>MPlayer uses profiles to customize its behavior as well.</p>
401
-
<p><strong>PyRadio</strong> defines a profile called “<strong>[pyradio]</strong>” in MPV’s configuration file (e.g.<em>~/.mplayer/config</em>). This profile will be used every time playback is started.</p>
293
+
<p><strong>PyRadio</strong> defines a profile called “<strong>[pyradio]</strong>” in MPV’s configuration file (e.g.<em>~/.mplayer/config</em>). This profile will be used every time playback is started.</p>
402
294
<p>Example:</p>
403
295
<pre>volume=100
404
296
@@ -438,7 +330,7 @@ <h2 id="copying-and-pasting---registers">Copying and pasting - Registers <span s
438
330
<ul>
439
331
<li>“<strong>p</strong>” while editing a playlist or register.</p></li>
440
332
<li>“<strong>\p</strong>” while editing a playlist or register. This would open the “<em>Paste selection</em>” window.</p></li>
441
-
<li>“<strong>\p</strong>” in the “<em>Playlist Selection</em> or the”<em>Registers</em>" window.</p></li>
333
+
<li>“<strong>\p</strong>” in the “<em>Playlist Selection</em> or the”<em>Registers</em>" window.</p></li>
442
334
</ul>
443
335
<h2id="pyradio-themes">PyRadio Themes <spanstyle="padding-left: 10px;"><supstyle="font-size: 50%"><ahref="#" title="Go to top of the page">Top</a></sup></style></h2>
444
336
<p><strong>PyRadio</strong> comes with 6 preconfigured (hard coded) themes:</p>
Copy file name to clipboardExpand all lines: README.md
+6Lines changed: 6 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -110,6 +110,8 @@ c Open Configuration window. -
110
110
/ n N Search, go to next / previous result [Valid] [Valid]
111
111
J Create a jump tag
112
112
<n>^U <n>^D Move station up / down. - -
113
+
' \ y Get into Registers, Extra Commands y (yank) is not applicable -
114
+
and Yank modes, respectively
113
115
? Show keys help [Valid] [Valid]
114
116
# Redraw window [Valid] [Valid]
115
117
Esc/q Quit - -
@@ -120,6 +122,10 @@ The same logic applies to all **PyRadio** windows.
120
122
121
123
**Note:** All windows - except the *Search window* - support changing the volume and muting / unmuting the player (provided that **PyRadio** is actually connected to a station).
122
124
125
+
**Note:** When inserting numbers (either to jump to a station or to move a station), the number will be displayed at the right bottom corner of the window, suffixed by a "*G*", i.e. pressing *35* will display *[35G]*.
126
+
127
+
**Note:** When tagging a station position for a move action (by pressing "**J**"), the position will be displayed at the right bottom corner of the window, suffixed by a "*J*", i.e. pressing "*J*" on position *35* will display *[35J]*.
0 commit comments