core/builtins/objinfo.cif
changeset 0 7f656887cf89
child 90 ceac7084e2e5
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # objinfo.cif
       
     2 # 
       
     3 # Copyright (c) 2010 Accenture. All rights reserved.
       
     4 # This component and the accompanying materials are made available
       
     5 # under the terms of the "Eclipse Public License v1.0"
       
     6 # which accompanies this distribution, and is available
       
     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 # 
       
     9 # Initial Contributors:
       
    10 # Accenture - Initial contribution
       
    11 #
       
    12 
       
    13 ==name objinfo
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Display information about kernel objects.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 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.
       
    22 
       
    23 ==see-also
       
    24 
       
    25 L<ps|ps>, L<chunkinfo|chunkinfo>, L<svrinfo|svrinfo>
       
    26 
       
    27 ==argument uint object_address optional
       
    28 
       
    29 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>.
       
    30 
       
    31 ==option bool r referencers
       
    32 
       
    33 Print the names of threads and processes that are holding handles to a given object.
       
    34 
       
    35 ==option uint p process-id
       
    36 
       
    37 List all the objects that the specified process references.
       
    38 
       
    39 ==option uint t thread-id
       
    40 
       
    41 List all the objects that the specified thread references.
       
    42 
       
    43 ==option bool a all
       
    44 
       
    45 Include details of objects referenced by threads of a given process. Only useful in conjunction with the C<-p> option.
       
    46 
       
    47 ==copyright
       
    48 
       
    49 Copyright (c) 2006-2010 Accenture. All rights reserved.
       
    50