Changeset 4012:28bea7336add in roaraudio for doc

Timestamp:

07/01/10 19:03:41 (14 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

typos

Location:

doc

Files:

• man1/roarbaseclients.1 (modified) (1 diff)
• man1/roarctl.1 (modified) (2 diffs)
• man1/roard.1 (modified) (1 diff)
• man1/roarify.1 (modified) (1 diff)
• man1/roartestclients.1 (modified) (2 diffs)
• man3/roar_simple_connect.3 (modified) (1 diff)
• man3/roar_simple_new_stream.3 (modified) (2 diffs)
• man7/libroar.7 (modified) (1 diff)
• man7/roartips.7 (modified) (1 diff)
• man7/roartut.7 (modified) (1 diff)

doc/man1/roarbaseclients.1

@@ -24 +24 @@
 .TP
 \fBroarmon\fR
-Gets a copy of the audio data the server sends to the soundcard. This is usefull for streaming
+Gets a copy of the audio data the server sends to the soundcard. This is useful for streaming
 to a server like \fBicecast2\fR(1).
 

doc/man1/roarctl.1

@@ -86 +86 @@
 \fBflag ID FLAGS\fR, \fBunflag ID FLAGS\fR
 Sets or removes flags from a stream. ID is the stream id.
-FLAGS is a comma seperated list of flags.
+FLAGS is a comma separated list of flags.
 
 It is not possible to set all kinds of flags at runtime.
@@ -105 +105 @@
 .TP
 \fBserveroinfo\fR
-Gets Informations about server output.
+Gets Information about server output.
 
 .TP
 \fBlistclients\fR
-Gets Informations about clients.
+Gets Information about clients.
 
 .TP
 \fBliststreams\fR
-Gets Informations about streams.
+Gets Information about streams.
 
 .TP

doc/man1/roard.1

@@ -155 +155 @@
 .TP
 \fB--no-listen\fR
-Do not listen for new clients (only usefull for relaing, impleys --terminate).
+Do not listen for new clients (only useful for relaing, impleys --terminate).
 
 .TP

doc/man1/roarify.1

@@ -12 +12 @@
 
 .SH "DESCRIPTION"
-This command sets up a enviroment that enables all RoarAudio compatibility librarys.
-Audio data from applications should automaticly be redirected to roard. 
+This command sets up a environment that enables all RoarAudio compatibility librarys.
+Audio data from applications should automatically be redirected to roard. 
 
 .SH "SEE ALSO"

doc/man1/roartestclients.1

@@ -18 +18 @@
 
 .SH "DESCRIPTION"
-This clients are primary for test perpose but may be usefull for someone
+This clients are primary for test perpose but may be useful for someone
 or can be used as examples.
 
@@ -34 +34 @@
 \fBroarsin\fR
 This is the complete version of the sinus generator from \fBroartut\fR(7).
-It plays a 5 secund middle C (523.2Hz) sine.
+It plays a 5 second middle C (523.2Hz) sine.
 
 .TP

doc/man3/roar_simple_connect.3

@@ -13 +13 @@
 
 .SH "DESCRIPTION"
-This call opens a connection to the RoarAudio's sound server. This is usefull for controlling the server or
+This call opens a connection to the RoarAudio's sound server. This is useful for controlling the server or
 update meta data of any kind. For simple playback see \fBroar_simple_play\fR(3).
 To disconnect use \fBroar_disconnect\fR(3).

doc/man3/roar_simple_new_stream.3

@@ -16 +16 @@
 
 .SH "DESCRIPTION"
-Opens a new stream to the sound server as a independet file handle (not an execed one). This is usefull if you still want
+Opens a new stream to the sound server as a independet file handle (not an execed one). This is useful if you still want
 some meta data or the volume to be updated after the stream is open.
 
@@ -27 +27 @@
 .TP
 \fBs\fR
-The stream object to be updated to corresponde to the new stream. This is usefull if use want to update some meta data
+The stream object to be updated to corresponde to the new stream. This is useful if use want to update some meta data
 after the stream has be opened as you can use all controll commands on this object.
 

doc/man7/libroar.7

@@ -61 +61 @@
 The default port is 22.
 Note that you may need to use publickey based auth or ssh-agent because the application
-may start SSH in a non interactive enviroment and SSH can not ask you for a password.
+may start SSH in a non interactive environment and SSH can not ask you for a password.
 
 

doc/man7/roartips.7

@@ -25 +25 @@
 
 The later one will show you all information current available of the server it self,
-the clients and the streams. This may include a lot of informations.
+the clients and the streams. This may include a lot of information.
 
 .SH "SERVER ADDRESS"
-There a serverel types of server addresses based on the protocoll used to communicate.
+There a serverel types of server addresses based on the protocol used to communicate.
 This lists the corrently implemented types in order of importance:
 

doc/man7/roartut.7

@@ -49 +49 @@
  }
 
-Now we want to loop for \fBlength\fR secunds:
+Now we want to loop for \fBlength\fR seconds:
  while (t < 2*M_PI*freq*length) {
  }