core/builtins/objinfo.cif
changeset 0 7f656887cf89
child 90 ceac7084e2e5
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/core/builtins/objinfo.cif	Wed Jun 23 15:52:26 2010 +0100
@@ -0,0 +1,50 @@
+# objinfo.cif
+# 
+# Copyright (c) 2010 Accenture. All rights reserved.
+# This component and the accompanying materials are made available
+# under the terms of the "Eclipse Public License v1.0"
+# which accompanies this distribution, and is available
+# at the URL "http://www.eclipse.org/legal/epl-v10.html".
+# 
+# Initial Contributors:
+# Accenture - Initial contribution
+#
+
+==name objinfo
+
+==short-description
+
+Display information about kernel objects.
+
+==long-description
+
+Given a kernel object address, prints details of the threads and processes that are currently holding handles to it (note, kernel objects addresses can be found using L<ps|ps> (e.g. C<ps -A> or C<ps -At>), L<chunkinfo|chunkinfo> or L<svrinfo|svrinfo>). Given a thread or process identifier, lists details of all the owned objects.
+
+==see-also
+
+L<ps|ps>, L<chunkinfo|chunkinfo>, L<svrinfo|svrinfo>
+
+==argument uint object_address optional
+
+The address of the kernel object to find the owners of. If not specified, a thread or process identifier must be specified using C<-t> or C<-p>.
+
+==option bool r referencers
+
+Print the names of threads and processes that are holding handles to a given object.
+
+==option uint p process-id
+
+List all the objects that the specified process references.
+
+==option uint t thread-id
+
+List all the objects that the specified thread references.
+
+==option bool a all
+
+Include details of objects referenced by threads of a given process. Only useful in conjunction with the C<-p> option.
+
+==copyright
+
+Copyright (c) 2006-2010 Accenture. All rights reserved.
+