1WESTON-DEBUG(1) General Commands Manual WESTON-DEBUG(1)
2
3
4
6 weston-debug - a tool for getting debug messages from compositor.
7
9 weston-debug [options] [names]
10
12 weston-debug is a debugging tool which uses weston_debug_v1 interface
13 to get the debug messages from the compositor. The debug messages are
14 categorized into different debug streams by the compositor (example:
15 logs, proto, list, etc.,) and the compositor requires a file descriptor
16 to stream the messages.
17
18 This tool accepts a file name or a file descriptor (not both) and any
19 desired debug stream names from the user as command line arguments and
20 subscribes the desired streams from the compositor by using the we‐
21 ston_debug_v1 interface. After the subscription, the compositor will
22 start to write the debug messages to the shared file descriptor.
23
24 If no file name or file descriptor argument is given, the tool will use
25 the stdout file descriptor.
26
27
29 weston-debug accepts the following command line options.
30
31 -h, --help
32 Print the help text and exit with success.
33
34 -l, --list
35 List the available debug streams supported by the compositor.
36 May be used together with --all or a list of debug stream names.
37
38 -a, --all
39 Bind all debug streams offered by the compositor. Mututally ex‐
40 clusive with explicitly specifying stream names.
41
42 -o FILE, --output FILE
43 Direct output to file named FILE. Use - for stdout. Stdout is
44 the default. Mutually exclusive with -f.
45
46 -f FD, --outfd FD
47 Direct output to the file descriptor FD. Stdout (1) is the de‐
48 fault. Mutually exclusive with -o.
49
50 [names]
51 A list of debug streams to bind to. Mutually exclusive with
52 --all.
53
54
55
56Weston 10.0.1 2018-09-11 WESTON-DEBUG(1)