| Pekka Paalanen | b9fdc14 | 2017-10-12 13:13:44 +0200 | [diff] [blame^] | 1 | .TH WESTON-DEBUG 1 "2018-09-11" "Weston @version@" |
| 2 | .SH NAME |
| 3 | weston-debug \- a tool for getting debug messages from compositor. |
| 4 | .SH SYNOPSIS |
| 5 | .B weston-debug [options] [names] |
| 6 | . |
| 7 | .\" *************************************************************** |
| 8 | .SH DESCRIPTION |
| 9 | |
| 10 | .B weston-debug |
| 11 | is a debugging tool which uses weston_debug_v1 interface to get the |
| 12 | debug messages from the compositor. The debug messages are categorized into different |
| 13 | debug streams by the compositor (example: logs, proto, list, etc.,) and the compositor |
| 14 | requires a file descriptor to stream the messages. |
| 15 | |
| 16 | This tool accepts a file name or a file desciptor (not both) and any desired debug stream |
| 17 | names from the user as command line arguments and subscribes the desired streams from the |
| 18 | compositor by using the weston_debug_v1 interface. After the subscription, the |
| 19 | compositor will start to write the debug messages to the shared file descriptor. |
| 20 | |
| 21 | If no file name or file descriptor argument is given, the tool will use the stdout file |
| 22 | descriptor. |
| 23 | |
| 24 | . |
| 25 | .\" *************************************************************** |
| 26 | .SH OPTIONS |
| 27 | . |
| 28 | .B weston-debug |
| 29 | accepts the following command line options. |
| 30 | .TP |
| 31 | . B \-h, \-\-help |
| 32 | Print the help text and exit with success. |
| 33 | .TP |
| 34 | . B \-l, \-\-list |
| 35 | List the available debug streams supported by the compositor. May be used |
| 36 | together with --all or a list of debug stream names. |
| 37 | .TP |
| 38 | . B \-a, \-\-all |
| 39 | Bind all debug streams offered by the compositor. Mututally exclusive with |
| 40 | explicitly specifying stream names. |
| 41 | .TP |
| 42 | . B \-o FILE, \-\-output FILE |
| 43 | Direct output to file named FILE. Use - for stdout. |
| 44 | Stdout is the default. Mutually exclusive with -f. |
| 45 | .TP |
| 46 | . B \-f FD, \-\-outfd FD |
| 47 | Direct output to the file descriptor FD. |
| 48 | Stdout (1) is the default. Mutually exclusive with -o. |
| 49 | .TP |
| 50 | .B [names] |
| 51 | A list of debug streams to bind to. Mutually exclusive with --all. |