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