summaryrefslogtreecommitdiff
path: root/doc/dlt-receive.1.txt
blob: 30513aa1d9f6cc9ca603954b439d2deb5244049f (plain)
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
DLT-RECEIVE(1)
==============
:doctype: manpage

NAME
----
dlt-receive - Console based client for DLT Logging

SYNOPSIS
--------
*dlt-receive* [-h] [-a] [-x] [-m] [-s] [-o filename] [-c limit] [-v] [-y] [-b baudrate] [-e ecuid] [-f filterfile] hostname/serial_device_name

DESCRIPTION
-----------
Receive DLT messages from DLT daemon and print or store the messages.

OPTIONS
-------
*-h*::
    Display a short help text.

*-a*::
    Print DLT file; payload as ASCII.

*-x*::
Print DLT file; payload as hex.

*-m*::
Print DLT file; payload as hex and ASCII.

*-s*::
Print DLT file; only headers.

*-o*::
Output messages in new DLT file.

*-c*::
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).

*-v*::
Verbose mode.

*-y*::
Serial device mode.

*-b*::
Serial device baudrate (Default: 115200).

*-e*::
Set ECU ID (Default: RECV).

*-f*::
    Enable filtering of messages.

EXAMPLES
--------
Print received message headers received from a dlt-daemon running on localhost::
    dlt-receive -s localhost

Print received message headers received from a serila interface::
    dlt-receive -s -y /dev/ttySO

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)::
    dlt-receive -s -o log.dlt -f filter.txt localhost
    
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::
    dlt-receive -o log.dlt -c 1M localhost

EXIT STATUS
-----------
Non zero is returned in case of failure.

NOTES
-----
Be aware that dlt-receive will never delete any files. Instead, it creates a new file.

AUTHOR
------
Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)

COPYRIGHT
---------
Copyright (C) 2015 BMW AG. License MPL-2.0: Mozilla Public License version 2.0 <http://mozilla.org/MPL/2.0/>.

RESOURCES
---------
Main web site: <http://projects.genivi.org/diagnostic-log-trace> +
Mailinglist: <https://lists.genivi.org/mailman/listinfo/genivi-diagnostic-log-and-trace>

SEE ALSO
--------
dlt-daemon(1)