Changeset 5159:b226b74be970 in roaraudio


Ignore:
Timestamp:
10/16/11 12:42:31 (12 years ago)
Author:
phi
Branch:
default
Phase:
public
Message:

Updated manpages (pr1)

Files:
3 edited

Legend:

Unmodified
Added
Removed
  • ChangeLog

    r5146 r5159  
    44        * Fixed invalid pointer aliasing (Closes: #178) 
    55        * Fixed segfaul in PortAudio driver(v19) if no device is found. 
    6         * Fixed invalid pointer aliasing in filter code (pr0) 
     6        * Fixed invalid pointer aliasing in filter code (pr1) 
    77        * Fixed remote a local buffer overflow in client to message 
    88          converter code as well as a remote attackable overflow in 
    9           message to client converter code (pr0) 
    10         * Updated error handling (pr0) 
    11         * Moved error frame handling into proto functions (pr0) 
     9          message to client converter code (pr1) 
     10        * Updated error handling (pr1) 
     11        * Moved error frame handling into proto functions (pr1) 
     12        * Updated manpages (pr1) 
    1213 
    1314v. 0.4rc0 - Mon Sep 05 2011 15:25 CEST 
  • doc/man1/roarctl.1

    r4818 r5159  
    2121 
    2222.TP 
    23 \fB-v\fR 
     23\fB--verbose\fR, \fB\-v\fR 
    2424Be verbose. May be used multiple times. 
     25 
     26.TP 
     27\fB--list-libstandards\fR 
     28Similar to serverstandards, reports the list of standard libroar supports. 
     29 
     30.TP 
     31\fB--list-aiprofiles\fR 
     32Show audio info profiles and exit. 
     33 
     34.TP 
     35\fB--enum-servers\fR 
     36List servers found on the network. 
     37Depending on the build options of libroar this includes results from many tests 
     38like standard server locations, OpenSLP located servers, X11 located servers, 
     39DECnet's neighbor and IP's ARP table and other sources. 
    2540 
    2641.SH "NETWORK OPTIONS" 
     
    3550 
    3651.TP 
     52\fBlistaiprofiles\fR 
     53List audio info profiles. 
     54 
     55.TP 
     56\fBaiprofileget PROFILE\fR 
     57Display a the given audio info profile. 
     58 
     59.TP 
    3760\fBsleep TIME\fR 
    3861Sleeps for TIME seconds. 
     62 
     63.TP 
     64\fBping NUM\fR 
     65Pings the server NUM times. This is done by sending NOOP commands to the server. 
     66The response time as well as as a small statistics section is printed. 
     67 
     68This is not supported on all platforms. 
     69 
     70.TP 
     71\fBwhoami\fR 
     72Report client ID of roarctl on the current server. 
    3973 
    4074.TP 
     
    84118 
    85119.TP 
    86 \fBflag ID FLAGS\fR, \fBunflag ID FLAGS\fR 
    87 Sets or removes flags from a stream. ID is the stream id. 
     120\fBnewvirtual P D E R B C\fR 
     121Adds a new virtual (child) stream. 
     122This is used with container formats such as RAUM, Ogg and Matroska. 
     123 
     124 
     125Parameters: 
     126.RS 
     127.TP 
     128\fBP\fR 
     129Stream ID of \fBP\fRarent stream. 
     130.TP 
     131\fBD\fR 
     132Stream \fBD\fRirection. 
     133.TP 
     134\fBE\fR 
     135Stream cod\fBE\fRc. 
     136.TP 
     137\fBR\fR 
     138Sample \fBR\fRate. 
     139.TP 
     140\fBB\fR 
     141\fBB\fRits per sample. 
     142.TP 
     143\fBC\fR 
     144Number of \fBC\fRhannels. 
     145.RE 
     146 
     147.TP 
     148\fBflag ID FLAGS\fR, \fBunflag ID FLAGS\fR, \fBtoogleflag ID FLAGS\fR 
     149Sets, removes or toggles flags on a stream. ID is the stream id. 
    88150FLAGS is a comma separated list of flags. 
    89151 
    90152It is not possible to set all kinds of flags at runtime. 
    91153 
     154.TP 
     155\fBprotectflag ID FLAGS\fR 
     156Protects flags on a stream. ID is the stream id. 
     157FLAGS is a comma separated list of flags. 
     158 
     159Protected flags can not be changed anymore after the they got protected. 
     160 
    92161.SH "META DATA COMMANDS" 
     162.TP 
     163\fBrole ID ROLE\fR 
     164Set stream role ROLE on stream ID. 
     165 
     166.TP 
     167\fBmetaget ID TYPE\fR 
     168Read meta date of type TYPE from stream ID. 
     169 
    93170.TP 
    94171\fBmetasave ID FILE\fR 
     
    102179as for \fBmetasave\fR. 
    103180 
    104 .SH "LISTING COMMANDS" 
     181.SH "SERVER INFO COMMANDS" 
     182.TP 
     183\fBserverinfo\fR 
     184Gets general information about the server. 
     185This includes software vendor and version. 
     186 
     187.TP 
     188\fBservertime\fR 
     189Reports the server's system time. 
     190 
     191.TP 
     192\fBserverstandards\fR 
     193Report a list of standards the server supports. 
     194 
     195.TP 
     196\fBlibstandards\fR 
     197Similar to serverstandards, reports the list of standard libroar supports. 
     198Same as \fB--list-libstandards\fR. 
     199 
    105200.TP 
    106201\fBserveroinfo\fR 
     
    111206Gets Information about server output for a given direction. 
    112207 
     208.SH "LISTING COMMANDS" 
    113209.TP 
    114210\fBlistclients\fR 
  • doc/man1/roard.1

    r5146 r5159  
    3838Sets default memory locking level to LEVEL. 
    3939 
     40Valid levels are: 
     41.RS 
     42.TP 
     43\fBnone\fR 
     44No memory is locked at all. 
     45 
     46.TP 
     47\fBlow\fR 
     48Only very few (important) objects are locked in memory. 
     49 
     50.TP 
     51\fBmedium\fR 
     52Few (important) objects are locked in memory. 
     53 
     54.TP 
     55\fBhigh\fR 
     56Many objects are locked in memory. 
     57 
     58.TP 
     59\fBnearlyall\fR 
     60All known objects are locked in memory. 
     61 
     62.TP 
     63\fBnearlyallsys\fR 
     64All known objects are locked in memory but also pages provided by the system like stack and heap. 
     65 
     66.TP 
     67\fBallcur\fR 
     68All currently used pages are locked in memory. 
     69 
     70.TP 
     71\fBall\fR 
     72All pages (including future allocated pages) are locked in memory. 
     73 
     74.TP 
     75\fBdefault\fR 
     76Use defaults (the default). 
     77 
     78.RE 
     79 
     80A higher memlock level may result in memory allocations problems at runtime and even segfauls on some systems. 
     81(VM killed processes). Check your current system limits before altering this value. 
     82 
    4083.TP 
    4184\fB--pidfile PIDFILE\fR 
     
    138181 
    139182.SH "AUTH OPTIONS" 
    140 .TP 
    141 \fB--guest-acclev\fR 
     183The following options control the access rights of connections. 
     184Some of them take an access level. The access level is one from the following list: 
     185.RS 
     186.TP 
     187\fBnone\fR 
     188This is used to disable an authentication method. 
     189 
     190.TP 
     191\fBidented\fR 
     192Used internally. Should not be used. 
     193 
     194.TP 
     195\fBconctl\fR 
     196The client is only allowed to do some basic operations only affecting it's own connection. 
     197 
     198.TP 
     199\fBguest\fR 
     200Guest access (read only). The client may list resources but not alter them. 
     201 
     202.TP 
     203\fBuser\fR 
     204Normal user. The client may create and alter most resources. 
     205 
     206.TP 
     207\fBpwruser\fR 
     208Power User. The client can create and alter all resources and do all operation but operations 
     209which would break the POSIX right system. The user is not allowed to control the server itself 
     210like terminating it or alter (system) resources with the rights of the user runnung roard. 
     211 
     212This is the access level a fully trusted user in a multi user setup should have. 
     213 
     214.TP 
     215\fBall\fR 
     216The client can do everything. This includes operations which may alter system resources (like files) 
     217with the rights of the user running roard. 
     218 
     219This accesslevel should be given to the user in case of a single user setup or root or some administrator 
     220in a multi user setup. 
     221.RE 
     222 
     223.TP 
     224\fB--guest-acclev ACCESSLEVEL\fR 
    142225Sets the access level for guest connections. Set to "none" to disable guest access. 
    143226 
    144227.TP 
    145 \fB--trust-acclev\fR 
     228\fB--trust-acclev ACCESSLEVEL\fR 
    146229Sets the access level for clients authenticated by trust auth. 
    147230Set to "none" to disable trust auth. 
Note: See TracChangeset for help on using the changeset viewer.