Changeset 4013:abd38c189de7 in roaraudio


Ignore:
Timestamp:
07/01/10 19:18:30 (14 years ago)
Author:
phi
Branch:
default
Phase:
public
Message:

some manpage fixes

Location:
doc
Files:
31 edited

Legend:

Unmodified
Added
Removed
  • doc/man1/roar-config.1

    r3094 r4013  
    99.SH SYNOPSIS 
    1010 
    11 roar-config [--version] [--libs] [--cflags] [lib] 
     11roar-config [\-\-version] [\-\-libs] [\-\-cflags] [lib] 
    1212 
    1313.SH DESCRIPTION 
     
    2424.TP 
    2525\fB--libs\fR 
    26 Show linker flags (-lxxx) needed to link library 
     26Show linker flags (\-lxxx) needed to link library 
    2727 
    2828.TP 
  • doc/man1/roard.1

    r4012 r4013  
    155155.TP 
    156156\fB--no-listen\fR 
    157 Do not listen for new clients (only useful for relaing, impleys --terminate). 
     157Do not listen for new clients (only useful for relaing, impleys \-\-terminate). 
    158158 
    159159.TP 
  • doc/man1/roarinterconnect.1

    r3673 r4013  
    5050 
    5151.TP 
    52 \fB--verbose -v\fR 
     52\fB--verbose \-v\fR 
    5353Be verbose 
    5454 
  • doc/man1/roarmonhttp.1

    r3103 r4013  
    99.SH SYNOPSIS 
    1010 
    11 roarmonhttp [--inetd] 
     11roarmonhttp [\-\-inetd] 
    1212 
    1313.SH DESCRIPTION 
     
    2828.SH "EXAMPLES" 
    2929Here is an example of a roarmonhttp listening on port 8000 using inetd: 
    30  8000 stream tcp nowait roard /usr/bin/roarmonhttp roarmonhttp --inetd 
     30 8000 stream tcp nowait roard /usr/bin/roarmonhttp roarmonhttp \-\-inetd 
    3131 
    3232.SH "SEE ALSO" 
  • doc/man1/roarshout.1

    r3102 r4013  
    4040 
    4141.TP 
    42 \fB-h --help\fR 
     42\fB-h \-\-help\fR 
    4343Show this help 
    4444 
     
    4646 
    4747.TP 
    48 \fB-p --public\fR 
     48\fB-p \-\-public\fR 
    4949Allow listing in stream directory 
    5050 
  • doc/man1/roarvumeter.1

    r3092 r4013  
    5252.TP 
    5353\fB--lowpass FREQ\fR 
    54 Use lowpass to filter input (-120dB/dec) 
     54Use lowpass to filter input (\-20dB/dec) 
    5555 
    5656.TP 
  • doc/man3/roar_connect.3

    r732 r4013  
    3131 
    3232.SH "RETURN VALUE" 
    33 On success these calls return 0.  On error, -1 is returned. 
     33On success these calls return 0.  On error, \-1 is returned. 
    3434 
    3535.SH "EXAMPLES" 
  • doc/man3/roar_disconnect.3

    r159 r4013  
    2222 
    2323.SH "RETURN VALUE" 
    24 On success these calls return 0.  On error, -1 is returned. 
     24On success these calls return 0.  On error, \-1 is returned. 
    2525 
    2626.SH "EXAMPLES" 
  • doc/man3/roar_exit.3

    r1113 r4013  
    3737 
    3838.SH "RETURN VALUE" 
    39 On success these calls return 0.  On error, -1 is returned. 
     39On success these calls return 0.  On error, \-1 is returned. 
    4040 
    4141.SH "NOTES" 
  • doc/man3/roar_get_standby.3

    r159 r4013  
    2828.SH "RETURN VALUE" 
    2929\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. 
    3131 
    3232.SH "EXAMPLES" 
  • doc/man3/roar_get_vol.3

    r159 r4013  
    3939 
    4040.SH "RETURN VALUE" 
    41 On success these calls return 0.  On error, -1 is returned. 
     41On success these calls return 0.  On error, \-1 is returned. 
    4242 
    4343.SH "EXAMPLES" 
  • doc/man3/roar_server_oinfo.3

    r159 r4013  
    2626 
    2727.SH "RETURN VALUE" 
    28 On success these calls return 0.  On error, -1 is returned. 
     28On success these calls return 0.  On error, \-1 is returned. 
    2929 
    3030.SH "EXAMPLES" 
  • doc/man3/roar_simple_close.3

    r159 r4013  
    2121 
    2222.SH "RETURN VALUE" 
    23 On success these calls return 0.  On error, -1 is returned. 
     23On success these calls return 0.  On error, \-1 is returned. 
    2424 
    2525.SH "EXAMPLES" 
  • doc/man3/roar_simple_connect.3

    r4012 r4013  
    3232 
    3333.SH "RETURN VALUE" 
    34 On success these calls return 0.  On error, -1 is returned. 
     34On success these calls return 0.  On error, \-1 is returned. 
    3535 
    3636.SH "EXAMPLES" 
  • doc/man3/roar_simple_get_standby.3

    r159 r4013  
    2121 
    2222.SH "RETURN VALUE" 
    23 On success this call return \fBROAR_STANDBY_ACTIVE\fR or \fBROAR_STANDBY_INACTIVE\fR.  On error, -1 is returned. 
     23On success this call return \fBROAR_STANDBY_ACTIVE\fR or \fBROAR_STANDBY_INACTIVE\fR.  On error, \-1 is returned. 
    2424 
    2525.SH "EXAMPLES" 
  • doc/man3/roar_simple_new_stream.3

    r4012 r4013  
    3939 
    4040.SH "RETURN VALUE" 
    41 On success these calls return a new filehandle.  On error, -1 is returned. 
     41On success these calls return a new filehandle.  On error, \-1 is returned. 
    4242 
    4343.SH "EXAMPLES" 
  • doc/man3/roar_simple_play.3

    r156 r4013  
    5959 
    6060.SH "RETURN VALUE" 
    61 On success these calls return a filehandle for the stream.  On error, -1 is returned. 
     61On success these calls return a filehandle for the stream.  On error, \-1 is returned. 
    6262 
    6363.SH "EXAMPLES" 
  • doc/man3/roar_simple_stream.3

    r159 r4013  
    5050 
    5151.SH "RETURN VALUE" 
    52 On success these calls return a filehandle.  On error, -1 is returned. 
     52On success these calls return a filehandle.  On error, \-1 is returned. 
    5353 
    5454.SH "EXAMPLES" 
  • doc/man3/roar_socket_listen.3

    r732 r4013  
    6868 
    6969.SH "RETURN VALUE" 
    70 On success these calls return filehandle.  On error, -1 is returned. 
     70On success these calls return filehandle.  On error, \-1 is returned. 
    7171 
    7272.SH "BUGS" 
  • doc/man3/roar_socket_nonblock.3

    r159 r4013  
    2626 
    2727.SH "RETURN VALUE" 
    28 On success these calls return 0.  On error, -1 is returned. 
     28On success these calls return 0.  On error, \-1 is returned. 
    2929 
    3030.SH "EXAMPLES" 
  • doc/man3/roar_str2codec.3

    r785 r4013  
    2727 
    2828.SH "RETURN VALUE" 
    29 On success \fBroar_str2codec\fR returns a codec ID.  On error, -1 is returned. 
     29On success \fBroar_str2codec\fR returns a codec ID.  On error, \-1 is returned. 
    3030\fBroar_codec2str\fR returns the name of the codec or NULL on error. 
    3131You must not free this pointer or write to it. 
  • doc/man3/roar_stream_add_data.3

    r159 r4013  
    3838 
    3939.SH "RETURN VALUE" 
    40 On success these calls return 0.  On error, -1 is returned. 
     40On success these calls return 0.  On error, \-1 is returned. 
    4141 
    4242.SH "EXAMPLES" 
  • doc/man3/roar_stream_connect.3

    r159 r4013  
    3131 
    3232.SH "RETURN VALUE" 
    33 On success these calls return 0.  On error, -1 is returned. 
     33On success these calls return 0.  On error, \-1 is returned. 
    3434 
    3535.SH "EXAMPLES" 
  • doc/man3/roar_stream_connect_to.3

    r159 r4013  
    4040 
    4141.SH "RETURN VALUE" 
    42 On success these calls return 0.  On error, -1 is returned. 
     42On success these calls return 0.  On error, \-1 is returned. 
    4343 
    4444.SH "EXAMPLES" 
  • doc/man3/roar_stream_exec.3

    r159 r4013  
    3030 
    3131.SH "RETURN VALUE" 
    32 On success these calls return 0.  On error, -1 is returned. 
     32On success these calls return 0.  On error, \-1 is returned. 
    3333 
    3434.SH "EXAMPLES" 
  • doc/man3/roar_stream_new.3

    r159 r4013  
    2121 
    2222.SH "RETURN VALUE" 
    23 On success these calls return 0.  On error, -1 is returned. 
     23On success these calls return 0.  On error, \-1 is returned. 
    2424 
    2525.SH "EXAMPLES" 
  • doc/man3/roar_vio_close.3

    r1346 r4013  
    2323 
    2424.SH "RETURN VALUE" 
    25 On success these calls return 0.  On error, -1 is returned. 
     25On success these calls return 0.  On error, \-1 is returned. 
    2626 
    2727.SH "EXAMPLES" 
  • doc/man7/libroar.7

    r4012 r4013  
    7070If all types of server addresses are supported. 
    7171Example: 
    72  ln -s /tmp/roar /etc/roarserver 
    73  ln -s somehost /etc/roarserver 
    74  ln -s mynode:: /etc/roarserver 
     72 ln \-s /tmp/roar /etc/roarserver 
     73 ln \-s somehost /etc/roarserver 
     74 ln \-s mynode:: /etc/roarserver 
    7575 
    7676.SH "BUGS" 
  • doc/man7/roardecnet.7

    r3107 r4013  
    77.SH SYNOPSIS 
    88 
    9  roard -n [OPTIONS...] ... 
     9 roard \-n [OPTIONS...] ... 
    1010 
    11  roarclient --server node:: [OPTIONS...] ... 
     11 roarclient \-\-server node:: [OPTIONS...] ... 
    1212 
    1313.SH "DESCRIPTION" 
     
    2020Nodenames given via '\fB-b\fR' are ignored. 
    2121Example: 
    22  roard -n 
    23  roard -n -b ::myobject 
     22 roard \-n 
     23 roard \-n -b ::myobject 
    2424 
    2525If you use the default object local clients should find there way to the server. 
  • doc/man7/roartips.7

    r4012 r4013  
    2121To do this there is a tool called \fBroarctl\fR(1). You may want to play around a bit 
    2222with it. A good start are to try those two commands: 
    23  roarctl --help 
     23 roarctl \-\-help 
    2424 roarctl allinfo 
    2525 
  • doc/man7/roartut.7

    r4012 r4013  
    4444 
    4545To 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 ) { 
    4747  fprintf(stderr, "Error: can not open playback!\\n"); 
    4848  exit(1); 
     
    5959  } 
    6060 
    61 The sine is multiplyed by 127 as our amplitude range for 8 bit signed int is from -128 to +127. 
     61The sine is multiplyed by 127 as our amplitude range for 8 bit signed int is from \-128 to +127. 
    6262 
    6363After we have our current data in \fBout\fR we want to write them to the server: 
     
    8989  char out[1024]; 
    9090 
    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 ) { 
    9292   fprintf(stderr, "Error: can not open playback!\\n"); 
    9393   exit(1); 
     
    108108 
    109109To 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` 
    111111 
    112112We need to use \fB-lm\fR to link the math library for \fBsin()\fR. 
Note: See TracChangeset for help on using the changeset viewer.