X-Git-Url: http://git.tuebingen.mpg.de/?p=adu.git;a=blobdiff_plain;f=adu.h;h=b9e6ee9f67812764c8b65b7baf41bc9d31ef5978;hp=60966921219462236bb6109da2172c60590ced6d;hb=d57433c49f849c9de60d6c7c592268760697b56a;hpb=015abc3b736ce8cb784b9e60d8c4cf2427874d2d

diff --git a/adu.h b/adu.h
index 6096692..b9e6ee9 100644
--- a/adu.h
+++ b/adu.h
@@ -21,6 +21,7 @@
 #include <assert.h>
 #include <osl.h>
 #include "gcc-compat.h"
+#include "select.cmdline.h"
 
 /** debug loglevel, gets really noisy */
 #define DEBUG 1
@@ -145,6 +146,7 @@ enum user_table_columns {
 	NUM_UT_COLUMNS
 };
 
+/** Flags for the user hash table. */
 enum uid_info_flags {
 	/** Whether this slot of the hash table is used. */
 	UI_FL_SLOT_USED = 1,
@@ -152,19 +154,36 @@ enum uid_info_flags {
 	UI_FL_ADMISSIBLE = 2,
 };
 
+/** Information about one admissible user. */
 struct user_info {
+	/** User ID. */
 	uint32_t uid;
+	/** \sa enum uid_info_flags. */
 	uint32_t flags;
+	/** The user name.  */
 	char *pw_name;
+	/** The user table of this user.*/
 	struct osl_table *table;
+	/** Total number of files owned by this user. */
 	uint64_t files;
+	/** Total number of bytes owned by this user. */
 	uint64_t bytes;
+	/** Total number of directories that contain at least one file */
 	uint64_t dirs;
+	/** The description of the user table. */
 	struct osl_table_description *desc;
 };
 
+/**
+ * Describes one range of admissible user IDs.
+ *
+ * adu converts the admissible user ids given at the command line
+ * into an array of such structs.
+ */
 struct uid_range {
+	/** Lowest admissible user ID. */
 	uint32_t low;
+	/** Greatest admissible user ID. */
 	uint32_t high;
 };
 
@@ -177,7 +196,16 @@ enum search_uid_flags {
 
 extern uint32_t num_uids;
 extern struct osl_table *dir_table;
+
+/** The adu command line options. */
 extern struct gengetopt_args_info conf;
+
+/**
+ * The select command line options.
+ *
+ * Either given at the command line, or via the \a set command
+ * in interactive mode.
+ */
 extern struct select_args_info select_conf;
 
 /* adu.c */
@@ -193,9 +221,9 @@ int for_each_admissible_user(int (*func)(struct user_info *, void *),
 		void *data);
 void sort_hash_table(int (*comp)(const void *, const void *));
 
-/* select.c */
-int com_select(void);
-
-/* create.h */
+/* create.c */
 int com_create(void);
+
+/* interactive.c */
+void print_interactive_help(void);
 int com_interactive(void);