Changeset 4013:abd38c189de7 in roaraudio for doc/man7

Timestamp:

07/01/10 19:18:30 (14 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

some manpage fixes

Location:

doc/man7

Files:

• libroar.7 (modified) (1 diff)
• roardecnet.7 (modified) (2 diffs)
• roartips.7 (modified) (1 diff)
• roartut.7 (modified) (4 diffs)

doc/man7/libroar.7

@@ -70 +70 @@
 If all types of server addresses are supported.
 Example:
- ln -s /tmp/roar /etc/roarserver
- ln -s somehost /etc/roarserver
- ln -s mynode:: /etc/roarserver
+ ln \-s /tmp/roar /etc/roarserver
+ ln \-s somehost /etc/roarserver
+ ln \-s mynode:: /etc/roarserver
 
 .SH "BUGS"

doc/man7/roardecnet.7

@@ -7 +7 @@
 .SH SYNOPSIS
 
- roard -n [OPTIONS...] ...
+ roard \-n [OPTIONS...] ...
 
- roarclient --server node:: [OPTIONS...] ...
+ roarclient \-\-server node:: [OPTIONS...] ...
 
 .SH "DESCRIPTION"
@@ -20 +20 @@
 Nodenames given via '\fB-b\fR' are ignored.
 Example:
- roard -n
- roard -n -b ::myobject
+ roard \-n
+ roard \-n -b ::myobject
 
 If you use the default object local clients should find there way to the server.

doc/man7/roartips.7

@@ -21 +21 @@
 To do this there is a tool called \fBroarctl\fR(1). You may want to play around a bit
 with it. A good start are to try those two commands:
- roarctl --help
+ roarctl \-\-help
  roarctl allinfo
 

doc/man7/roartut.7

@@ -44 +44 @@
 
 To open the connection we use the call \fBroar_simple_play\fR(3):
- if ( (fh = roar_simple_play(rate, channels, bits, codec, NULL, "sine gen")) == -1 ) {
+ if ( (fh = roar_simple_play(rate, channels, bits, codec, NULL, "sine gen")) == \-1 ) {
   fprintf(stderr, "Error: can not open playback!\\n");
   exit(1);
@@ -59 +59 @@
   }
 
-The sine is multiplyed by 127 as our amplitude range for 8 bit signed int is from -128 to +127.
+The sine is multiplyed by 127 as our amplitude range for 8 bit signed int is from \-128 to +127.
 
 After we have our current data in \fBout\fR we want to write them to the server:
@@ -89 +89 @@
   char out[1024];
 
-  if ( (fh = roar_simple_play(rate, channels, bits, codec, NULL, "sine gen")) == -1 ) {
+  if ( (fh = roar_simple_play(rate, channels, bits, codec, NULL, "sine gen")) == \-1 ) {
    fprintf(stderr, "Error: can not open playback!\\n");
    exit(1);
@@ -108 +108 @@
 
 To compile and link we can use a command like this one:
- cc -o roarsin roarsin.c -lm `roar-config --libs --cflags`
+ cc \-o roarsin roarsin.c \-lm `roar\-config \-\-libs \-\-cflags`
 
 We need to use \fB-lm\fR to link the math library for \fBsin()\fR.