Check-in [2b95379373]
Overview
Comment: | Update online manual to current help page set. |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA1: |
2b9537937354a96fe4542dcb6e425bf6 |
User & Date: | mario on 2015-04-22 21:17:29 |
Other Links: | manifest | tags |
Context
2015-04-23
| ||
01:08 | Add TreePath() abstractions for app_state/restore. check-in: 655dd9f19c user: mario tags: trunk | |
2015-04-22
| ||
21:17 | Update online manual to current help page set. check-in: 2b95379373 user: mario tags: trunk | |
21:16 | Add some notes about DND to the manual. check-in: faacd9c284 user: mario tags: trunk | |
Changes
Modified help/html/config_apps.html from [a852c7e7ba] to [4a9bd3734e].
︙ | ︙ | |||
16 17 18 19 20 21 22 | <p class="p">On BSD/Linux systems there are a plethora of audio players. In streamtuner2 you can <span class="link"><a href="configuration.html" title="Settings dialog">configure</a></span> most of them as target application. Mostly it makes sense to use a single application for all audio formats. But at least the */* media type should be handled by a generic player, like vlc.</p> <div class="table"><div class="inner"><div class="region"><table class="table"> <tr> <td><p class="p"><span class="app">Audacious</span></p></td> | | | < < < < < | | | | | 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | <p class="p">On BSD/Linux systems there are a plethora of audio players. In streamtuner2 you can <span class="link"><a href="configuration.html" title="Settings dialog">configure</a></span> most of them as target application. Mostly it makes sense to use a single application for all audio formats. But at least the */* media type should be handled by a generic player, like vlc.</p> <div class="table"><div class="inner"><div class="region"><table class="table"> <tr> <td><p class="p"><span class="app">Audacious</span></p></td> <td style="border-left-style: solid;"><p class="p"><span class="cmd">audacious</span></p></td> <td style="border-left-style: solid;"><p class="p">audio</p></td> </tr> <tr class="shade"> <td style="border-top-style: solid;"><p class="p"><span class="app">XMMS2</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">xmms2 %m3u</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">audio</p></td> </tr> <tr> <td style="border-top-style: solid;"><p class="p"><span class="app">Amarok</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">amarok -l %pls</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">audio</p></td> </tr> <tr class="shade"> <td style="border-top-style: solid;"><p class="p"><span class="app">Exaile</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">exaile</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">audio</p></td> </tr> <tr> <td style="border-top-style: solid;"><p class="p"><span class="app">mplayer</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">mplayer %srv</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">console</p></td> </tr> <tr class="shade"> <td style="border-top-style: solid;"><p class="p"><span class="app">VLC</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">vlc %u</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">video</p></td> </tr> <tr> <td style="border-top-style: solid;"><p class="p"><span class="app">Totem</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">totem %u</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">video</p></td> </tr> <tr class="shade"> <td style="border-top-style: solid;"><p class="p"><span class="app">Media Player</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p"><span class="cmd">mplayer2.exe %asx</span></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">Win32</p></td> </tr> </table></div></div></div> <p class="p">Some audio players open a second instance when you actually want to switch radios. In this case it's a common workaround to write <span class="code">pkill vlc ; vlc %u</span> instead, which ends the previous player process and starts it anew. For VLC there's however also the <span class="code">--one-instance</span> option, which sometimes |
︙ | ︙ | |||
83 84 85 86 87 88 89 | <div class="table"><div class="inner"><div class="region"><table class="table"> <thead><tr> <td><p class="p">Placeholder</p></td> <td style="border-left-style: solid;"><p class="p">Alternatives</p></td> <td style="border-left-style: solid;"><p class="p">URL/Filename type</p></td> </tr></thead> <tr> | | | | | | | > > > > > > > > > > > > > > > > > > > > > > | | > > > | 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | <div class="table"><div class="inner"><div class="region"><table class="table"> <thead><tr> <td><p class="p">Placeholder</p></td> <td style="border-left-style: solid;"><p class="p">Alternatives</p></td> <td style="border-left-style: solid;"><p class="p">URL/Filename type</p></td> </tr></thead> <tr> <td><p class="p">%pls</p></td> <td style="border-left-style: solid;"><p class="p">%url %u %r</p></td> <td style="border-left-style: solid;"><p class="p">Either a remote .pls resource (fastest), or a local .pls file (if converted)</p></td> </tr> <tr class="shade"> <td style="border-top-style: solid;"><p class="p">%m3u</p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">%f %g %m</p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">Provides a local .m3u file for the streaming station</p></td> </tr> <tr> <td style="border-top-style: solid;"><p class="p">%srv</p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">%d %s</p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">Direct link to first streaming address, e.g. http://72.5.9.33:7500</p></td> </tr> <tr class="shade"> <td style="border-top-style: solid;"><p class="p">%xspf</p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">%x</p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">Xiph.org shareable playlist format (for modern players)</p></td> </tr> <tr> <td style="border-top-style: solid;"><p class="p">%jspf</p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">%j</p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">JSON playlist format (widely unsupported)</p></td> </tr> <tr class="shade"> <td style="border-top-style: solid;"><p class="p">%asx</p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p"></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">Some obscure Windows playlist format (don't use that)</p></td> </tr> <tr> <td style="border-top-style: solid;"><p class="p">%smil</p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p"></p></td> <td style="border-top-style: solid;border-left-style: solid;"><p class="p">Standardized multimedia sequencing lists (which nobody uses either)</p></td> </tr> </table></div></div></div> <p class="p">Preferrably use the long %abbr names for configuration.</p> <div class="note" title="Note"><div class="inner"><div class="region"><div class="contents"> <p class="p">Most audio players like pls, yet sometimes the older m3u format more. Streamripper requires %srv for recording.</p> <p class="p">Leave it to the default %pls to avoid Streamtuner2 doing unneeded extra conversions (just delays playback).</p> </div></div></div></div> </div></div> </div></div> <div class="sect sect-links" role="navigation"> <div class="hgroup"></div> <div class="contents"> <div class="links guidelinks"><div class="inner"> <div class="title"><h2><span class="title">More Information</span></h2></div> |
︙ | ︙ |
Modified help/html/configuration.html from [3ad08dc558] to [f49c8a0834].
︙ | ︙ | |||
64 65 66 67 68 69 70 | </tr> </table></div></div></div> <p class="p">Application names are most always lowercase binary names. Double click an entry to edit it. After editing the icon next to the application name will be updated. If it stays green, it's likely to work. If it turns red / into a stop symbol, then the entered name is likely incorrect.</p> <p class="p"><span class="media"><span class="media media-image"><img src="img/configapps.png" class="media media-inline" alt=""></span></span></p> <p class="p">After the application name, you can use a placeholder like "<span class="var">%pls</span>" (default), | | | | 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | </tr> </table></div></div></div> <p class="p">Application names are most always lowercase binary names. Double click an entry to edit it. After editing the icon next to the application name will be updated. If it stays green, it's likely to work. If it turns red / into a stop symbol, then the entered name is likely incorrect.</p> <p class="p"><span class="media"><span class="media media-image"><img src="img/configapps.png" class="media media-inline" alt=""></span></span></p> <p class="p">After the application name, you can use a placeholder like "<span class="var">%pls</span>" (default), or "<span class="var">%m3u</span>" and "<span class="var">%srv</span>". See <span class="link"><a href="config_apps.html#placeholders" title="URL placeholders">placeholders</a></span>.</p> <p class="p">Catch-all entries like <span class="var">*/*</span> or a generic <span class="var">audio/*</span> entry allow to configure a default player. While <span class="var">video/youtube</span> is specific to the Youtube channel. And <span class="var">url/http</span> a pseudo MIME type to configure a web browser (for station homepages).</p> <p class="p">You can remove default entries by clearing both the Format field and its associated Application. Add completely new associations through the emtpy line. (Reopen the dialog to add another one.)</p> <div class="links topiclinks"><div class="inner"><div class="region"><div class="linkdiv "><a class="linkdiv" href="config_apps.html" title="Audio players"><span class="title">Audio players</span><span class="linkdiv-dash"> โ </span><span class="desc">Common applications to use as players.</span></a></div></div></div></div> </div></div> </div></div> <div id="recording" class="sect"><div class="inner"> |
︙ | ︙ |
Added help/html/dragndrop.html version [3bc0a5d01f].
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> <title>Drag'n'drop</title> <link rel="stylesheet" type="text/css" href="C.css"> <script type="text/javascript" src="jquery.js"></script><script type="text/javascript" src="jquery.syntax.js"></script><script type="text/javascript" src="yelp.js"></script> </head> <body><div class="page" role="main"> <div class="header"><div class="trails" role="navigation"> <div class="trail"> <a class="trail" href="glossary.html" title="Glossary">Glossary</a>ย ยป <a class="trail" href="index.html#extra" title="Additional features">Additional features</a>ย ยป </div> <div class="trail"> <a class="trail" href="technical.html" title="Technical information">Technical information</a>ย ยป <a class="trail" href="index.html#extra" title="Additional features">Additional features</a>ย ยป </div> </div></div> <div class="body"> <div class="hgroup"><h1 class="title"><span class="title">Drag'n'drop</span></h1></div> <div class="region"> <div class="contents"> <p class="p">With the DND feature plugin enabled, there's an even simpler method now to export stations. Simply click and hold the mouse on a stream entry, then drag it out to the desktop, file manager or directly into VLC or any running music player. That'll usually copy a stream/station address directly.</p> <p class="p">Now it's not guaranteed to work with all applications or file managers, as X11/Gtk DND support is somewhat arcane and wonky. You may specifically have to adapt the default export format for this. Generally a XSPF or PLS file gets created for file managers. While VLC is one of the few applications that understand direct playlist URLs or literal M3U/PLS payloads even.</p> </div> <div id="import" class="sect"><div class="inner"> <div class="hgroup"><h2 class="title"><span class="title">Importing</span></h2></div> <div class="region"><div class="contents"> <p class="p">Playlist importing also works mostly. Here the action module takes care to unpack PLS, XPSF or M3U files and a few other formats. If you drag in streams/playlists from other applications, it'll usually be expanded.</p> <p class="p">Take note that Streamtuner2 is not intended as playlist manager though. It will only accept radio streaming lists and discard local MP3/Ogg files.</p> <p class="p">The import capabilities also allow to move a station entry from one of the channel tabs into your bookmarks list. Simply drag an entry over the "bookmarks" notebook tab then further along into the favourite list. - While this also works the other way round, it doesn't make sense to add bookmarks to Shoutcast/Xiph/etc. Because when their lists get refreshed (<span class="key"><kbd>F5</kbd></span>) all custom entries are usually discarded.</p> </div></div> </div></div> <div id="configuration" class="sect"><div class="inner"> <div class="hgroup"><h2 class="title"><span class="title">Export format configuration</span></h2></div> <div class="region"><div class="contents"> <p class="p">Use <span class="key"><kbd>F12</kbd></span> and change the DND export format. Again PLS is most universal, XSPF most complete, but other formats still available. Use the "desktop" format only if you want to bookmark direct playback links on your desktop.</p> <div class="note" title="Note"><div class="inner"><div class="region"><div class="contents"><p class="p">This is a workaround, because XDND is commonly just implemented as dumb file transfer scheme. Hardly any application specifies the actually desired formats, thus there's no auto-negotiation. ST2 therefore has to create temporary export files and hope for the best.</p></div></div></div></div> </div></div> </div></div> <div class="sect sect-links" role="navigation"> <div class="hgroup"></div> <div class="contents"><div class="links guidelinks"><div class="inner"> <div class="title"><h2><span class="title">More Information</span></h2></div> <div class="region"><ul><li class="links "><a href="index.html#extra" title="Additional features">Additional features</a></li></ul></div> </div></div></div> </div> </div> <div class="clear"></div> </div> <div class="footer"></div> </div></body> </html> |
Modified help/html/exportcat.html from [13bff0c001] to [b528a7d076].
︙ | ︙ | |||
25 26 27 28 29 30 31 | or playlist collection/management app (such as Rhythmbox).</p> </div> <div id="configuration" class="sect"><div class="inner"> <div class="hgroup"><h2 class="title"><span class="title">Configuration option</span></h2></div> <div class="region"><div class="contents"> <p class="p">You can set the default export format in the settings dialog <span class="key"><kbd>F12</kbd></span>.</p> | | > | 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | or playlist collection/management app (such as Rhythmbox).</p> </div> <div id="configuration" class="sect"><div class="inner"> <div class="hgroup"><h2 class="title"><span class="title">Configuration option</span></h2></div> <div class="region"><div class="contents"> <p class="p">You can set the default export format in the settings dialog <span class="key"><kbd>F12</kbd></span>.</p> <p class="p">It supports all common export formats now, with .PLS being the default.</p> </div></div> </div></div> <div class="sect sect-links" role="navigation"> <div class="hgroup"></div> <div class="contents"><div class="links guidelinks"><div class="inner"> <div class="title"><h2><span class="title">More Information</span></h2></div> <div class="region"><ul><li class="links "><a href="index.html#extra" title="Additional features">Additional features</a></li></ul></div> |
︙ | ︙ |
Modified help/html/index.html from [7cc8b98519] to [24970a0cbd].
︙ | ︙ | |||
92 93 94 95 96 97 98 99 100 101 102 103 104 105 | </div></div> <div id="extra" class="sect"><div class="inner"> <div class="hgroup"><h2 class="title"><span class="title">Additional features</span></h2></div> <div class="region"> <div class="contents"><div class="links topiclinks"><div class="inner"><div class="region"> <div class="links-twocolumn"> <div class="linkdiv "><a class="linkdiv" href="cli.html" title="CLI (command line interface)"><span class="title">CLI (command line interface)</span><span class="linkdiv-dash"> โ </span><span class="desc">Console interface, exporting data.</span></a></div> <div class="linkdiv "><a class="linkdiv" href="exportcat.html" title="Export all stations"><span class="title">Export all stations</span><span class="linkdiv-dash"> โ </span><span class="desc">Exporting a whole category as .pls.</span></a></div> </div> <div class="links-twocolumn"> <div class="linkdiv "><a class="linkdiv" href="global_key.html" title="Global_key"><span class="title">Global_key</span><span class="linkdiv-dash"> โ </span><span class="desc">Global keyboard shortcut for radio switching.</span></a></div> <div class="linkdiv "><a class="linkdiv" href="timer.html" title="Timer"><span class="title">Timer</span><span class="linkdiv-dash"> โ </span><span class="desc">Programming recurring play and recording events.</span></a></div> </div> </div></div></div></div> | > | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 | </div></div> <div id="extra" class="sect"><div class="inner"> <div class="hgroup"><h2 class="title"><span class="title">Additional features</span></h2></div> <div class="region"> <div class="contents"><div class="links topiclinks"><div class="inner"><div class="region"> <div class="links-twocolumn"> <div class="linkdiv "><a class="linkdiv" href="cli.html" title="CLI (command line interface)"><span class="title">CLI (command line interface)</span><span class="linkdiv-dash"> โ </span><span class="desc">Console interface, exporting data.</span></a></div> <div class="linkdiv "><a class="linkdiv" href="dragndrop.html" title="Drag'n'drop"><span class="title">Drag'n'drop</span><span class="linkdiv-dash"> โ </span><span class="desc">Drag and drop support.</span></a></div> <div class="linkdiv "><a class="linkdiv" href="exportcat.html" title="Export all stations"><span class="title">Export all stations</span><span class="linkdiv-dash"> โ </span><span class="desc">Exporting a whole category as .pls.</span></a></div> </div> <div class="links-twocolumn"> <div class="linkdiv "><a class="linkdiv" href="global_key.html" title="Global_key"><span class="title">Global_key</span><span class="linkdiv-dash"> โ </span><span class="desc">Global keyboard shortcut for radio switching.</span></a></div> <div class="linkdiv "><a class="linkdiv" href="timer.html" title="Timer"><span class="title">Timer</span><span class="linkdiv-dash"> โ </span><span class="desc">Programming recurring play and recording events.</span></a></div> </div> </div></div></div></div> |
︙ | ︙ |
Modified help/html/saving.html from [82781acafc] to [26b816526e].
︙ | ︙ | |||
20 21 22 23 24 25 26 | <p class="p">You can export the currently selected stream using <span class="guiseq"><span class="gui">Station</span>ย โธ <span class="gui">Save</span></span> or by pressing <span class="key"><kbd>F2</kbd></span>. A file dialog opens, where you can adapt the title. </p> <p class="p">The extension of the filename decides on the saved link format. Per default a .m3u file is created, because that's what most audio players understand.</p> | | | | | | 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | <p class="p">You can export the currently selected stream using <span class="guiseq"><span class="gui">Station</span>ย โธ <span class="gui">Save</span></span> or by pressing <span class="key"><kbd>F2</kbd></span>. A file dialog opens, where you can adapt the title. </p> <p class="p">The extension of the filename decides on the saved link format. Per default a .m3u file is created, because that's what most audio players understand.</p> <div class="note" title="Note"><div class="inner"><div class="region"><div class="contents"><p class="p"> You can also save in <span class="file">.pls</span> or <span class="file">.xspf</span> or <span class="file">.asx</span> or <span class="file">.smil</span> format. In current releases the file extension is automatically adapted when changing the filter dropdown (bottom right corner in the file dialog). </p></div></div></div></div> </div> <div class="sect sect-links" role="navigation"> <div class="hgroup"></div> <div class="contents"><div class="links guidelinks"><div class="inner"> <div class="title"><h2><span class="title">More Information</span></h2></div> <div class="region"><ul> <li class="links "><a href="streams.html#actions" title="Actions">Actions</a></li> |
︙ | ︙ |
Modified help/html/search.html from [2a2d26c9d4] to [452a5460a4].
︙ | ︙ | |||
32 33 34 35 36 37 38 | <div class="region"><div class="contents"> <p class="p">You can get to the search dialog via <span class="guiseq"><span class="gui">Edit</span>ย โธ <span class="gui">Find</span></span> or <span class="key"><kbd>Ctrl</kbd></span>+<span class="key"><kbd>F</kbd></span>. Centrally to this dialog is the text field, where you can specify the phrase to scan for.</p> <div class="media media-image"><div class="inner"><img src="img/search.png" class="media media-block" alt=""></div></div> <p class="p">It either will search in all channels, or just the last active channel/service.</p> | | | | | | 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 | <div class="region"><div class="contents"> <p class="p">You can get to the search dialog via <span class="guiseq"><span class="gui">Edit</span>ย โธ <span class="gui">Find</span></span> or <span class="key"><kbd>Ctrl</kbd></span>+<span class="key"><kbd>F</kbd></span>. Centrally to this dialog is the text field, where you can specify the phrase to scan for.</p> <div class="media media-image"><div class="inner"><img src="img/search.png" class="media media-block" alt=""></div></div> <p class="p">It either will search in all channels, or just the last active channel/service.</p> <p class="p">Then there are two search variants. You mostly want to use the live <span class="gui">Server search</span>. It passes your search terms to the actual directory services, and loads the most recent data into a result list. This might take a few seconds. And it's not implemented for all channel plugins. (Some websites/APIs don't have a search.)</p> <p class="p">While <span class="gui">Cache find</span> would just look up entries in your already downloaded channel/genre lists. This is sufficient when you're just looking for something previously seen/listened to.</p> </div></div> </div></div> <div class="sect sect-links" role="navigation"> <div class="hgroup"></div> <div class="contents"><div class="links guidelinks"><div class="inner"> <div class="title"><h2><span class="title">More Information</span></h2></div> <div class="region"><ul> |
︙ | ︙ |