commands/cenrep/cenrep.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # cenrep.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 cenrep
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Get and set Central Repository keys.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 To set integer key zero on repository 0x12345678 to 6 (for example), run:
       
    22 
       
    23   cenrep 0x12345678 0 --set-int 6
       
    24 
       
    25 Note, the Central Repository does not distinguish between 16-bit and 8-bit descriptor values, so if you try listing a key of type string or string8, this tool will display the value in 3 forms:
       
    26 
       
    27 =over 5
       
    28 
       
    29 =item *
       
    30 
       
    31 Interpreted as a 16-bit string.
       
    32 
       
    33 =item *
       
    34 
       
    35 Interpreted as an 8-bit string.
       
    36 
       
    37 =item *
       
    38 
       
    39 As a hex dump.
       
    40 
       
    41 =back
       
    42 
       
    43 It is up to you to figure out which form is appropriate for the key you are looking at. For example, there will be no error if you try and assign a 16-bit string to a key defined in the cenrep data file as string8. It will suceed, but whatever uses this key will almost certainly break.
       
    44 
       
    45 ==argument uint repository_uid optional
       
    46 
       
    47 The UID of the required repository. If not set, lists all the repositories one uid per line. These can be decoded by for example piping into uidinfo using C<cenrep | uidinfo --stdin>.
       
    48 
       
    49 ==argument uint key optional
       
    50 
       
    51 The identifier of the required key. If not set, lists all the keys in the repository.
       
    52 
       
    53 ==option int i set-int
       
    54 
       
    55 Sets the specified key to this integer value.
       
    56 
       
    57 ==option string s set-string
       
    58 
       
    59 Sets the specified key to this 16-bit descriptor value.
       
    60 
       
    61 ==option bool f force
       
    62 
       
    63 Attempt to read or set the key while pretending to have the secure ID of the repository creator. Unless the repository is configured to deny access even to its creator (which is rare) this is enough to gain access to otherwise inaccessible repositories.
       
    64 
       
    65 ==option bool d delete
       
    66 
       
    67 Delete the specified key, or all keys in the repository if no key is specified.
       
    68 
       
    69 ==option bool r reset
       
    70 
       
    71 Resets the repository. Combined with C<--force>, deletes the actual persists file on disk rather than just calling C<CRepository::Reset>.
       
    72 
       
    73 ==copyright
       
    74 
       
    75 Copyright (c) 2007-2010 Accenture. All rights reserved.
       
    76