doc/dlt-receive.1


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

'\" t
.\"     Title: dlt-receive
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 05/12/2015
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "DLT\-RECEIVE" "1" "05/12/2015" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * 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"
.sp
\fBdlt\-receive\fR [\-h] [\-a] [\-x] [\-m] [\-s] [\-o filename] [\-c limit] [\-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\-c\fR
.RS 4
Set limit when storing messages in file\&. When limit is reached, a new file is opened\&. Use K,M,G as suffix to specify kilo\-, mega\-, giga\-bytes respectively, e\&.g\&. 1M for one megabyte (Default: unlimited)\&.
.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 called filter\&.txt)
.RS 4
dlt\-receive \-s \-o log\&.dlt \-f filter\&.txt localhost
.RE
.PP
Store incoming messages in file(s) and restrict file sizes to 1 megabyte\&. If limit is reached, log\&.dlt will be renamed into log\&.0\&.dlt, log\&.1\&.dlt, \&... No files will be overwritten in this mode
.RS 4
dlt\-receive \-o log\&.dlt \-c 1M localhost
.RE
.SH "EXIT STATUS"
.sp
Non zero is returned in case of failure\&.
.SH "NOTES"
.sp
Be aware that dlt\-receive will never delete any files\&. Instead, it creates a new file\&.
.SH "AUTHOR"
.sp
Alexander Wenzel (alexander\&.aw\&.wenzel (at) bmw\&.de)
.SH "COPYRIGHT"
.sp
Copyright \(co 2015 BMW AG\&. License MPL\-2\&.0: Mozilla Public License version 2\&.0 http://mozilla\&.org/MPL/2\&.0/\&.
.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)