Changeset 5159:b226b74be970 in roaraudio for doc/man1/roard.1

Timestamp:

10/16/11 12:42:31 (13 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

Updated manpages (pr1)

File:

• doc/man1/roard.1 (modified) (2 diffs)

doc/man1/roard.1

@@ -38 +38 @@
 Sets default memory locking level to LEVEL.
 
+Valid levels are:
+.RS
+.TP
+\fBnone\fR
+No memory is locked at all.
+
+.TP
+\fBlow\fR
+Only very few (important) objects are locked in memory.
+
+.TP
+\fBmedium\fR
+Few (important) objects are locked in memory.
+
+.TP
+\fBhigh\fR
+Many objects are locked in memory.
+
+.TP
+\fBnearlyall\fR
+All known objects are locked in memory.
+
+.TP
+\fBnearlyallsys\fR
+All known objects are locked in memory but also pages provided by the system like stack and heap.
+
+.TP
+\fBallcur\fR
+All currently used pages are locked in memory.
+
+.TP
+\fBall\fR
+All pages (including future allocated pages) are locked in memory.
+
+.TP
+\fBdefault\fR
+Use defaults (the default).
+
+.RE
+
+A higher memlock level may result in memory allocations problems at runtime and even segfauls on some systems.
+(VM killed processes). Check your current system limits before altering this value.
+
 .TP
 \fB--pidfile PIDFILE\fR
@@ -138 +181 @@
 
 .SH "AUTH OPTIONS"
-.TP
-\fB--guest-acclev\fR
+The following options control the access rights of connections.
+Some of them take an access level. The access level is one from the following list:
+.RS
+.TP
+\fBnone\fR
+This is used to disable an authentication method.
+
+.TP
+\fBidented\fR
+Used internally. Should not be used.
+
+.TP
+\fBconctl\fR
+The client is only allowed to do some basic operations only affecting it's own connection.
+
+.TP
+\fBguest\fR
+Guest access (read only). The client may list resources but not alter them.
+
+.TP
+\fBuser\fR
+Normal user. The client may create and alter most resources.
+
+.TP
+\fBpwruser\fR
+Power User. The client can create and alter all resources and do all operation but operations
+which would break the POSIX right system. The user is not allowed to control the server itself
+like terminating it or alter (system) resources with the rights of the user runnung roard.
+
+This is the access level a fully trusted user in a multi user setup should have.
+
+.TP
+\fBall\fR
+The client can do everything. This includes operations which may alter system resources (like files)
+with the rights of the user running roard.
+
+This accesslevel should be given to the user in case of a single user setup or root or some administrator
+in a multi user setup.
+.RE
+
+.TP
+\fB--guest-acclev ACCESSLEVEL\fR
 Sets the access level for guest connections. Set to "none" to disable guest access.
 
 .TP
-\fB--trust-acclev\fR
+\fB--trust-acclev ACCESSLEVEL\fR
 Sets the access level for clients authenticated by trust auth.
 Set to "none" to disable trust auth.