summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStefan Vacek <stefan.vacek@intel.com>2015-08-26 13:59:13 +0200
committerAlexander Wenzel <Alexander.AW.Wenzel@bmw.de>2015-10-07 10:35:09 +0200
commit133a8bd48b42bb4714ad4472c89277db6dd4f88d (patch)
tree83b5e3602c83ab5213a84b556b6ef95ea02c8d8c /doc
parentc7d765971913568a7d701bfb8a8444bc882ccbf1 (diff)
downloadDLT-daemon-133a8bd48b42bb4714ad4472c89277db6dd4f88d.tar.gz
Restrict dlt-receive to write max. n-bytes
- dlt-receive gets a new parameter to restrict the maximum size of the written file. When the limit is exceeded, a new file is opened - testscript (bash) in src/tests provided to demonstrate functionality Signed-off-by: Stefan Vacek <stefan.vacek@intel.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/dlt-receive.117
-rw-r--r--doc/dlt-receive.1.txt14
2 files changed, 27 insertions, 4 deletions
diff --git a/doc/dlt-receive.1 b/doc/dlt-receive.1
index 9efbbca..5f1665b 100644
--- a/doc/dlt-receive.1
+++ b/doc/dlt-receive.1
@@ -31,7 +31,7 @@
dlt-receive \- Console based client for DLT Logging
.SH "SYNOPSIS"
.sp
-\fBdlt\-receive\fR [\-h] [\-a] [\-x] [\-m] [\-s][\-o filename] [\-v] [\-y] [\-b baudrate] [\-e ecuid]hostname/serial_device_name
+\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\&.
@@ -67,6 +67,11 @@ Print DLT file; only headers\&.
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\&.
@@ -98,13 +103,21 @@ Print received message headers received from a serila interface
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)
+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)
diff --git a/doc/dlt-receive.1.txt b/doc/dlt-receive.1.txt
index 4f1d933..25a876d 100644
--- a/doc/dlt-receive.1.txt
+++ b/doc/dlt-receive.1.txt
@@ -8,7 +8,7 @@ dlt-receive - Console based client for DLT Logging
SYNOPSIS
--------
-*dlt-receive* [-h] [-a] [-x] [-m] [-s][-o filename] [-v] [-y] [-b baudrate] [-e ecuid]hostname/serial_device_name
+*dlt-receive* [-h] [-a] [-x] [-m] [-s] [-o filename] [-c limit] [-v] [-y] [-b baudrate] [-e ecuid] hostname/serial_device_name
DESCRIPTION
-----------
@@ -34,6 +34,9 @@ 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.
@@ -54,13 +57,20 @@ Print received message headers received from a dlt-daemon running on 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 claled filter.txt)::
+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)