1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 This file is part of systemd.
8 Copyright 2013 Zbigniew Jędrzejewski-Szmek
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id="systemd-activate">
27 <title>systemd-activate</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Zbigniew</firstname>
34 <surname>Jędrzejewski-Szmek</surname>
35 <email>zbyszek@in.waw.pl</email>
41 <refentrytitle>systemd-activate</refentrytitle>
42 <manvolnum>8</manvolnum>
46 <refname>systemd-activate</refname>
47 <refpurpose>Test socket activation of daemons</refpurpose>
52 <command>/usr/lib/systemd/systemd-activate</command>
53 <arg choice="opt" rep="repeat">OPTIONS</arg>
54 <arg choice="plain"><replaceable>daemon</replaceable></arg>
55 <arg choice="opt" rep="repeat">OPTIONS</arg>
60 <title>Description</title>
62 <para><command>systemd-activate</command> can be used to
63 launch a socket activated daemon from the command-line for
64 testing purposes. It can also be used to launch single instances
65 of the daemon per connection (inetd-style).
68 <para>The daemon to launch and its options should be specifed
69 after options intended for <command>systemd-activate</command>.
72 <para>If the <option>-a</option> option is given, file descriptor
73 of the connection will be used as the standard input and output of
74 the launched process. Otherwise, standard input and output will be
75 inherited, and sockets will be passed through file descriptors 3
76 and higher. Sockets passed through <varname>$LISTEN_FDS</varname>
77 to <command>systemd-activate</command> will be passed through to
78 the dameon, in the original positions. Other sockets specified
79 with <option>--listen</option> will use consecutive descriptors.
84 <title>Options</title>
87 <term><option>--help</option></term>
88 <term><option>-h</option></term>
90 <listitem><para>Prints a short help
91 text and exits.</para></listitem>
95 <term><option>--version</option></term>
97 <listitem><para>Prints a short version
98 string and exits.</para></listitem>
102 <term><option>-l <replaceable>address</replaceable></option></term>
103 <term><option>--listen=<replaceable>address</replaceable></option></term>
105 <listitem><para>Listen on this <replaceable>address</replaceable>.
106 Takes a string like <literal>2000</literal> or
107 <literal>127.0.0.1:2001</literal>.</para>
112 <term><option>-a</option></term>
113 <term><option>--accept</option></term>
115 <listitem><para>Launch a separate instance of daemon per
116 connection and pass the connection socket as standard input
117 and standard output.</para></listitem>
121 <term><option>-E <replaceable>VAR</replaceable><optional>=<replaceable>VALUE</replaceable></optional></option></term>
122 <term><option>--setenv=<replaceable>VAR</replaceable><optional>=<replaceable>VALUE</replaceable></optional></option></term>
124 <listitem><para>Add this variable to the environment of the
125 launched process. If <replaceable>VAR</replaceable> is
126 followed by <literal>=</literal>, assume that it is a
127 variable–value pair. Otherwise, obtain the value from the
128 environment of <command>systemd-activate</command> itself.
135 <title>Environment variables</title>
136 <variablelist class='environment-variables'>
138 <term><varname>$LISTEN_FDS</varname></term>
139 <term><varname>$LISTEN_PID</varname></term>
142 <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
146 <term><varname>$SYSTEMD_LOG_TARGET</varname></term>
147 <term><varname>$SYSTEMD_LOG_LEVEL</varname></term>
148 <term><varname>$SYSTEMD_LOG_COLOR</varname></term>
149 <term><varname>$SYSTEMD_LOG_LOCATION</varname></term>
151 <listitem><para>Same as in
152 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem>
158 <title>Example 1</title>
160 <programlisting>$ /usr/lib/systemd/systemd-activate -l 2000 -a cat</programlisting>
162 <para>This runs an echo server on port 2000.</para>
166 <title>Example 2</title>
168 <programlisting>$ /usr/lib/systemd/systemd-activate -l 19531 /usr/lib/systemd/systemd-journal-gatewayd</programlisting>
170 <para>This runs a socket activated instance of
171 <citerefentry><refentrytitle>systemd-journal-gatewayd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
175 <title>See Also</title>
177 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
178 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
179 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
180 <citerefentry><refentrytitle>cat</refentrytitle><manvolnum>1</manvolnum></citerefentry>