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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
========
virtlogd
========
-----------------------------
libvirt log management daemon
-----------------------------
:Manual section: 8
:Manual group: Virtualization Support
.. contents::
SYNOPSIS
========
``virtlogd`` [*OPTION*]...
DESCRIPTION
===========
The ``virtlogd`` program is a server side daemon component of the libvirt
virtualization management system that is used to manage logs from virtual
machine consoles.
This daemon is not used directly by libvirt client applications, rather it
is called on their behalf by ``libvirtd``. By maintaining the logs in a
standalone daemon, the main libvirtd daemon can be restarted without risk
of losing logs. The ``virtlogd`` daemon has the ability to re-exec()
itself upon receiving SIGUSR1, to allow live upgrades without downtime.
The ``virtlogd`` daemon listens for requests on a local Unix domain socket.
OPTIONS
=======
``-h``, ``--help``
Display command line help usage then exit.
``-d``, ``--daemon``
Run as a daemon and write PID file.
``-f``, ``--config`` *FILE*
Use this configuration file, overriding the default value.
``-t``, ``--timeout`` *SECONDS*
Automatically shutdown after *SECONDS* have elapsed with
no active console log.
``-p``, ``--pid-file`` *FILE*
Use this name for the PID file, overriding the default value.
``-v``, ``--verbose``
Enable output of verbose messages.
``-V``, ``--version``
Display version information then exit.
SIGNALS
=======
On receipt of ``SIGUSR1``, ``virtlogd`` will re-exec() its binary, while
maintaining all current logs and clients. This allows for live
upgrades of the ``virtlogd`` service.
FILES
=====
When run as *root*
------------------
* ``@SYSCONFDIR@/libvirt/virtlogd.conf``
The default configuration file used by ``virtlogd``, unless overridden on the
command line using the ``-f`` | ``--config`` option.
* ``@RUNSTATEDIR@/libvirt/virtlogd-sock``
The sockets ``virtlogd`` will use.
* ``@RUNSTATEDIR@/virtlogd.pid``
The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option.
When run as *non-root*
----------------------
* ``$XDG_CONFIG_HOME/libvirt/virtlogd.conf``
The default configuration file used by ``virtlogd``, unless overridden on the
command line using the ``-f`` | ``--config`` option.
* ``$XDG_RUNTIME_DIR/libvirt/virtlogd-sock``
The socket ``virtlogd`` will use.
* ``$XDG_RUNTIME_DIR/libvirt/virtlogd.pid``
The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option.
If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtlogd`` will use
``$HOME/.config``
If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtlogd`` will use
``$HOME/.cache``
EXAMPLES
========
To retrieve the version of ``virtlogd``:
::
# virtlogd --version
virtlogd (libvirt) @VERSION@
To start ``virtlogd``, instructing it to daemonize and create a PID file:
::
# virtlogd -d
# ls -la @RUNSTATEDIR@/virtlogd.pid
-rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtlogd.pid
BUGS
====
Please report all bugs you discover. This should be done via either:
#. the mailing list
`https://libvirt.org/contact.html <https://libvirt.org/contact.html>`_
#. the bug tracker
`https://libvirt.org/bugs.html <https://libvirt.org/bugs.html>`_
Alternatively, you may report bugs to your software distributor / vendor.
AUTHORS
=======
Please refer to the AUTHORS file distributed with libvirt.
COPYRIGHT
=========
Copyright (C) 2006-2015 Red Hat, Inc., and the authors listed in the
libvirt AUTHORS file.
LICENSE
=======
``virtlogd`` is distributed under the terms of the GNU LGPL v2.1+.
This is free software; see the source for copying conditions. There
is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE
SEE ALSO
========
libvirtd(8), `https://libvirt.org/ <https://libvirt.org/>`_
|
