X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=user_list.h;h=41fad16464ae10eaea54f21ef5f2ec5bad6ce6ec;hp=f4e7661b5eb7900d43afa4ee4cd26c7771267a11;hb=e32a0e7295c6386b421956553ae577a7df1abf8e;hpb=68630d8b55d688a7c7ce116951c310150aa9c166

diff --git a/user_list.h b/user_list.h
index f4e7661b..41fad164 100644
--- a/user_list.h
+++ b/user_list.h
@@ -1,20 +1,22 @@
-/*
- * Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
 /** \file user_list.h exported functions from user_list.c */
 
 /**
- * permission flags that can be set individually for any server command
+ * Flags for server commands and user permissions.
  *
- * - AFS_READ: read-only command of the audio file selector
- * - AFS_WRITE: command changes state of the audio file selector
- * - VSS_READ: command reads information about the current audio stream
- * - VSS_WRITE: command changes the current audio stream
+ * For each command, zero or more of these flags are ored to define the command
+ * permissions. A user is allowed to run the command if and only if all command
+ * permission flags are set for the user in the server.users config file which
+ * is read at server startup.
  */
-enum {AFS_READ = 1, AFS_WRITE = 2, VSS_READ = 4, VSS_WRITE = 8};
+enum server_command_permissions {
+	NO_PERMISSION_REQUIRED = 0, /** None of the below. */
+	AFS_READ = 1, /** Read-only operation on the AFS database. */
+	AFS_WRITE = 2, /** Read-write operation on the AFS database. */
+	VSS_READ = 4, /** Read-only operation on the virtual streaming system. */
+	VSS_WRITE = 8 /** Read-write operation on the virtual streaming system. */
+};
 
 /**
  * data needed to authenticate the user