<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>CLI (command line interface)</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">CLI (command line interface)</span></h1></div>
<div class="region">
<div class="contents">
<p class="p">Streamtuner2 is a graphical tool. But it also has a limited commandline interface,
which can be used to query station information. This is useful for interfacing with
other applications.</p>
<p class="p">Open a terminal and call <span class="code">streamtuner2 help</span> to get an overview over
available commands.</p>
<div class="terms"><div class="inner">
<div class="title title-terms"><h2><span class="title">Examples</span></h2></div>
<div class="region"><dl class="terms">
<dt class="terms"><span class="code">streamtuner2 play "station"</span></dt>
<dd class="terms"><p class="p">This command looks through all channel plugins, and finds a station containing the
mentioned title. You must put the station title in quotes in shell calls, if it contains
e.g. spaces. You can optionally specify a channelname before the station title.</p></dd>
<dt class="terms"><span class="code">streamtuner2 url [channel] "station"</span></dt>
<dd class="terms"><p class="p">Just looks up the streaming URL for a given station. If no channel name is given,
ST2 searches through all available channel plugins again.</p></dd>
<dt class="terms"><span class="code">streamtuner2 stream shoutcast "station"</span></dt>
<dd class="terms"><p class="p">Prints available station data as JSON</p></dd>
<dt class="terms"><span class="code">streamtuner2 category internet_radio_org_uk "Pop"</span></dt>
<dd class="terms"><p class="p">Loads fresh data from the specified channel service, and prints out JSON data for
the whole category. Note that the category name must have the excact case.</p></dd>
<dt class="terms"><span class="code">streamtuner2 categories channel</span></dt>
<dd class="terms"><p class="p">Fetches the current list of available categories/genres for a channel service.</p></dd>
</dl></div>
</div></div>
<p class="p">Specifying a channel name is often optional. If you add one, it should be all-lowercase.
You can also give a list, like "shoutcast,xiph" which would be searched then.</p>
</div>
<div id="" class="sect"><div class="inner">
<div class="hgroup"><h2 class="title"><span class="title">GUI options</span></h2></div>
<div class="region"><div class="contents">
<p class="p">There are also a few command line flags, which influence the
graphical runtime.</p>
<div class="list"><div class="inner"><div class="region"><ul class="list">
<li class="list">
<div class="title title-item"><h3><span class="title">--gtk3</span></h3></div>
<p class="p">Picks the Gtk3 toolkit. Which is default for Python3 runs.
But could also be used for Python2 instead of pygtk.</p>
</li>
<li class="list">
<div class="title title-item"><h3><span class="title">--gtk2</span></h3></div>
<p class="p">Fake option. Python2 runs on Gtk2 per default. And Py3 is
bound to Gtk3/PyGObject anyway.</p>
</li>
<li class="list">
<div class="title title-item"><h3><span class="title">-D</span></h3></div>
<p class="p">Enable debug output on the console. Identical to the debug
configuration dialog option.</p>
</li>
<li class="list">
<div class="title title-item"><h3><span class="title">-d plugin</span></h3></div>
<p class="p">Disable a named plugin. Useful if it hangs on startup. So
<span class="cmd">-d xiph</span> can temporarily disable it. Note that this
flag gets set durably by clicking [save] in the config
dialog.</p>
</li>
<li class="list">
<div class="title title-item"><h3><span class="title">-e plugin</span></h3></div>
<p class="p">Enable a channel/feature plugin just once.</p>
</li>
<li class="list">
<div class="title title-item"><h3><span class="title">-h</span></h3></div>
<p class="p">Print help list with all known command line flags. Note that
this excludes details on the CLI action commands.</p>
</li>
<li class="list">
<div class="title title-item"><h3><span class="title">-x</span></h3></div>
<p class="p">Exit right away. A flag only used for testing.</p>
</li>
</ul></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>