1 # sudo.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 sudo

    14 

    15 ==short-description

    16 

    17 Launch an executable with modified capabilities and / or other properties.

    18 

    19 ==long-description

    20 

    21 The command operates in one of two modes, depending on whether C<--disk> is specified. With this option, a copy of the exe is made on the C drive, modified there then executed. Without it, the process is launched then before it is resumed the properties are modified in the kernel. The default (without C<--disk>) is neater but is limited in that it cannot change heap or stack sizes, and if the DLLs that are linked to have too many capabilities to allow the exe to launch as is, you won't get far enough to change them. Previously the C<--disk> option was the default. If no capability or sid etc options are specified then the exe will be launched with capabilities C<All -TCB> and no other changes.

    22 

    23 ==argument string exe-name

    24 

    25 The executable to modify then launch.

    26 

    27 ==argument string arguments optional last

    28 

    29 Arguments to pass to the exe.

    30 

    31 ==option string a add-cap multiple

    32 

    33 Adds the specified capability.

    34 

    35 ==option string r remove-cap multiple

    36 

    37 Removes the specified capability (if a cap is included in both add and remove lists, the remove takes precedence).

    38 

    39 ==option uint s sid

    40 

    41 Sets the Secure ID to the specified value.

    42 

    43 ==option uint v vid

    44 

    45 Sets the Vendor ID to the specified value.

    46 

    47 ==option uint m heap-min

    48 

    49 Sets the process's default minimum heap size to the specified value (in bytes).

    50 

    51 ==option uint x heap-max

    52 

    53 Sets the process's default maximum heap size to the specified value (in bytes).

    54 

    55 ==option uint z stack-size

    56 

    57 Sets the process's default stack size to the specified value (in bytes).

    58 

    59 ==option int p process-priority

    60 

    61 Sets the process priority to the specified value (as per C<TProcessPriority>).

    62 

    63 =over 5

    64 

    65 =item low

    66 

    67 150

    68 

    69 =item background

    70 

    71 250

    72 

    73 =item foreground

    74 

    75 350

    76 

    77 =item high

    78 

    79 450

    80 

    81 =item windowserver

    82 

    83 650

    84 

    85 =item fileserver

    86 

    87 750

    88 

    89 =item realtimeServer

    90 

    91 850

    92 

    93 =item supervisor

    94 

    95 950

    96 

    97 =back

    98 

    99 ==option bool k keep

   100 

   101 Do not delete the modified exe when the process exits. If the exe is in the Core ROM, this option will keep the modified binary in memory until next reboot, such that any other code that launches the exe will pick up these settings (running sudo a second time on this exe without C<--keep> will undo it).

   102 

   103 ==option bool d disk

   104 

   105 Change the on-disk binary rather than modifying the in-memory kernel process attributes. This option is required for changing heap and stack sizes. On WINSCW the C<--disk> option still operates on E32 binaries, therefore it is not possible to modify a WINSCW binary with C<--disk>.

   106 

   107 ==option bool w wait

   108 

   109 Wait for a keypress before resuming the process. Use this option if you need to examine the process before it runs.

   110 

   111 ==copyright

   112 

   113 Copyright (c) 2008-2010 Accenture. All rights reserved.

   114