Merge pull request #8025 from sourcejedi/pid1_journal_or2

[thirdparty/systemd.git] / man / user-system-options.xml

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
          "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

<!--
  SPDX-License-Identifier: LGPL-2.1+

  This file is part of systemd.

  Copyright 2014 Zbigniew Jędrzejewski-Szmek
  Copyright 2014 Lennart Poettering

  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/>.
-->

<variablelist>
  <varlistentry id='user'>
    <term><option>--user</option></term>

    <listitem id='user-text'>
      <para>Talk to the service manager of the calling user,
      rather than the service manager of the system.</para>
    </listitem>
  </varlistentry>

  <varlistentry id='system'>
    <term><option>--system</option></term>

    <listitem id='system-text'>
      <para>Talk to the service manager of the system. This is the
      implied default.</para>
    </listitem>
  </varlistentry>

  <varlistentry id='host'>
    <term><option>-H</option></term>
    <term><option>--host=</option></term>

    <listitem id='host-text'>
      <para>Execute the operation remotely. Specify a hostname, or a
      username and hostname separated by <literal>@</literal>, to
      connect to. The hostname may optionally be suffixed by a
      container name, separated by <literal>:</literal>, which
      connects directly to a specific container on the specified
      host. This will use SSH to talk to the remote machine manager
      instance. Container names may be enumerated with
      <command>machinectl -H
      <replaceable>HOST</replaceable></command>.</para>
    </listitem>
  </varlistentry>

  <varlistentry id='machine'>
    <term><option>-M</option></term>
    <term><option>--machine=</option></term>

    <listitem id='machine-text'>
      <para>Execute operation on a local container. Specify a
      container name to connect to.</para>
    </listitem>
  </varlistentry>
</variablelist>