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
<p><strong>PyRadio</strong> comes with 4 preconfigured (hardcoded) themes:</p>
222
+
<p><strong>PyRadio</strong> comes with 4 preconfigured (hard coded) themes:</p>
223
223
<oltype="1">
224
224
<li><strong>dark</strong> (8 color theme). This is the appearance <strong>PyRadio</strong> has always had. Enabled by default.</li>
225
-
<li><strong>light</strong> (8 color thmem). A theme for light terminal background settings.</li>
225
+
<li><strong>light</strong> (8 color theme). A theme for light terminal background settings.</li>
226
226
<li><strong>white_on_black</strong> or <strong>wob</strong> (256 color b&w theme). A theme for dark terminal background settings.</li>
227
227
<li><strong>black_on_white</strong> or <strong>bow</strong> (256 color b&w theme). A theme for light terminal background settings.</li>
228
228
</ol>
229
+
<p>The visual result of an applied theme greatly depends on the terminal settings (e.g. foreground and background color settings, palette used, number of colors supported, real or pseudo-transparency support, etc.)</p>
230
+
<p>Pressing “<strong>t</strong>” will bring up the <em>Theme selection window</em>, which can be used to activate a theme and set the default one.</p>
231
+
<pstyle="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> If the terminal supports 8 colors only, 256 color themes will not be present in this window. Furthermore, if a 256 color theme is set as default (or requested using the “<strong>-t</strong>” command line option), <strong>PyRadio</strong> will silently revert to the “<strong>dark</strong>” theme.</p>
232
+
<p>The <em>Theme selection window</em> will remain open after activating a theme, so that the user can inspect the visual result and easily change it, if desired. Then, when he is satisfied with the activated theme, the window will have to be manually closed (by pressing “<strong>q</strong>” or any other relevant key - pressing “<strong>?</strong>” will bring up its help).</p>
233
+
<p>The use of custom themes and theme editing is not implemented yet; theses are features for future releases.</p>
<p><strong>PyRadio</strong> themes are able to be used with a transparent background.</p>
236
+
<p>Pressing “<strong>T</strong>” will toggle the transparency setting and save this state in <strong>PyRadio</strong>’s configuration file (transparency is off by default).</p>
237
+
<p>Setting transparency on, will actually force <strong>PyRadio</strong> to not use its own background color, effectively making it to display whatever is on the terminal (color/picture/transparency). The visual result depends on terminal settings and whether a compositor is running.</p>
238
+
<p>When the <em>Theme selection window</em> is visible, a “<strong>[T]</strong>” string displayed at its bottom right corner will indicate that transparency is <em>on</em>.</p>
229
239
<h2id="debug-mode">Debug mode</h2>
230
240
<p>Adding the <strong><em>-d</em></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>
231
241
<p>In case of a bug or a glitch, please include this file to the issue you will <ahref="https://github.com/coderholic/pyradio/issues">open in github</a>.</p>
Copy file name to clipboardExpand all lines: README.md
+22-2Lines changed: 22 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -312,13 +312,33 @@ Example:
312
312
313
313
## PyRadio Themes
314
314
315
-
**PyRadio** comes with 4 preconfigured (hardcoded) themes:
315
+
**PyRadio** comes with 4 preconfigured (hard coded) themes:
316
316
317
317
1.**dark** (8 color theme). This is the appearance **PyRadio** has always had. Enabled by default.
318
-
2.**light** (8 color thmem). A theme for light terminal background settings.
318
+
2.**light** (8 color theme). A theme for light terminal background settings.
319
319
3.**white_on_black** or **wob** (256 color b&w theme). A theme for dark terminal background settings.
320
320
4.**black_on_white** or **bow** (256 color b&w theme). A theme for light terminal background settings.
321
321
322
+
The visual result of an applied theme greatly depends on the terminal settings (e.g. foreground and background color settings, palette used, number of colors supported, real or pseudo-transparency support, etc.)
323
+
324
+
Pressing "**t**" will bring up the *Theme selection window*, which can be used to activate a theme and set the default one.
325
+
326
+
**Note:** If the terminal supports 8 colors only, 256 color themes will not be present in this window. Furthermore, if a 256 color theme is set as default (or requested using the "**-t**" command line option), **PyRadio** will silently revert to the "**dark**" theme.
327
+
328
+
The *Theme selection window* will remain open after activating a theme, so that the user can inspect the visual result and easily change it, if desired. Then, when he is satisfied with the activated theme, the window will have to be manually closed (by pressing "**q**" or any other relevant key - pressing "**?**" will bring up its help).
329
+
330
+
The use of custom themes and theme editing is not implemented yet; theses are features for future releases.
331
+
332
+
### Using transparency
333
+
334
+
**PyRadio** themes are able to be used with a transparent background.
335
+
336
+
Pressing "**T**" will toggle the transparency setting and save this state in **PyRadio**'s configuration file (transparency is off by default).
337
+
338
+
Setting transparency on, will actually force **PyRadio** to not use its own background color, effectively making it to display whatever is on the terminal (color/picture/transparency). The visual result depends on terminal settings and whether a compositor is running.
339
+
340
+
When the *Theme selection window* is visible, a "**[T]**" string displayed at its bottom right corner will indicate that transparency is *on*.
341
+
322
342
## Debug mode
323
343
324
344
Adding the ***-d*** option to the command line will instruct **PyRadio** to enter *Debug mode*, 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 *pyradio.log*.
The visual result of an applied theme greatly depends on the terminal settings (e.g. foreground and background color settings, palette used, number of colors supported, real or pseudo-transparency support, etc.)
361
+
362
+
Pressing "\fBt\fR" will bring up the \fIThemeselectionwindow\fR, which can be used to activate a theme and set the default one.
363
+
364
+
.IP\fBNote\fR
365
+
If the terminal supports 8 colors only, 256 color themes will not be present in the \fIThemeselectionwindow\fR. Furthermore, if a 256 color theme is set as default (or requested using the "\fB-t\fR" command line option), \fBpyradio\fR will silently revert to the "\fBdark\fR" theme.
366
+
367
+
.PP
368
+
The \fIThemeselectionwindow\fR will remain open after activating a theme, so that the user can inspect the visual result and easily change it, if desired. Then, when he is satisfied with the activated theme, the window will have to be manually closed (by pressing "\fBq\fR" or any other relevant key - pressing "\fB?\fR" will bring up its help).
369
+
370
+
The use of custom themes and theme editing is not implemented yet; theses are features for future releases.
371
+
372
+
\fBUSINGTRANSPARENCY\fR
373
+
374
+
\fBpyradio\fR themes are able to be used with a transparent background.
375
+
376
+
Pressing "\fBT\fR" will toggle the transparency setting (it is \fIoff\fR by default) and save this state in \fBpyradio\fR's configuration file.
377
+
378
+
Setting transparency on, will actually force \fBpyradio\fR to not use its own background color, effectively making it to display whatever is on the terminal (color/picture/transparency). The visual result depends on terminal settings and whether a compositor is running.
379
+
380
+
When the \fIThemeselectionwindow\fR is visible, a "\fI[T]\fR" string displayed at its bottom right corner will indicate that transparency is \fIon\fR.
381
+
343
382
.SH DEBUG MODE
344
383
.PP
345
384
Adding the \fB-d\fR option to the command line will instruct \fBpyradio\fR to enter \fBDebugmode\fR, 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 \fIpyradio.log\fR.
@@ -363,5 +402,11 @@ On \fBMac OS\fR, these file may be installed in \fI/usr/local/share/doc/pyradio\
0 commit comments