Changeset 5032:b2c8bbc7907f in roaraudio


Ignore:
Timestamp:
05/28/11 17:23:34 (11 years ago)
Author:
phi
Branch:
default
Phase:
public
Message:

some manpage correction

Location:
doc/man3
Files:
21 edited

Legend:

Unmodified
Added
Removed
  • doc/man3/roar_connect.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_connect" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
    6 roar_connect \- connects to RoarAudio's sound server 
     6roar_connect, roar_connect2 \- connects to RoarAudio's sound server 
    77 
    88.SH SYNOPSIS 
     
    1111 
    1212int roar_connect(struct roar_connection * con, char * server); 
     13int roar_connect2     (struct roar_connection * con, char * server, int flags, uint_least32_t timeout); 
    1314 
    1415.SH "DESCRIPTION" 
    1516Connects to RoarAudio's sound server. 
    16 This call just connects to the sound server without any auth or identify. 
    17 Do not use this from end user applications. Use \fBroar_simple_connect\fR(3). 
     17This calls just connects to the sound server without any authentication or identify. 
     18Do not use this from end user applications. Use \fBroar_simple_connect\fR(3) or \fBroar_simple_connect2\fR(3). 
    1819 
    1920 
     
    2627\fBserver\fR 
    2728The server to connect to. 
    28 This may be in form "host[:port]" (TCP/IP), "/path/to/sock" (UNIX Domain Socket) or any other supported. 
    29 For a full list see \fBroartips\fR(7). 
    3029 
     30.TP 
     31\fBflags\fR 
     32Flags used to connect to the server. Currently only ROAR_ENUM_FLAG_NONE and ROAR_ENUM_FLAG_NONBLOCK are supported. 
     33ROAR_ENUM_FLAG_NONBLOCK disables some of the server location features. 
     34 
     35.TP 
     36\fBtimeout\fR 
     37Timeout for the connection. A value of zero means no timeout. Currently timeouts are not supported. 
    3138 
    3239.SH "RETURN VALUE" 
  • doc/man3/roar_disconnect.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_disconnect" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_disconnect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
     
    1313 
    1414.SH "DESCRIPTION" 
    15 Closes es connection previously opend via \fBBroar_simple_connect\fR(3). 
     15Closes es connection previously opend via \fBBroar_simple_connect\fR(3) or \fBBroar_simple_connect2\fR(3). 
    1616 
    1717 
  • doc/man3/roar_exit.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_exit" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_exit" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
     
    1919Ask the sound server to quit. 
    2020 
    21 roar_exit() let the server quit .... 
     21roar_exit() let the server quit without waiting for any clients. 
     22All streams and client connections will be closed cleanly. 
    2223 
    2324roar_terminate() will let the server quit as soon as all clients disconnects 
  • doc/man3/roar_get_standby.3

    r4017 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_get_standby" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_get_standby" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
  • doc/man3/roar_get_vol.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_get_vol" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_get_vol" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
    6 roar_get_vol, roar_set_vol \- Set mixer levels or RoarAudio streams 
     6roar_get_vol, roar_set_vol, roar_set_vol2 \- Set mixer levels or RoarAudio streams 
    77 
    88.SH SYNOPSIS 
     
    1212int roar_set_vol(struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int   channels); 
    1313 
     14int roar_set_vol2     (struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int   channels, int mode); 
     15 
    1416int roar_get_vol(struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int * channels); 
    1517 
     
    1719This call gets or sets the mixing levels for a stream. 
    1820 
    19 \fBNOTE: This call is not marked as forzen, it's interface may change in newer versions!\fR 
     21roar_set_vol() is marked obsolete and will be removed soon, use roar_set_vol2(). 
    2022 
    2123.SH "PARAMETERS" 
     
    2830The ID of the stream to change. 
    2931 
    30 \fBNOTE:\fR the type of this argument may change in newer versions of the lib! 
    31  
    3232.TP 
    3333\fBmixer\fR 
    34 FIXME 
     34The mixer state for the stream. 
    3535 
    3636.TP 
    3737\fBchannels\fR 
    38 FIXME 
     38The number of channels to set mixer data for or the number of channels mixer data is returned. 
     39 
     40.TP 
     41\fBmode\fR 
     42The mode of operating. Currently the following modes are supported: 
     43ROAR_SET_VOL_ALL, ROAR_SET_VOL_MS, ROAR_SET_VOL_UNMAPPED. 
    3944 
    4045.SH "RETURN VALUE" 
  • doc/man3/roar_server_oinfo.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_server_oinfo" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_server_oinfo2" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
    6 roar_server_oinfo \- Gets information on the output stream of RoarAudio's sound server 
     6roar_server_oinfo, roar_server_oinfo2 \- Gets information on the output stream of RoarAudio's sound server 
    77 
    88.SH SYNOPSIS 
     
    1111 
    1212int roar_server_oinfo(struct roar_connection * con, struct roar_stream * s); 
     13int roar_server_oinfo2(struct roar_connection * con, struct roar_stream * s, int dir); 
    1314 
    1415.SH "DESCRIPTION" 
    15 Gets information on the output stream of the sound server. The output stream is the stream it sends 
    16 to the soundcard. This can be used to get optimal parameters for all operations so the server don't need to resample. 
     16Gets information about the default mixer stream for the given stream direction. 
     17This can be used to get optimal parameters for all operations so the server don't need to resample. 
     18 
     19roar_server_oinfo() is marked as obsolete and will be removed soon. 
    1720 
    1821.SH "PARAMETERS" 
     
    2528A stream object to be filled with information on the output stream. 
    2629 
     30.TP 
     31\fBdir\fR 
     32The stream direction to query mixer data for. 
     33 
    2734.SH "RETURN VALUE" 
    2835On success these calls return 0.  On error, \-1 is returned. 
     
    3239 
    3340.SH "SEE ALSO" 
    34 \fBroar_simple_filter\fR(3), 
    35 \fBroar_simple_monitor\fR(3), 
    3641\fBlibroar\fR(7), 
    3742\fBRoarAudio\fR(7). 
  • doc/man3/roar_simple_close.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_simple_close" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_simple_close" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
     
    1414.SH "DESCRIPTION" 
    1515Closes a filehandle opened via \fBroar_simple_play\fR(3), \fBroar_simple_monitor\fR(3), \fBroar_simple_record\fR(3), \fBroar_simple_filter\fR(3) or \fBroar_simple_new_stream\fR(3). 
     16 
     17This function is marked obsolete and will be removed soon. Use \fBroar_vs_close\fR(3). 
    1618 
    1719.SH "PARAMETERS" 
     
    2830 
    2931.SH "SEE ALSO" 
     32\fBroar_vs_close\fR(3), 
    3033\fBroar_simple_play\fR(3), 
    3134\fBroar_simple_monitor\fR(3), 
  • doc/man3/roar_simple_connect.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_simple_connect" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_simple_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
    6 roar_simple_connect \- Opens a connection to RoarAudio's sound server 
     6roar_simple_connect, roar_simple_connect2 \- Opens a connection to RoarAudio's sound server 
    77 
    88.SH SYNOPSIS 
     
    1111 
    1212int roar_simple_connect (struct roar_connection * con, char * server, char * name); 
     13int roar_simple_connect2(struct roar_connection * con, char * server, char * name, int flags, uint_least32_t timeout); 
     14 
    1315 
    1416.SH "DESCRIPTION" 
    15 This call opens a connection to the RoarAudio's sound server. This is useful for controlling the server or 
    16 update meta data of any kind. For simple playback see \fBroar_simple_play\fR(3). 
     17This calls opens a connection to the RoarAudio's sound server. 
    1718To disconnect use \fBroar_disconnect\fR(3). 
    1819 
     
    3132The name of this client. Should be the name of the player without any paths or filenames. 
    3233 
     34.TP 
     35\fBflags\fR 
     36Flags used to connect to the server. Currently only ROAR_ENUM_FLAG_NONE and ROAR_ENUM_FLAG_NONBLOCK are supported. 
     37ROAR_ENUM_FLAG_NONBLOCK disables some of the server location features. 
     38 
     39.TP 
     40\fBtimeout\fR 
     41Timeout for the connection. A value of zero means no timeout. Currently timeouts are not supported. 
     42 
    3343.SH "RETURN VALUE" 
    3444On success these calls return 0.  On error, \-1 is returned. 
     
    3949.SH "SEE ALSO" 
    4050\fBroar_disconnect\fR(3), 
    41 \fBroar_simple_play\fR(3), 
    4251\fBlibroar\fR(7), 
    4352\fBRoarAudio\fR(7). 
  • doc/man3/roar_simple_get_standby.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_simple_get_standby" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_simple_get_standby" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
     
    1515Asks the server for it's standby state. 
    1616 
     17This function is marked obsolete and will be removed soon. Use \fRroar_get_standby\fR(3). 
     18 
    1719.SH "PARAMETERS" 
    1820.TP 
     
    2729 
    2830.SH "SEE ALSO" 
     31\fRroar_get_standby\fR(3), 
    2932\fBlibroar\fR(7), 
    3033\fBRoarAudio\fR(7). 
  • doc/man3/roar_simple_new_stream.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_simple_new_stream" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_simple_new_stream" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
     
    1919some meta data or the volume to be updated after the stream is open. 
    2020 
     21This functions are marked obsolete and will be removed in later releases. 
     22Please upgrade to VS API. See \fBroar_vs_new_simple\fR(3). 
    2123 
    2224.SH "PARAMETERS" 
    2325.TP 
    2426\fBcon\fR 
    25 The "parent" connection. This is a valid open controll connection as opend via \fBroar_simple_connect\fR(3). 
     27The "parent" connection. This is a valid open control connection as opend via \fBroar_simple_connect\fR(3). 
    2628 
    2729.TP 
     
    4547 
    4648.SH "SEE ALSO" 
     49\fBroar_vs_new_simple\fR(3), 
    4750\fBroar_simple_connect\fR(3), 
    4851\fBroar_simple_play\fR(3), 
  • doc/man3/roar_simple_play.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_simple_play" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_simple_play" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
     
    2222After you are done you need to close the connection via \fBroar_simple_close\fR(3). 
    2323In case you just don't do anything with the stream the server will kick your connection, or, in case of playback 
    24 warns the user avout underruns. 
     24warns the user about underruns. 
     25 
     26All those functions are marked obsolete and will be removed soon. 
     27Please upgrade to VS API. See \fBroar_vs_new_simple\fR(3).  
    2528 
    2629.SH "PARAMETERS" 
     
    6770 
    6871.SH "SEE ALSO" 
     72\fBroar_vs_new_simple\fR(3), 
    6973\fBroarcat\fR(1), \fBroarmon\fR(1), \fBroarrec\fR(1), \fBroarfilt\fR(1), 
    7074\fBroar_server_oinfo\fR(3), 
  • doc/man3/roar_simple_stream.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_simple_stream" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_simple_stream" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
     
    1313 
    1414.SH "DESCRIPTION" 
    15 This creates a new stream to RoarAudio. Normaly you want to use one of \fBroar_simple_play\fR(3), \fBroar_simple_monitor\fR(3), \fBroar_simple_record\fR(3) or \fBroar_simple_filter\fR(3). 
     15This creates a new stream to RoarAudio. Normally you want to use one of \fBroar_simple_play\fR(3), \fBroar_simple_monitor\fR(3), \fBroar_simple_record\fR(3) or \fBroar_simple_filter\fR(3). 
     16 
     17his functions are marked obsolete and will be removed very soon. 
     18Please upgrade to VS API. See \fBroar_vs_new_simple\fR(3). 
    1619 
    1720.SH "PARAMETERS" 
     
    5659 
    5760.SH "SEE ALSO" 
     61\fBroar_vs_new_simple\fR(3), 
    5862\fBroar_simple_play\fR(3), 
    5963\fBroar_simple_close\fR(3), 
  • doc/man3/roar_socket_listen.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_socket_listen" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_socket_listen" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
  • doc/man3/roar_socket_nonblock.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_socket_nonblock" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_socket_nonblock" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
  • doc/man3/roar_str2codec.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_str2codec" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_str2codec" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
  • doc/man3/roar_stream_add_data.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_stream_add_data" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_stream_add_data" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
  • doc/man3/roar_stream_connect.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_stream_connect" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_stream_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
  • doc/man3/roar_stream_connect_to.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_stream_connect_to" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_stream_connect_to" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
  • doc/man3/roar_stream_exec.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_stream_exec" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_stream_exec" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
  • doc/man3/roar_stream_new.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_stream_new" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_stream_new" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
  • doc/man3/roar_vio_close.3

    r4013 r5032  
    11.\" roar_simple_play.3: 
    22 
    3 .TH "roar_vio_close" "3" "March 2009" "RoarAudio" "System Manager's Manual: RoarAuido" 
     3.TH "roar_vio_close" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 
    44 
    55.SH NAME 
Note: See TracChangeset for help on using the changeset viewer.