From 5eb2489014671823bb7ae579f738a7a208eae58d Mon Sep 17 00:00:00 2001 From: Christoph Lipka Date: Thu, 20 Oct 2016 11:15:26 +0900 Subject: doc: Documenatation update Signed-off-by: Christoph Lipka --- doc/dlt-logstorage-ctrl.1 | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) (limited to 'doc/dlt-logstorage-ctrl.1') diff --git a/doc/dlt-logstorage-ctrl.1 b/doc/dlt-logstorage-ctrl.1 index d35a6ea..ac6554d 100644 --- a/doc/dlt-logstorage-ctrl.1 +++ b/doc/dlt-logstorage-ctrl.1 @@ -7,7 +7,7 @@ .\" Source: \ \& .\" Language: English .\" -.TH "DLT\-LOGSTORAGE\-CTR" "1" "02/23/2016" "\ \&" "\ \&" +.TH "DLT\-LOGSTORAGE\-CTRL" "1" "02/23/2016" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -31,7 +31,7 @@ dlt-logstorage-ctrl \- Trigger DLT Daemon to start/stop using an offline logstorage device .SH "SYNOPSIS" .sp -\fBdlt\-logstorage\-ctrl\fR [\-h] [\-c ctype] [\-d dev] [\-e ecu] [\-t timeout] +\fBdlt\-logstorage\-ctrl\fR [\-h] [\-c ctype] [\-p path] [\-e ecu] [\-p] [\-t timeout] [\-v] .SH "DESCRIPTION" .sp Send a trigger to DLT Daemon to connect/disconnect a certain offline logstorage device @@ -49,7 +49,12 @@ Specify connection type: connect = 1, disconnect = 0\&. .PP \fB\-d\fR .RS 4 -Specify device [1 \&.\&. DLT_OFFLINE_LOGSTORAGE_MAX_DEVICES]\&. +Run as daemon: prop = use proprietary handler\&. +.RE +.PP +\fB\-p\fR +.RS 4 +Mount point path\&. .RE .PP \fB\-e\fR @@ -61,27 +66,44 @@ Specify the ECU ID\&. Default is: ECU1\&. .RS 4 Specify connection timeout\&. Default is: 10s\&. .RE +.PP +\fB\-v\fR +.RS 4 +Print verbose output\&. +.RE .SH "EXAMPLES" .sp -Activate the offline logstorage device mounted on /tmp/dltlogs/dltlogsdev1 +Activate the offline logstorage device mounted on /mnt/dltlog\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +dlt\-logstorage\-ctrl \-c 1 \-p /mnt/dltlog\&. +.fi +.if n \{\ +.RE +.\} +.sp +Deactivate the offline logstorage device mounted on /mnt/dltlog\&. .sp .if n \{\ .RS 4 .\} .nf -dlt\-logstorage\-ctrl \-c 1 \-d 1 +dlt\-logstorage\-ctrl \-c 0 \-p /mnt/dltlog\&. .fi .if n \{\ .RE .\} .sp -Deactivate the offline logstorage device mounted on /tmp/dltlogs/dltlogsdev2 +Run logstorage control application as daemon listen to udev events\&. .sp .if n \{\ .RS 4 .\} .nf -dlt\-logstorage\-ctrl \-c 0 \-d 2 +dlt\-logstorage\-ctrl -d\&. .fi .if n \{\ .RE -- cgit v1.2.1