systemd-activate.xml 6.25 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
This file is part of systemd.

Copyright 2013 Zbigniew Jędrzejewski-Szmek

systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

24 25
<refentry id="systemd-activate"
          xmlns:xi="http://www.w3.org/2001/XInclude">
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

  <refentryinfo>
    <title>systemd-activate</title>
    <productname>systemd</productname>

    <authorgroup>
      <author>
        <contrib>Developer</contrib>
        <firstname>Zbigniew</firstname>
        <surname>Jędrzejewski-Szmek</surname>
        <email>zbyszek@in.waw.pl</email>
      </author>
    </authorgroup>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-activate</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-activate</refname>
    <refpurpose>Test socket activation of daemons</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>/usr/lib/systemd/systemd-activate</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="plain"><replaceable>daemon</replaceable></arg>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>systemd-activate</command> can be used to
    launch a socket activated daemon from the command-line for
    testing purposes. It can also be used to launch single instances
    of the daemon per connection (inetd-style).
    </para>

    <para>The daemon to launch and its options should be specifed
    after options intended for <command>systemd-activate</command>.
    </para>

    <para>If the <option>-a</option> option is given, file descriptor
    of the connection will be used as the standard input and output of
    the launched process. Otherwise, standard input and output will be
    inherited, and sockets will be passed through file descriptors 3
    and higher. Sockets passed through <varname>$LISTEN_FDS</varname>
    to <command>systemd-activate</command> will be passed through to
    the dameon, in the original positions. Other sockets specified
    with <option>--listen</option> will use consecutive descriptors.
    </para>
  </refsect1>

  <refsect1>
    <title>Options</title>
    <variablelist>
      <varlistentry>
        <term><option>-l <replaceable>address</replaceable></option></term>
        <term><option>--listen=<replaceable>address</replaceable></option></term>

        <listitem><para>Listen on this <replaceable>address</replaceable>.
        Takes a string like <literal>2000</literal> or
        <literal>127.0.0.1:2001</literal>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-a</option></term>
        <term><option>--accept</option></term>

        <listitem><para>Launch a separate instance of daemon per
        connection and pass the connection socket as standard input
        and standard output.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-E <replaceable>VAR</replaceable><optional>=<replaceable>VALUE</replaceable></optional></option></term>
108
        <term><option>--setenv=<replaceable>VAR</replaceable><optional>=<replaceable>VALUE</replaceable></optional></option></term>
109 110 111

        <listitem><para>Add this variable to the environment of the
        launched process. If <replaceable>VAR</replaceable> is
Michael Biebl's avatar
Michael Biebl committed
112 113
        followed by <literal>=</literal>, assume that it is a
        variable–value pair. Otherwise, obtain the value from the
114 115 116
        environment of <command>systemd-activate</command> itself.
        </para></listitem>
      </varlistentry>
117 118 119

      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
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
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Environment variables</title>
    <variablelist class='environment-variables'>
      <varlistentry>
        <term><varname>$LISTEN_FDS</varname></term>
        <term><varname>$LISTEN_PID</varname></term>

        <listitem><para>See
        <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>$SYSTEMD_LOG_TARGET</varname></term>
        <term><varname>$SYSTEMD_LOG_LEVEL</varname></term>
        <term><varname>$SYSTEMD_LOG_COLOR</varname></term>
        <term><varname>$SYSTEMD_LOG_LOCATION</varname></term>

        <listitem><para>Same as in
        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Example 1</title>

    <programlisting>$ /usr/lib/systemd/systemd-activate -l 2000 -a cat</programlisting>

    <para>This runs an echo server on port 2000.</para>
  </refsect1>

  <refsect1>
    <title>Example 2</title>

    <programlisting>$ /usr/lib/systemd/systemd-activate -l 19531 /usr/lib/systemd/systemd-journal-gatewayd</programlisting>

    <para>This runs a socket activated instance of
    <citerefentry><refentrytitle>systemd-journal-gatewayd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>cat</refentrytitle><manvolnum>1</manvolnum></citerefentry>
    </para>
  </refsect1>
</refentry>