root/trunk/README.in

Revision 607, 4.6 kB (checked in by nicfit, 1 year ago)

Lotta minore updates and fix for #302 (j keybinding changed to Ctrl+j)

Line 
1 = README: Mesk @PACKAGE_VERSION@ =
2
3 == Downloads ==
4  * Latest release
5    [http://mesk.nicfit.net/releases/mesk-@PACKAGE_VERSION@.tgz mesk-@PACKAGE_VERSION@.tgz]
6  * Previous releases can be found [http://mesk.nicfit.net/releases/ here].
7  * Gentoo ebuilds are available [http://mesk.nicfit.net/releases/gentoo/ here].
8
9 == Requirements ==
10 Mesk has a substantial number of dependencies, some of which are optional.
11
12 The following list is required:
13  * Python >= 2.4
14  * PyGtk >= 2.10 / Gtk+ >= 2.10
15  * librsvg >= 2.14
16  * gstreamer >= 0.10.11 / gst-python >= 0.10
17  * MP3 audio (optional):
18    * gst-plugins-mad
19    * eyeD3 >= 0.6.11
20  * Ogg Vorbis audio (optional):
21    * gst-plugins-ogg
22    * gst-plugins-pyvorbis
23    * pyvorbis >= 1.4
24  * CD audio (optional):
25    * gst-plugins-cdio
26    * HAL >= 0.5.7
27    * eject >= 2.1.5 (optional)
28    * cddb-py >= 1.4
29  * DBus for remote control and CD detection (optional):
30    * DBus >= 1.0.0
31    * dbus-glib >= 0.72
32    * dbus-python >= 0.71
33  * Gnome (optional):
34    * gnome-python
35
36 Note that the version numbers are supported but earlier version MAY work.
37 The {{{configure}}} script allows for disabling DBus and CD support entirely;
38 see {{{configure --help}}} for details.
39
40 == Building and Installation ==
41 After downloading, building and installation is summarized as follows:
42 {{{
43 $ tar xzf mesk-@PACKAGE_VERSION@.tgz
44 $ cd mesk-@PACKAGE_VERSION@
45 $ ./configure
46 $ make
47 $ sudo make install
48 }}}
49
50 The default installation prefix is {{{/usr/local}}}
51 but can be overridden with the --prefix=/path {{{configure}}} option.
52 Depending on the permissions of your install prefix, you may be required to
53 run {{{make install}}} as root, demonstrated above using {{{sudo}}}.
54
55 == Running ==
56 To run Mesk use the command {{{mesk}}}.
57 {{{
58 $ mesk
59 $ /usr/local/bin/mesk
60 $ <prefix>/bin/mesk
61 }}}
62
63 == Command Line Options ==
64 {{{
65 usage: mesk [OPTIONS] [URI ...]
66
67 options:
68   --version             show program's version number and exit
69   -h, --help            show this help message and exit
70   -p NAME, --profile=NAME
71                         Start with profile NAME.
72
73   Remote Control Options:
74     The remote control options operate on a running instance of Mesk,
75     starting the app if necessary. If multiples instances of Mesk are
76     running the profile option can be used to determine which instance to
77     pass the command.
78
79     --stop              Stop playback
80     --play              Start playback
81     --pause             Pause playback
82     --play-pause        If playing, playback is paused. Otherwise the player
83                         is started.
84     --prev              Previous track
85     --next              Next track
86     --toggle-mute       Mute/Unmute
87     --vol-up=N          Increase the volume by N% (0.0 <= n <= 1.0)
88     --vol-down=N        Decrease the volume by N%(0.0 <= n <= 1.0)
89     --get-state         Returns the current state of the audio player
90                         (stopped, playing, paused).
91     --get-current-uri   Returns the URI of the current audio source.
92     --get-current-title
93                         Returns the title of the current audio source.
94     --get-current-artist
95                         Returns the artist of the current audio source.
96     --get-current-album
97                         Returns the album name of the current audio source.
98     --get-current-year  Returns the year of the current audio source.
99     --get-current-length
100                         Returns the length (in seconds) of the current audio
101                         source.
102     --list-playlists    List all playlists.
103     --get-active-playlist
104                         List the name of the active PlaylistControl.  This
105                         value may be empty if no playlists are active (e.g. a
106                         CDROM is active).
107     --set-active-playlist=NAME
108                         Set the active playlist.
109     --enqueue=URI       Enqueue URI to the active playlist.
110     --toggle-visible    Show/hide the main window (minimize to system tray)
111     --raise-window      Raise the main window (bring to front).
112
113   Advanced Options:
114     -l LEVEL, --log-level=LEVEL
115                         Select the amount of terminal logging. May be
116                         CRITICAL, ERROR, WARNING, INFO, VERBOSE, or DEBUG
117     --debug             Break in python debugger on unhandled exceptions.
118     --run-profiler      Run using python profiler.
119     --gst-help          Display Gstreamer command line options.
120 }}}
121
122 == Developer Info ==
123
124 The {{{make install}}} step can be skipped if desired, and Mesk can be run by
125 running the script {{{launch.sh}}} in the top-level directory.  Note, using
126 this method runs using the profile name {{{testing}}} instead of the default
127 profile.  See the command line arguments -p/--profile for more details.
Note: See TracBrowser for help on using the browser.