Changeset 4013:abd38c189de7 in roaraudio
- Timestamp:
- 07/01/10 19:18:30 (14 years ago)
- Branch:
- default
- Phase:
- public
- Location:
- doc
- Files:
-
- 31 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/man1/roar-config.1
r3094 r4013 9 9 .SH SYNOPSIS 10 10 11 roar-config [ --version] [--libs] [--cflags] [lib]11 roar-config [\-\-version] [\-\-libs] [\-\-cflags] [lib] 12 12 13 13 .SH DESCRIPTION … … 24 24 .TP 25 25 \fB--libs\fR 26 Show linker flags ( -lxxx) needed to link library26 Show linker flags (\-lxxx) needed to link library 27 27 28 28 .TP -
doc/man1/roard.1
r4012 r4013 155 155 .TP 156 156 \fB--no-listen\fR 157 Do not listen for new clients (only useful for relaing, impleys --terminate).157 Do not listen for new clients (only useful for relaing, impleys \-\-terminate). 158 158 159 159 .TP -
doc/man1/roarinterconnect.1
r3673 r4013 50 50 51 51 .TP 52 \fB--verbose -v\fR52 \fB--verbose \-v\fR 53 53 Be verbose 54 54 -
doc/man1/roarmonhttp.1
r3103 r4013 9 9 .SH SYNOPSIS 10 10 11 roarmonhttp [ --inetd]11 roarmonhttp [\-\-inetd] 12 12 13 13 .SH DESCRIPTION … … 28 28 .SH "EXAMPLES" 29 29 Here is an example of a roarmonhttp listening on port 8000 using inetd: 30 8000 stream tcp nowait roard /usr/bin/roarmonhttp roarmonhttp --inetd30 8000 stream tcp nowait roard /usr/bin/roarmonhttp roarmonhttp \-\-inetd 31 31 32 32 .SH "SEE ALSO" -
doc/man1/roarshout.1
r3102 r4013 40 40 41 41 .TP 42 \fB-h --help\fR42 \fB-h \-\-help\fR 43 43 Show this help 44 44 … … 46 46 47 47 .TP 48 \fB-p --public\fR48 \fB-p \-\-public\fR 49 49 Allow listing in stream directory 50 50 -
doc/man1/roarvumeter.1
r3092 r4013 52 52 .TP 53 53 \fB--lowpass FREQ\fR 54 Use lowpass to filter input ( -120dB/dec)54 Use lowpass to filter input (\-20dB/dec) 55 55 56 56 .TP -
doc/man3/roar_connect.3
r732 r4013 31 31 32 32 .SH "RETURN VALUE" 33 On success these calls return 0. On error, -1 is returned.33 On success these calls return 0. On error, \-1 is returned. 34 34 35 35 .SH "EXAMPLES" -
doc/man3/roar_disconnect.3
r159 r4013 22 22 23 23 .SH "RETURN VALUE" 24 On success these calls return 0. On error, -1 is returned.24 On success these calls return 0. On error, \-1 is returned. 25 25 26 26 .SH "EXAMPLES" -
doc/man3/roar_exit.3
r1113 r4013 37 37 38 38 .SH "RETURN VALUE" 39 On success these calls return 0. On error, -1 is returned.39 On success these calls return 0. On error, \-1 is returned. 40 40 41 41 .SH "NOTES" -
doc/man3/roar_get_standby.3
r159 r4013 28 28 .SH "RETURN VALUE" 29 29 \fBroar_get_standby\fR returns \fBROAR_STANDBY_ACTIVE\fR, \fBROAR_STANDBY_INACTIVE\fR or -1 on error. 30 \fBroar_set_standby\fR returns on success 0. On error, -1 is returned.30 \fBroar_set_standby\fR returns on success 0. On error, \-1 is returned. 31 31 32 32 .SH "EXAMPLES" -
doc/man3/roar_get_vol.3
r159 r4013 39 39 40 40 .SH "RETURN VALUE" 41 On success these calls return 0. On error, -1 is returned.41 On success these calls return 0. On error, \-1 is returned. 42 42 43 43 .SH "EXAMPLES" -
doc/man3/roar_server_oinfo.3
r159 r4013 26 26 27 27 .SH "RETURN VALUE" 28 On success these calls return 0. On error, -1 is returned.28 On success these calls return 0. On error, \-1 is returned. 29 29 30 30 .SH "EXAMPLES" -
doc/man3/roar_simple_close.3
r159 r4013 21 21 22 22 .SH "RETURN VALUE" 23 On success these calls return 0. On error, -1 is returned.23 On success these calls return 0. On error, \-1 is returned. 24 24 25 25 .SH "EXAMPLES" -
doc/man3/roar_simple_connect.3
r4012 r4013 32 32 33 33 .SH "RETURN VALUE" 34 On success these calls return 0. On error, -1 is returned.34 On success these calls return 0. On error, \-1 is returned. 35 35 36 36 .SH "EXAMPLES" -
doc/man3/roar_simple_get_standby.3
r159 r4013 21 21 22 22 .SH "RETURN VALUE" 23 On success this call return \fBROAR_STANDBY_ACTIVE\fR or \fBROAR_STANDBY_INACTIVE\fR. On error, -1 is returned.23 On success this call return \fBROAR_STANDBY_ACTIVE\fR or \fBROAR_STANDBY_INACTIVE\fR. On error, \-1 is returned. 24 24 25 25 .SH "EXAMPLES" -
doc/man3/roar_simple_new_stream.3
r4012 r4013 39 39 40 40 .SH "RETURN VALUE" 41 On success these calls return a new filehandle. On error, -1 is returned.41 On success these calls return a new filehandle. On error, \-1 is returned. 42 42 43 43 .SH "EXAMPLES" -
doc/man3/roar_simple_play.3
r156 r4013 59 59 60 60 .SH "RETURN VALUE" 61 On success these calls return a filehandle for the stream. On error, -1 is returned.61 On success these calls return a filehandle for the stream. On error, \-1 is returned. 62 62 63 63 .SH "EXAMPLES" -
doc/man3/roar_simple_stream.3
r159 r4013 50 50 51 51 .SH "RETURN VALUE" 52 On success these calls return a filehandle. On error, -1 is returned.52 On success these calls return a filehandle. On error, \-1 is returned. 53 53 54 54 .SH "EXAMPLES" -
doc/man3/roar_socket_listen.3
r732 r4013 68 68 69 69 .SH "RETURN VALUE" 70 On success these calls return filehandle. On error, -1 is returned.70 On success these calls return filehandle. On error, \-1 is returned. 71 71 72 72 .SH "BUGS" -
doc/man3/roar_socket_nonblock.3
r159 r4013 26 26 27 27 .SH "RETURN VALUE" 28 On success these calls return 0. On error, -1 is returned.28 On success these calls return 0. On error, \-1 is returned. 29 29 30 30 .SH "EXAMPLES" -
doc/man3/roar_str2codec.3
r785 r4013 27 27 28 28 .SH "RETURN VALUE" 29 On success \fBroar_str2codec\fR returns a codec ID. On error, -1 is returned.29 On success \fBroar_str2codec\fR returns a codec ID. On error, \-1 is returned. 30 30 \fBroar_codec2str\fR returns the name of the codec or NULL on error. 31 31 You must not free this pointer or write to it. -
doc/man3/roar_stream_add_data.3
r159 r4013 38 38 39 39 .SH "RETURN VALUE" 40 On success these calls return 0. On error, -1 is returned.40 On success these calls return 0. On error, \-1 is returned. 41 41 42 42 .SH "EXAMPLES" -
doc/man3/roar_stream_connect.3
r159 r4013 31 31 32 32 .SH "RETURN VALUE" 33 On success these calls return 0. On error, -1 is returned.33 On success these calls return 0. On error, \-1 is returned. 34 34 35 35 .SH "EXAMPLES" -
doc/man3/roar_stream_connect_to.3
r159 r4013 40 40 41 41 .SH "RETURN VALUE" 42 On success these calls return 0. On error, -1 is returned.42 On success these calls return 0. On error, \-1 is returned. 43 43 44 44 .SH "EXAMPLES" -
doc/man3/roar_stream_exec.3
r159 r4013 30 30 31 31 .SH "RETURN VALUE" 32 On success these calls return 0. On error, -1 is returned.32 On success these calls return 0. On error, \-1 is returned. 33 33 34 34 .SH "EXAMPLES" -
doc/man3/roar_stream_new.3
r159 r4013 21 21 22 22 .SH "RETURN VALUE" 23 On success these calls return 0. On error, -1 is returned.23 On success these calls return 0. On error, \-1 is returned. 24 24 25 25 .SH "EXAMPLES" -
doc/man3/roar_vio_close.3
r1346 r4013 23 23 24 24 .SH "RETURN VALUE" 25 On success these calls return 0. On error, -1 is returned.25 On success these calls return 0. On error, \-1 is returned. 26 26 27 27 .SH "EXAMPLES" -
doc/man7/libroar.7
r4012 r4013 70 70 If all types of server addresses are supported. 71 71 Example: 72 ln -s /tmp/roar /etc/roarserver73 ln -s somehost /etc/roarserver74 ln -s mynode:: /etc/roarserver72 ln \-s /tmp/roar /etc/roarserver 73 ln \-s somehost /etc/roarserver 74 ln \-s mynode:: /etc/roarserver 75 75 76 76 .SH "BUGS" -
doc/man7/roardecnet.7
r3107 r4013 7 7 .SH SYNOPSIS 8 8 9 roard -n [OPTIONS...] ...9 roard \-n [OPTIONS...] ... 10 10 11 roarclient --server node:: [OPTIONS...] ...11 roarclient \-\-server node:: [OPTIONS...] ... 12 12 13 13 .SH "DESCRIPTION" … … 20 20 Nodenames given via '\fB-b\fR' are ignored. 21 21 Example: 22 roard -n23 roard -n -b ::myobject22 roard \-n 23 roard \-n -b ::myobject 24 24 25 25 If you use the default object local clients should find there way to the server. -
doc/man7/roartips.7
r4012 r4013 21 21 To do this there is a tool called \fBroarctl\fR(1). You may want to play around a bit 22 22 with it. A good start are to try those two commands: 23 roarctl --help23 roarctl \-\-help 24 24 roarctl allinfo 25 25 -
doc/man7/roartut.7
r4012 r4013 44 44 45 45 To open the connection we use the call \fBroar_simple_play\fR(3): 46 if ( (fh = roar_simple_play(rate, channels, bits, codec, NULL, "sine gen")) == -1 ) {46 if ( (fh = roar_simple_play(rate, channels, bits, codec, NULL, "sine gen")) == \-1 ) { 47 47 fprintf(stderr, "Error: can not open playback!\\n"); 48 48 exit(1); … … 59 59 } 60 60 61 The sine is multiplyed by 127 as our amplitude range for 8 bit signed int is from -128 to +127.61 The sine is multiplyed by 127 as our amplitude range for 8 bit signed int is from \-128 to +127. 62 62 63 63 After we have our current data in \fBout\fR we want to write them to the server: … … 89 89 char out[1024]; 90 90 91 if ( (fh = roar_simple_play(rate, channels, bits, codec, NULL, "sine gen")) == -1 ) {91 if ( (fh = roar_simple_play(rate, channels, bits, codec, NULL, "sine gen")) == \-1 ) { 92 92 fprintf(stderr, "Error: can not open playback!\\n"); 93 93 exit(1); … … 108 108 109 109 To compile and link we can use a command like this one: 110 cc -o roarsin roarsin.c -lm `roar-config --libs --cflags`110 cc \-o roarsin roarsin.c \-lm `roar\-config \-\-libs \-\-cflags` 111 111 112 112 We need to use \fB-lm\fR to link the math library for \fBsin()\fR.
Note: See TracChangeset
for help on using the changeset viewer.