summaryrefslogtreecommitdiff
path: root/doc/dlt-passive-node-ctrl.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/dlt-passive-node-ctrl.1')
-rw-r--r--doc/dlt-passive-node-ctrl.1117
1 files changed, 117 insertions, 0 deletions
diff --git a/doc/dlt-passive-node-ctrl.1 b/doc/dlt-passive-node-ctrl.1
new file mode 100644
index 0000000..919182d
--- /dev/null
+++ b/doc/dlt-passive-node-ctrl.1
@@ -0,0 +1,117 @@
+'\" t
+.\" Title: dlt-passive-node-ctrl
+.\" Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\" Date: 10/19/2016
+.\" Manual: \ \&
+.\" Source: \ \&
+.\" Language: English
+.\"
+.TH "DLT\-PASSIVE\-NODE\-CTRL" "1" "10/19/2016" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * 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-passive-node-ctrl \- Send a trigger to DLT daemon to (dis)connect a passive node or get current passive node status
+.SH "SYNOPSIS"
+.sp
+\fBdlt\-passive\-node\-ctrl\fR [\-h] [\-c ctype] [\-n ecu] [\-s] [\-t timeout] [\-v]
+.SH "DESCRIPTION"
+.sp
+Send a trigger to DLT daemon to (dis)connect a passive node or get current passive node status
+.SH "OPTIONS"
+.PP
+\fB\-h\fR
+.RS 4
+Display a short help text\&.
+.RE
+.PP
+\fB\-c\fR
+.RS 4
+Specify connection type: connect = 1, disconnect = 0\&.
+.RE
+.PP
+\fB\-n\fR
+.RS 4
+Passive node identifier. E.g. ECU2\&.
+.RE
+.PP
+\fB\-s\fR
+.RS 4
+Show passive nodes connection status\&.
+.RE
+.PP
+\fB\-t\fR
+.RS 4
+Specify connection timeout\&. Default is: 10s\&.
+.RE
+.PP
+\fB\-v\fR
+.RS 4
+Print verbose output\&.
+.RE
+.SH "EXAMPLES"
+.sp
+Get status about connected passives nodes\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+dlt\-passive\-node\-ctrl \-s\&.
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Connect to passive node ECU2\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+dlt\-passive\-node\-ctrl \-c 1 \-n ECU2\&.
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Disconnect to passive node ECU2\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+dlt\-passive\-node\-ctrl \-c 0 \-n ECU2\&.
+.fi
+.if n \{\
+.RE
+.\}
+.SH "EXIT STATUS"
+.sp
+Non zero is returned in case of failure\&.
+.SH "AUTHOR"
+.sp
+Christoph Lipka (clipka (at) jp\&.adit\-jv\&.com)l
+.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)