man-pages/man1/dbus-update-activation-environment.1.html
2021-03-31 01:06:50 +01:00

284 lines
6.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of DBUS-UPDATE-ACTIVA</TITLE>
</HEAD><BODY>
<H1>DBUS-UPDATE-ACTIVA</H1>
Section: User Commands (1)<BR>Updated: <BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
dbus-update-activation-environment - update environment used for D-Bus session services
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>dbus-update-activation-environment</B> [--systemd] [--verbose] --all | <I>VAR</I>... | <I>VAR</I>=<I>VAL</I>...
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<B>dbus-update-activation-environment</B>
<DD>updates the list of environment variables used by
<B>dbus-daemon --session</B>
when it activates session services without using
<B>systemd</B>.
<P>
With the
<B>--systemd</B>
option, if an instance of
<B>systemd --user</B>
is available on D-Bus, it also updates the list of environment variables used by
<B>systemd --user</B>
when it activates user services, including D-Bus session services for which
<B>dbus-daemon</B>
has been configured to delegate activation to
<B>systemd</B>. This is very similar to the
<B>import-environment</B>
command provided by
<B><A HREF="/cgi-bin/man/man2html?1+systemctl">systemctl</A></B>(1)).
<P>
Variables that are special to
<B>dbus-daemon</B>
or
<B>systemd</B>
may be set, but their values will be overridden when a service is started. For instance, it is not useful to add
<B>DBUS_SESSION_BUS_ADDRESS</B>
to
<B>dbus-daemon</B>'s activation environment, although it might still be useful to add it to
<B>systemd</B>'s activation environment.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
<B>--all</B>
<DL COMPACT><DT id="2"><DD>
Set all environment variables present in the environment used by
<B>dbus-update-activation-environment</B>.
</DL>
<P>
<B>--systemd</B>
<DL COMPACT><DT id="3"><DD>
Set environment variables for systemd user services as well as for traditional D-Bus session services.
</DL>
<P>
<B>--verbose</B>
<DL COMPACT><DT id="4"><DD>
Output messages to standard error explaining what dbus-update-activation-environment is doing.
</DL>
<P>
<I>VAR</I>
<DL COMPACT><DT id="5"><DD>
If
<I>VAR</I>
is present in the environment of
<B>dbus-update-activation-environment</B>, set it to the same value for D-Bus services. Its value must be UTF-8 (if not, it is skipped with a warning). If
<I>VAR</I>
is not present in the environment, this argument is silently ignored.
</DL>
<P>
<I>VAR</I>=<I>VAL</I>
<DL COMPACT><DT id="6"><DD>
Set
<I>VAR</I>
to
<I>VAL</I>, which must be UTF-8.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
<B>dbus-update-activation-environment</B>
is primarily designed to be used in Linux distributions' X11 session startup scripts, in conjunction with the &quot;user bus&quot; design.
<P>
To propagate
<B>DISPLAY</B>
and
<B>XAUTHORITY</B>
to
<B>dbus-daemon</B>
and, if present,
<B>systemd</B>, and propagate
<B>DBUS_SESSION_BUS_ADDRESS</B>
to
<B>systemd</B>:
<P>
<DL COMPACT><DT id="7"><DD>
<PRE>
dbus-update-activation-environment --systemd \
DBUS_SESSION_BUS_ADDRESS DISPLAY XAUTHORITY
</PRE>
</DL>
<P>
To propagate all environment variables except
<B>XDG_SEAT</B>,
<B>XDG_SESSION_ID</B>
and
<B>XDG_VTNR</B>
to
<B>dbus-daemon</B>
(and, if present,
<B>systemd</B>) for compatibility with legacy X11 session startup scripts:
<P>
<DL COMPACT><DT id="8"><DD>
<PRE>
# in a subshell so the variables remain set in the
# parent script
(
unset XDG_SEAT
unset XDG_SESSION_ID
unset XDG_VTNR
dbus-update-activation-environment --systemd --all
)
</PRE>
</DL>
<P>
<A NAME="lbAG">&nbsp;</A>
<H2>EXIT STATUS</H2>
<P>
<B>dbus-update-activation-environment</B>
exits with status 0 on success, EX_USAGE (64) on invalid command-line options, EX_OSERR (71) if unable to connect to the session bus, or EX_UNAVAILABLE (69) if unable to set the environment variables. Other nonzero exit codes might be added in future versions.
<A NAME="lbAH">&nbsp;</A>
<H2>ENVIRONMENT</H2>
<P>
<B>DBUS_SESSION_BUS_ADDRESS</B>,
<B>XDG_RUNTIME_DIR</B>
and/or
<B>DISPLAY</B>
are used to find the address of the session bus.
<A NAME="lbAI">&nbsp;</A>
<H2>LIMITATIONS</H2>
<P>
<B>dbus-daemon</B>
does not provide a way to unset environment variables after they have been set (although
<B>systemd</B>
does), so
<B>dbus-update-activation-environment</B>
does not offer this functionality either.
<P>
POSIX does not specify the encoding of non-ASCII environment variable names or values and allows them to contain any non-zero byte, but neither
<B>dbus-daemon</B>
nor
<B>systemd</B>
supports environment variables with non-UTF-8 names or values. Accordingly,
<B>dbus-update-activation-environment</B>
assumes that any name or value that appears to be valid UTF-8 is intended to be UTF-8, and ignores other names or values with a warning.
<A NAME="lbAJ">&nbsp;</A>
<H2>BUGS</H2>
<P>
Please send bug reports to the D-Bus bug tracker or mailing list. See
m[blue]<B><A HREF="http://www.freedesktop.org/software/dbus/">http://www.freedesktop.org/software/dbus/</A></B>m[].
<A NAME="lbAK">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+dbus-daemon">dbus-daemon</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?1+systemd">systemd</A></B>(1), the
<B>import-environment</B>
command of
<B><A HREF="/cgi-bin/man/man2html?1+systemctl">systemctl</A></B>(1)
<A NAME="lbAL">&nbsp;</A>
<H2>COPYRIGHT</H2>
<BR>
Copyright &#169; 2015 Collabora Ltd.
<BR>
<P>
This man page is distributed under the same terms as dbus-update-activation-environment (MIT/X11). There is NO WARRANTY, to the extent permitted by law.
<P>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="9"><A HREF="#lbAB">NAME</A><DD>
<DT id="10"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="11"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="12"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="13"><A HREF="#lbAF">EXAMPLES</A><DD>
<DT id="14"><A HREF="#lbAG">EXIT STATUS</A><DD>
<DT id="15"><A HREF="#lbAH">ENVIRONMENT</A><DD>
<DT id="16"><A HREF="#lbAI">LIMITATIONS</A><DD>
<DT id="17"><A HREF="#lbAJ">BUGS</A><DD>
<DT id="18"><A HREF="#lbAK">SEE ALSO</A><DD>
<DT id="19"><A HREF="#lbAL">COPYRIGHT</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:09 GMT, March 31, 2021
</BODY>
</HTML>