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 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 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
|
<?xml version="1.0" encoding="utf-8"?>
<!-- Manual page for Minirok.
Copyright (c) 2007-2008 Adeodato Simó (dato@net.com.org.es)
Licensed under the terms of the MIT license.
-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
"file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd"
[]>
<refentry>
<refentryinfo>
<author>
<firstname>Adeodato</firstname>
<surname>Simó</surname>
</author>
<address>
<email>dato@net.com.org.es</email>
</address>
<date>2007-09-04</date>
</refentryinfo>
<refmeta>
<refentrytitle>minirok</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>minirok</refname>
<refpurpose>a small music player written in Python</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>minirok</command>
<arg choice="opt">options</arg>
<arg choice="opt" rep="repeat">file</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
Minirok is a small music player written in Python for the K
Desktop Environment. To start it, select it from the applications
menu, or type <command>minirok</command> in a terminal.
</para>
<para>
To reproduce music, first type in the combo box at the left the
directory where music is located, and press enter, or select "Open
directory" from the File menu. Available audio files will be shown
in a tree structure. Locate the files you want to play, and use
drag and drop to append them to the playlist in the right. You can
also press double click in a file or a folder to append it to the
existing playlist.
</para>
<para>
Both the tree view and the playlist have search line widgets above
them. Typing text in them will reduce the shown items to those
matching the introduced words. If you press enter after a search
in the tree view completes, the visible items will be appended to
the playlist. If you press enter in the playlist search line, the
first visible track will be played.
</para>
<para>
You can modify the order in which the tracks are played by
enqueueing them in a different order. For this, press right button
click on a track, and select "Enqueue track". Or press Control +
RightButtonClick on the track to enqueue.
</para>
<para>
Similarly, you can signal that playing should stop after a certain
track. To do this, select "Stop playing after this track" in the
contextual menu as above, or press Control + MiddleButtonClick.
</para>
<para>
If you make changes to the filesystem, you can quickly refresh the
tree view by clicking on the refresh button next to the combo box
with the directory name. A key can be also configurated to do
this, F5 by default.
</para>
</refsect1>
<refsect1>
<title>DBUS INTERFACE</title>
<para>
Minirok offers a DBus interface to control the player and various
other bits. At the moment a single object /Player is provided,
under the org.kde.minirok service. To invoke a DBus method, run
from a terminal <command>qdbus org.kde.minirok /Player
<replaceable>methodName</replaceable></command>.
<command>dbus-send</command>(1) should also work, but
then you'll need to fully qualify the method name.
</para>
<para>
Here's a list of available methods:
</para>
<programlisting> Play
Pause
PlayPause
Stop
Next
Previous
NowPlaying
AppendToPlaylist
StopAfterCurrent</programlisting>
<para>
See the <filename>README.Usage</filename> file for details. Note
that this interface will only be available if the required
dependencies are installed. See the <filename>README</filename>
file a list of these.
</para>
</refsect1>
<refsect1>
<title>LAST.FM</title>
<para>
Minirok can submit played tracks to Last.fm, or any other
Last.fm-compatible service (such as Libre.fm). You will just need
to configure your username and password in the preferences dialog.
Starting with Minirok 2.1, no external software is needed any more.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>-a</option></term>
<term><option>--append</option></term>
<listitem>
<para>
Try to append the files given as arguments to an existing
Minirok instance first. If that fails, start a new Minirok
instance as usual. (This is done via DBus, see the
<filename>README</filename> file for required dependencies.)
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Minirok also accepts many other options for using the Qt and KDE
libraries. Run <command>minirok --help-all</command> for a
comprehensive list.
</para>
</refsect1>
<refsect1>
<title>REPORTING BUGS</title>
<para>
Please report bug to the Debian Bug Tracking System. See the
<filename>README.Bugs</filename> file for instructions.
</para>
<para>
A list of reported issues is kept at http://bugs.debian.org/minirok.
</para>
</refsect1>
<refsect1>
<title>COPYRIGHT</title>
<para>
Minirok is Copyright (c) 2007-2009 Adeodato Simó, and licensed under
the terms of the MIT license.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><filename>/usr/share/doc/minirok/NEWS</filename></para>
<para><filename>/usr/share/doc/minirok/FAQ</filename></para>
<para><filename>/usr/share/doc/minirok/README</filename></para>
<para><filename>/usr/share/doc/minirok/README.Bugs</filename></para>
<para><filename>/usr/share/doc/minirok/README.Lastfm</filename></para>
<para><filename>/usr/share/doc/minirok/README.Usage</filename></para>
<para><filename>/usr/share/doc/minirok/TODO</filename></para>
</refsect1>
</refentry>
|