[710] | 1 | RoarAudio |
---|
| 2 | As loud as a Lion |
---|
| 3 | --------------------- |
---|
| 4 | |
---|
| 5 | --- 0. INDEX |
---|
| 6 | 0. Index |
---|
| 7 | 1. Infos for maintainers |
---|
| 8 | 2. Infos for developer |
---|
| 9 | |
---|
| 10 | --- 1. Infos for maintainers: |
---|
| 11 | |
---|
[1677] | 12 | If you want to maintain a packet for your favorite OS please let me know! |
---|
[4402] | 13 | We would love to be in contact with the maintainers to send them infos about |
---|
[1677] | 14 | updates and maybe get feedback or things like init scripts or the like |
---|
[712] | 15 | (see 2. Infos for developer). |
---|
| 16 | |
---|
[4402] | 17 | If it would make your work simpler we can put things in trunk |
---|
[712] | 18 | (info files for pkg build tools or the like). Just ask. |
---|
| 19 | |
---|
[4402] | 20 | Also if you need any help you may contact us. |
---|
| 21 | |
---|
| 22 | You can conntact us at our mailinglist or on IRC. |
---|
| 23 | If you do not want to subscribe to the full traffic mailinglist |
---|
| 24 | but want to keep informed about new releases and such (very recommended) |
---|
| 25 | please join our announce list. |
---|
| 26 | |
---|
| 27 | Contact information can be found in our homepage at: |
---|
| 28 | http://roaraudio.keep-cool.org/contact.html |
---|
[712] | 29 | |
---|
| 30 | Here is my recommendation on how to split the RoarAudio in pkgs: |
---|
| 31 | |
---|
[2406] | 32 | libroar includes libroar, libroardsp, libroarmidi, |
---|
| 33 | libroarlight and libroareio |
---|
[712] | 34 | roaraudio-common include roard and roarclients |
---|
[1677] | 35 | (at least the ones with no special deps) |
---|
[712] | 36 | roaraudio-tools includes all other tools not in roaraudio-common |
---|
[1677] | 37 | because of special deps (if any) |
---|
[4402] | 38 | libroar-compat includes libroaresd, libroararts, libroarpulse |
---|
| 39 | and libroaryiff, ... and the compatinitly binarys. |
---|
| 40 | It would be nice to ask the user |
---|
[712] | 41 | if he wants symlinks from libesd, libarts*, libpulse*. |
---|
[4402] | 42 | roaraudio-dev includes include/, *.pc and such |
---|
[712] | 43 | someplayer-roar pkgs from plugins/ |
---|
[4402] | 44 | roaraudio-server virtual package provided by the package containing |
---|
| 45 | roard. Applications should recommend this package |
---|
| 46 | not the package with roard directly. |
---|
| 47 | This is to enable the use to use an alternative server. |
---|
[712] | 48 | |
---|
| 49 | manpages should be included in the corresponding packet. |
---|
| 50 | |
---|
[893] | 51 | If your system includes a libdnet (Linux DECnet support) please build |
---|
| 52 | it with DECnet support compiled in. There will be no strange warning messages |
---|
| 53 | anymore with DECnet enabled on a non-DECnet system. libdnet does not |
---|
| 54 | require any Kernel modules or has any non standard deps itself. |
---|
[4402] | 55 | But be aware that several systems ship a libdnet which is not DECnet support. |
---|
| 56 | In this case disable the build with libdnet. |
---|
[893] | 57 | |
---|
[4402] | 58 | If your system includes libslp (normaly one of the deps of cups) please |
---|
[2406] | 59 | consider to build with libslp support. |
---|
| 60 | |
---|
[895] | 61 | In addition you should configure with --runtime-detect: this will |
---|
[1677] | 62 | let roard/libroar detect the presents of some tools at runtime and |
---|
| 63 | will reduce deps. |
---|
[895] | 64 | |
---|
[2406] | 65 | Please ensure that configure finds the correct audio users group. |
---|
| 66 | In case it does not detect the correct one please set it via |
---|
| 67 | --audio-group. |
---|
| 68 | |
---|
[2552] | 69 | In case you want to provide emulation of other sound systems |
---|
| 70 | they need to be install on the build system (only). This is |
---|
| 71 | because we use parts of them (mainly header files) in order |
---|
| 72 | to build the compatibility librarys and abstraction layers |
---|
| 73 | to ensure best comaptibility. They will not be required |
---|
| 74 | after the build has been done and thereof does not need to be a |
---|
| 75 | dependency of the final packet you build. |
---|
| 76 | The only expection is in case you build driver support for |
---|
| 77 | one or more of them. If you do so you of cause need to ensure |
---|
| 78 | that all needed librarys are avalible on the target system. |
---|
| 79 | |
---|
[2406] | 80 | Running roard: |
---|
| 81 | Global (system wide) roards normaly are started as root. |
---|
| 82 | Ensure it drops it's privilegs by setting --setuid/--setgid |
---|
| 83 | and maybe -U and -G. |
---|
[4402] | 84 | Common usernames are: roard, roar, roaraudio, nobody. |
---|
| 85 | You can use the init script for debian (in dist/debian-like/) |
---|
| 86 | as example. |
---|
[2406] | 87 | |
---|
| 88 | It is allways nice to use --pidfile. If you use a pidfile |
---|
| 89 | you can start and stop roard by using --start and --stop easily. |
---|
| 90 | |
---|
| 91 | You can use --chroot to chroot into an empty directory to improve security. |
---|
| 92 | roard does the chrooting after loading everything so it is perfectly safe |
---|
| 93 | to chroot into an empty directory. In case your system includes a /var/empty |
---|
| 94 | or simular directory please do the chroot. |
---|
| 95 | |
---|
[4402] | 96 | To ensure no drops consider to add one or two --realtime. |
---|
[2406] | 97 | |
---|
[4402] | 98 | In case of a public (for LAN) server have some way for the user |
---|
| 99 | to set --location and use --slp for Zero Conf. |
---|
[2406] | 100 | |
---|
| 101 | For more information see roard --help. |
---|
| 102 | |
---|
[710] | 103 | --- 2. Infos for developer |
---|
| 104 | |
---|
[711] | 105 | At the moment all the libs are under GPLv3. |
---|
| 106 | As libesd, libarts*, libpulse* and maybe other are under |
---|
| 107 | LGPL the corresponding roar replacements should be under LGPL as well. |
---|
| 108 | Because they link libroar independent of what licenses they are under |
---|
| 109 | they are downgraded to GPL. This may change in future. |
---|
| 110 | |
---|
[4402] | 111 | Because of that we *require* that *everything* that is contributed by |
---|
| 112 | someone we get under LGPL so we can upgrade code to LGPL if needed |
---|
| 113 | in future without asking. Code we get under a different license |
---|
| 114 | will *NOT* get into trunk nor will be hosted by us. |
---|
[711] | 115 | |
---|
[4402] | 116 | Also add full contact infos when sending code to us, this includes: |
---|
[711] | 117 | 1) Full name |
---|
| 118 | 2) nickname |
---|
| 119 | 3) E-Mail |
---|
| 120 | 4) OpenPGP key |
---|
| 121 | |
---|
[893] | 122 | When sending code please sign it with OpenPGP. |
---|
[711] | 123 | |
---|
[710] | 124 | #ll |
---|