|
1 # btraceout.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 btraceout |
|
14 |
|
15 ==short-description |
|
16 |
|
17 Create btrace output either from command-line arguments, or optionally from data read from C<stdin>. |
|
18 |
|
19 ==long-description |
|
20 |
|
21 Chooses an appropriate C<BTraceXxx> macro based on the supplied arguments and options. When reading data from C<stdin>, uses C<BTraceBig> (which will generate a multipart frame if the data is too large for one frame) unless C<--truncate> is specified (in which case C<BTraceN> is used even if it causes truncation). |
|
22 |
|
23 ==see-also |
|
24 |
|
25 L<btrace|btrace>, L<atrace|atrace> |
|
26 |
|
27 ==argument uint category |
|
28 |
|
29 The btrace category to use. Must be 0-255. |
|
30 |
|
31 ==argument uint subcategory |
|
32 |
|
33 The btrace subcategory to use. Must be 0-255. |
|
34 |
|
35 ==argument uint arg_1 optional |
|
36 |
|
37 The first btrace argument. |
|
38 |
|
39 ==argument uint arg_2 optional |
|
40 |
|
41 The second btrace argument. |
|
42 |
|
43 ==argument uint arg_3 optional |
|
44 |
|
45 The third btrace argument. |
|
46 |
|
47 ==option bool s stdin |
|
48 |
|
49 Read data from stdin. |
|
50 |
|
51 ==option bool t truncate |
|
52 |
|
53 Write the data using C<BTraceN> instead of C<BTraceBig>, even if this means the data gets truncated. Can only be used with C<--stdin>. |
|
54 |
|
55 ==option uint f filter |
|
56 |
|
57 Specify a secondary filter UID on the btrace output. |
|
58 |
|
59 ==copyright |
|
60 |
|
61 Copyright (c) 2009-2010 Accenture. All rights reserved. |
|
62 |