summaryrefslogtreecommitdiff
path: root/doc/dlt-daemon.1.md
diff options
context:
space:
mode:
authorChristoph Lipka <clipka@users.noreply.github.com>2019-02-12 10:32:13 +0100
committerGitHub <noreply@github.com>2019-02-12 10:32:13 +0100
commit1713e3913722d1222c968ca53326865d23a2b0ab (patch)
tree477489d98c7694fd8937debadb2fcf61b2f7fa3e /doc/dlt-daemon.1.md
parent4c4cc967ad46abae60f2f9bf5e47b65e8bcbb4b1 (diff)
downloadDLT-daemon-1713e3913722d1222c968ca53326865d23a2b0ab.tar.gz
doc: Move all man pages to markdown files (#102)v2.18.1
All manpages have been removed, because they will be autogenerated from markdown files using pandoc.
Diffstat (limited to 'doc/dlt-daemon.1.md')
-rw-r--r--doc/dlt-daemon.1.md76
1 files changed, 76 insertions, 0 deletions
diff --git a/doc/dlt-daemon.1.md b/doc/dlt-daemon.1.md
new file mode 100644
index 0000000..30fbbf1
--- /dev/null
+++ b/doc/dlt-daemon.1.md
@@ -0,0 +1,76 @@
+% DLT-DAEMON(1)
+
+# NAME
+
+**dlt-daemon** - Diagnostic Log and Trace daemon
+
+# SYNOPSIS
+
+**dlt-daemon** \[**-h**\] \[**-d**\] \[**-c** filename\] \[**-t** directory\] \[**-p** port\]
+
+# DESCRIPTION
+
+The DLT daemon is the central place where logs and traces are gathered
+from different applications, stored temporarily or permanently and
+transferred to a DLT client application, which can run directly on the
+GENIVI system or more likely on a external tester device.
+
+## OPTIONS
+
+-h
+
+: Display a short help text.
+
+-d
+
+: Daemonize, needed in System V init systems.
+
+-c
+
+: Load an alternative configuration file. By default the configuration file /etc/dlt.conf is loaded.
+
+-t
+
+: Directory for local fifo and user-pipes (Default: /tmp).
+ Applications wanting to connect to a daemon using a custom directory need to be started with the environment variable DLT_PIPE_DIR set appropriately.
+
+-p
+
+: Port to monitor for incoming requests (Default: 3490)
+ Applications wanting to connect to a daemon using a custom
+ port need to be started with the environment variable
+ DLT_DAEMON_TCP_PORT set appropriately.
+
+# EXAMPLES
+
+Start DLT daemon in background mode:
+ **dlt-daemon -d**
+
+Start DLT daemon with own configuration:
+ **dlt-daemon -c ~/my-dlt-configuration.cfg**
+
+Start DLT daemon with custom pipes directory:
+ **dlt-daemon -t ~/dlt_pipes**
+
+Start DLT daemon listening on custom port 3500:
+ **dlt-daemon -p 3500**
+
+# EXIT STATUS
+
+Non zero is returned in case of failure.
+
+# AUTHOR
+
+Alexander Wenzel (alexander.aw.wenzel (at) bmw (dot) de)
+
+# COPYRIGHT
+
+Copyright (C) 2016 BMW AG. License MPL-2.0: Mozilla Public License version 2.0 <http://mozilla.org/MPL/2.0/>.
+
+# BUGS
+
+See Github issue: <https://github.com/GENIVI/dlt-daemon/issues>
+
+# SEE ALSO
+
+**dlt.conf(5)**, **dlt-system(1)**