user_list.c: Minor documentation impreovements.
[paraslash.git] / server.ggo
index a32673d..62e0830 100644 (file)
@@ -38,11 +38,11 @@ privileges right after parsing the command
 line options, but before parsing the
 configuration file. In this case,
 real/effective/saved UID are all set to the
-UID of 'username'. As the configuration file
+UID of 'name'. As the configuration file
 is read afterwards, those options that have a
 default value depending on the UID (e.g. the
 directory for the configuration file) are
-computed by using the uid of 'username'.
+computed by using the uid of 'name'.
 This option has no effect if para_server is
 started as a non-root user (i.e.  EUID != 0)"
 
@@ -59,7 +59,7 @@ Otherwise, real/effective GID and the saved
 set-group ID are all set to the GID given by
 'group'. Must not be given in the config file."
 
-       string typestr="groupname"
+       string typestr="group"
        optional
 
 
@@ -94,8 +94,8 @@ option "user_list" -
 
 
 
-section "audio file sender"
-#~~~~~~~~~~~~~~~~~~~~~~~~~~
+section "virtual streaming system"
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 option "autoplay" a
@@ -124,100 +124,44 @@ option "announce_time" A
        optional
 
 
-option "selector" S
-#~~~~~~~~~~~~~~~~~~
-
-"(default=random)"
-
-       string typestr="name"
-       optional
-
-
-
-section "mysql selector:"
-#~~~~~~~~~~~~~~~~~~~~~~~~
-
-
-option "mysql_host" -
-#~~~~~~~~~~~~~~~~~~~~
-
-"mysql server"
+#############################
+section "audio file selector"
+#############################
 
-       string typestr="ip or hostname"
-       default="localhost"
-       optional
-
-option "mysql_port" -
-#~~~~~~~~~~~~~~~~~~~~
+option "afs_database_dir" D
+#~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-"where mysql is listening"
+"Directory containing the osl database of the
+audio file selector.
+(default='~/.paraslash/afs_database'"
 
-       int typestr="portnumber"
-       default="3306"
+       string typestr="path"
        optional
 
 
-option "mysql_user" -
+option "afs_socket" s
 #~~~~~~~~~~~~~~~~~~~~
 
-"default value: username from /etc/passwd"
+"Command socket for the audio file selector"
 
-       string typestr="username"
+       string typestr="path"
+       default="/var/paraslash/afs_command_socket"
        optional
 
-option "mysql_passwd" -
-#~~~~~~~~~~~~~~~~~~~~~~
-
-"(required)"
-
-       string
-       optional
-
-option "mysql_database" -
-#~~~~~~~~~~~~~~~~~~~~~~~~
-
-"name of mysql database"
-
-       string
-       default="paraslash"
-       optional
-
-option "mysql_audio_file_dir"  -
-#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-"dir to search for audio files (required)"
-
-       string typestr="dirname"
-       optional
-
-option "mysql_default_score" -
-#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-"scoring rule to use if stream definition
-does not contain explicit score definition"
-
-       string
-       default="(LASTPLAYED() / 1440 - 1000 / (LASTPLAYED() + 1) - sqrt(NUMPLAYED()))"
-       optional
-
-
-
-
-section "random selector"
-#~~~~~~~~~~~~~~~~~~~~~~~~
-
+option "afs_initial_mode" i
+#~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-option "random_dir" -
-#~~~~~~~~~~~~~~~~~~~~
+"Mood or playlist to load on startup. Must be
+prefixed with either 'p/' or 'm/' to indicate
+whether a playlist or a mood should be
+loaded. Example:
+       --afs_initial_mode p/foo
+loads the playlist named 'foo'."
 
-"dir to search for audio files"
-       string typestr="dirname"
-       default="/home/music"
+       string typestr="<specifier>/<name>"
        optional
 
 
-
-
 section "http sender"
 #~~~~~~~~~~~~~~~~~~~~
 
@@ -284,11 +228,22 @@ option "dccp_port" -
 "port for dccp streaming"
 
        int typestr="portnumber"
-       default="5001"
+       default="8000"
        optional
 
+option "dccp_default_deny" -
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"See http_default_deny"
 
+       flag off
+
+option "dccp_access" -
+#~~~~~~~~~~~~~~~~~~~~~
+"See http_access"
 
+       string typestr="a.b.c.d/n"
+       optional
+       multiple
 
 section "ortp sender"
 #~~~~~~~~~~~~~~~~~~~~