| 1 |
|
| 2 |
cmus - C* Music Player |
| 3 |
|
| 4 |
http://cmus.sourceforge.net/ |
| 5 |
|
| 6 |
Copyright 2004-2008 Timo Hirvonen <tihirvon@gmail.com> |
| 7 |
Copyright 2008-2011 Various Authors |
| 8 |
|
| 9 |
|
| 10 |
Configuration |
| 11 |
------------- |
| 12 |
|
| 13 |
List available optional features |
| 14 |
|
| 15 |
$ ./configure --help |
| 16 |
|
| 17 |
Auto-detect everything |
| 18 |
|
| 19 |
$ ./configure |
| 20 |
|
| 21 |
To disable some feature, arts for example, and install to $HOME run |
| 22 |
|
| 23 |
$ ./configure prefix=$HOME CONFIG_ARTS=n |
| 24 |
|
| 25 |
After running configure you can see from the generated config.mk file |
| 26 |
what features have been configured in (see the CONFIG_* options). |
| 27 |
|
| 28 |
NOTE: For some distributions you need to install development versions |
| 29 |
of the dependencies. For example if you want to use 'mad' input plugin |
| 30 |
(mp3) you need to install libmad0-dev (Debian) or libmad-devel (RPM) |
| 31 |
package. After installing dependencies you need to run ./configure |
| 32 |
again, of course. |
| 33 |
|
| 34 |
If you want to use the Tremor library as alternative for decoding |
| 35 |
Ogg/Vorbis files you have to pass CONFIG_TREMOR=y to the configure |
| 36 |
script: |
| 37 |
|
| 38 |
$ ./configure CONFIG_VORBIS=y CONFIG_TREMOR=y |
| 39 |
|
| 40 |
The Tremor library is supposed to be used on hardware that has no FPU. |
| 41 |
|
| 42 |
|
| 43 |
Building |
| 44 |
-------- |
| 45 |
|
| 46 |
$ make |
| 47 |
|
| 48 |
Or on some BSD systems you need to explicitly use GNU make: |
| 49 |
|
| 50 |
$ gmake |
| 51 |
|
| 52 |
|
| 53 |
Installation |
| 54 |
------------ |
| 55 |
|
| 56 |
$ make install |
| 57 |
|
| 58 |
Or to install to a temporary directory: |
| 59 |
|
| 60 |
$ make install DESTDIR=~/tmp/cmus |
| 61 |
|
| 62 |
This is useful when creating binary packages. |
| 63 |
|
| 64 |
Remember to replace 'make' with 'gmake' if needed. |
| 65 |
|
| 66 |
|
| 67 |
Manuals |
| 68 |
------- |
| 69 |
|
| 70 |
$ man cmus-tutorial |
| 71 |
|
| 72 |
And |
| 73 |
|
| 74 |
$ man cmus |
| 75 |
|
| 76 |
|
| 77 |
Mailing List |
| 78 |
------------ |
| 79 |
|
| 80 |
To subscribe to cmus-devel@lists.sourceforge.net visit |
| 81 |
|
| 82 |
http://lists.sourceforge.net/lists/listinfo/cmus-devel |
| 83 |
|
| 84 |
The list is open but moderated (you can post to the list without |
| 85 |
subscribing but it's not recommended because I have to accept each email |
| 86 |
form non-subscribed users). Traffic of the list is low. |
| 87 |
|
| 88 |
|
| 89 |
Reporting Bugs |
| 90 |
-------------- |
| 91 |
|
| 92 |
After a crash send bug report with last lines of ~/cmus-debug.txt to |
| 93 |
cmus-devel@lists.sourceforge.net. The file exists only if you |
| 94 |
configured cmus with maximum debug level (./configure DEBUG=2). |
| 95 |
|
| 96 |
|
| 97 |
Git Repository |
| 98 |
-------------- |
| 99 |
|
| 100 |
gitweb: http://gitorious.org/cmus |
| 101 |
clone: git://gitorious.org/cmus/cmus.git |
| 102 |
|
| 103 |
|
| 104 |
Hacking |
| 105 |
------- |
| 106 |
|
| 107 |
cmus uses the Linux kernel coding style. Use hard tabs. Tabs are |
| 108 |
_always_ 8 characters wide. Keep the style consistent with rest of the |
| 109 |
code. |
| 110 |
|
| 111 |
Use git format-patch to generate patches from your commits. |
| 112 |
Alternatively you can use "diff -up" if you don't want to use git. |
