From 43c1420d37df58fdfc8b7e5ae229afd34a8bf070 Mon Sep 17 00:00:00 2001
From: Jon Robertson <jonrober@stanford.edu>
Date: Thu, 21 Jan 2010 19:08:48 -0800
Subject: Documentation additions and fixes

Added documentation for the new object and acl list searches to
perl/Wallet/Admin.pm and server/wallet-admin.  Also fixed a POD error
in perl/Wallet/Kadmin.pm's docs.
---
 server/wallet-admin | 51 ++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 48 insertions(+), 3 deletions(-)

(limited to 'server/wallet-admin')

diff --git a/server/wallet-admin b/server/wallet-admin
index 01fea5c..761288d 100755
--- a/server/wallet-admin
+++ b/server/wallet-admin
@@ -156,10 +156,10 @@ Before running C<initialize>, the wallet system has to be configured.  See
 Wallet::Config(3) for more details.  Depending on the database backend
 used, the database may also have to be created in advance.
 
-=item list (acls | objects)
+=item list (acls | objects) [ <searchtype> [ <arg> ... ] ]
 
-Returns a list of all ACLs or objects in the database.  ACLs will be
-listed in the form:
+Returns a list of ACLs or objects in the database.  ACLs will be listed 
+in the form:
 
     <name> (ACL ID: <id>)
 
@@ -171,6 +171,51 @@ be listed in the form:
 
 In both cases, there will be one line per ACL or object.
 
+If no searchtype is given, all the ACLs or objects in the database will
+be returned.  If a searchtype (and possible search arguments) are given,
+then the ACLs or objects will be limited to those that match the search.
+
+The currently supported object search types are:
+
+=over 4
+
+=item list objects type <type>
+
+Returns all objects of the given type.
+
+=item list objects flag <flag>
+
+Returns all objects which have the given flag set.
+
+=item list objects owner <acl name>
+
+Returns all objects owned by the given ACL name.
+
+=item list objects acl <acl name>
+
+Returns all objects for which the given ACL name has any permissions.
+This includes those objects owned by the ACL, but also those for which the
+ACL has get permissions, for example.
+
+=back
+
+The currently supported ACL search types are:
+
+=over 4
+
+=item list acls empty
+
+Returns all ACLs which have no entries, generally so that abandoned ACLs
+can be housekept.
+
+=item list acls entry <schema> <identifier>
+
+Returns all ACLs containing an entry with given schema and identifier.  
+The schema is used for an exact search, while the identifier given will 
+match any identifier containing that text, for flexibility.
+
+=back
+
 =item register (object | verifier) <type> <class>
 
 Registers an implementation of a wallet object or ACL verifier in the
-- 
cgit v1.2.3