diff options
Diffstat (limited to 'doc/dlt-receive.1')
| -rw-r--r-- | doc/dlt-receive.1 | 176 |
1 files changed, 115 insertions, 61 deletions
diff --git a/doc/dlt-receive.1 b/doc/dlt-receive.1 index b3eff48..0c150a0 100644 --- a/doc/dlt-receive.1 +++ b/doc/dlt-receive.1 @@ -1,62 +1,116 @@ -.TH dlt-receive 1 "April 13, 2012" "version 2.9.0" "USER COMMANDS" -.SH NAME +'\" t +.\" Title: dlt-receive +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> +.\" Date: 10/11/2012 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "DLT\-RECEIVE" "1" "10/11/2012" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" dlt-receive \- Console based client for DLT Logging -.SH SYNOPSIS -.B dlt-receive -[\-h] [\-a] [\-x] [\-m] [\-s][\-o filename] [\-v] [\-y] -[\-b baudrate] [\-e ecuid]hostname/serial_device_name -.SH DESCRIPTION -Receive DLT messages from DLT daemon and print or store the messages. -.SH OPTIONS -.TP -\-h -Display a short help text. -.TP -\-a -Print DLT file; payload as ASCII. -.TP -\-x -Print DLT file; payload as hex. -.TP -\-m -Print DLT file; payload as hex and ASCII. -.TP -\-s -Print DLT file; only headers. -.TP -\-o -Output messages in new DLT file. -.TP -\-v -Verbose mode. -.TP -\-y -Serial device mode. -.TP -\-b -Serial device baudrate (Default: 115200). -.TP -\-e -Set ECU ID (Default: RECV). -.SH EXAMPLES -.TP -Print received message headers received from a dlt-daemon running on localhost: -.B dlt-receive -\-s localhost -.PP -.TP -Print received message headers received from a serila interface: -.B dlt-receive -\-s -y /dev/ttySO -.PP -.TP -Store received message headers from a dlt-daemon to a log file called log.dlt and filter them for e.g. Application ID ABCD and Context ID EFGH (Write:ABCD EFGH as single line to a file claled filter.txt): -.B dlt-receive -\-s -o log.dlt -f filter.txt localhost -.PP -.SH EXIT STATUS -Non zero is returned in case of failure. -.SH AUTHOR -Alexander Wenzel (alexander.aw.wenzel (at) bmw.de) -.SH SEE ALSO -dlt-daemon(1) +.SH "SYNOPSIS" +.sp +\fBdlt\-receive\fR [\-h] [\-a] [\-x] [\-m] [\-s][\-o filename] [\-v] [\-y] [\-b baudrate] [\-e ecuid]hostname/serial_device_name +.SH "DESCRIPTION" +.sp +Receive DLT messages from DLT daemon and print or store the messages\&. +.SH "OPTIONS" +.PP +\fB\-h\fR +.RS 4 +Display a short help text\&. +.RE +.PP +\fB\-a\fR +.RS 4 +Print DLT file; payload as ASCII\&. +.RE +.PP +\fB\-x\fR +.RS 4 +Print DLT file; payload as hex\&. +.RE +.PP +\fB\-m\fR +.RS 4 +Print DLT file; payload as hex and ASCII\&. +.RE +.PP +\fB\-s\fR +.RS 4 +Print DLT file; only headers\&. +.RE +.PP +\fB\-o\fR +.RS 4 +Output messages in new DLT file\&. +.RE +.PP +\fB\-v\fR +.RS 4 +Verbose mode\&. +.RE +.PP +\fB\-y\fR +.RS 4 +Serial device mode\&. +.RE +.PP +\fB\-b\fR +.RS 4 +Serial device baudrate (Default: 115200)\&. +.RE +.PP +\fB\-e\fR +.RS 4 +Set ECU ID (Default: RECV)\&. +.RE +.SH "EXAMPLES" +.PP +Print received message headers received from a dlt\-daemon running on localhost +.RS 4 +dlt\-receive \-s localhost +.RE +.PP +Print received message headers received from a serila interface +.RS 4 +dlt\-receive \-s \-y /dev/ttySO +.RE +.PP +Store received message headers from a dlt\-daemon to a log file called log\&.dlt and filter them for e\&.g\&. Application ID ABCD and Context ID EFGH (Write:ABCD EFGH as single line to a file claled filter\&.txt) +.RS 4 +dlt\-receive \-s \-o log\&.dlt \-f filter\&.txt localhost +.RE +.SH "EXIT STATUS" +.sp +Non zero is returned in case of failure\&. +.SH "AUTHOR" +.sp +Alexander Wenzel (alexander\&.aw\&.wenzel (at) bmw\&.de) +.SH "RESOURCES" +.sp +Main web site: http://projects\&.genivi\&.org/diagnostic\-log\-trace Mailinglist: https://lists\&.genivi\&.org/mailman/listinfo/genivi\-diagnostic\-log\-and\-trace +.SH "SEE ALSO" +.sp +dlt\-daemon(1) |