mi: add machine interface description to man page
A message that is not in the archive (sent off-list or not yet received): [email protected]
Merged. I corrected a couple of things but most of it is there.
Thanks!
David
Quoted 44 lines · Jonathan Rajotte Julien
Signed-off-by Jonathan Rajotte Julien <[email protected]>--- doc/man/lttng.1 | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+)doc/man/lttng.1 +20
-0@@ -77,6 +77,26 @@ Simple listing of lttng options. .TP .BR "\-\-list\-commands" Simple listing of lttng commands. +.TP +.BR "\-m, \-\-mi TYPE +Machine interface + +TYPE supported: XML + +Machine interface (MI) mode convert the traditional pretty printing to a more +machine friendly output syntax. Mi mode provide a format change-resistant way to +access information generated via lttng-cli. + +When using MI mode, the generated document is outputted on STDOUT. +Errors and warning are outputted as normal on STDERR and in normal format. + +If any errors occurs during the execution of a command, the return value +of the command will be different than zero as normal. In this event, lttng does +no guarantees the syntax and data validity of the generated document. + +For XML output type, lttng provide an xml schema definitioni (XSD) file for validation. It +can be found under: lttng-tools/src/common/mi_lttng.xsd. + .SH "COMMANDS" .PPSignature · 7 lines
2.0.0 _______________________________________________ lttng-dev mailing list [email protected] http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev
_______________________________________________
lttng-dev mailing list
[email protected]
http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev