man/user-system-options.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE variablelist PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <variablelist>
   7   <varlistentry id='user'>
   8     <term><option>--user</option></term>
   9
  10     <listitem id='user-text'>
  11       <para>Talk to the service manager of the calling user,
  12       rather than the service manager of the system.</para>
  13     </listitem>
  14   </varlistentry>
  15
  16   <varlistentry id='system'>
  17     <term><option>--system</option></term>
  18
  19     <listitem id='system-text'>
  20       <para>Talk to the service manager of the system. This is the
  21       implied default.</para>
  22     </listitem>
  23   </varlistentry>
  24
  25   <varlistentry id='host'>
  26     <term><option>-H</option></term>
  27     <term><option>--host=</option></term>
  28
  29     <listitem id='host-text'>
  30       <para>Execute the operation remotely. Specify a hostname, or a
  31       username and hostname separated by <literal>@</literal>, to
  32       connect to. The hostname may optionally be suffixed by a
  33       port ssh is listening on, separated by <literal>:</literal>, and then a
  34       container name, separated by <literal>/</literal>, which
  35       connects directly to a specific container on the specified
  36       host. This will use SSH to talk to the remote machine manager
  37       instance. Container names may be enumerated with
  38       <command>machinectl -H
  39       <replaceable>HOST</replaceable></command>. Put IPv6 addresses in brackets.</para>
  40     </listitem>
  41   </varlistentry>
  42
  43   <varlistentry id='machine'>
  44     <term><option>-M</option></term>
  45     <term><option>--machine=</option></term>
  46
  47     <listitem id='machine-text'>
  48       <para>Execute operation on a local container. Specify a container name to connect to, optionally
  49       prefixed by a user name to connect as and a separating <literal>@</literal> character. If the special
  50       string <literal>.host</literal> is used in place of the container name, a connection to the local
  51       system is made (which is useful to connect to a specific user's user bus: <literal>--user
  52       --machine=lennart@.host</literal>). If the <literal>@</literal> syntax is not used, the connection is
  53       made as root user. If the <literal>@</literal> syntax is used either the left hand side or the right hand
  54       side may be omitted (but not both) in which case the local user name and <literal>.host</literal> are
  55       implied.</para>
  56     </listitem>
  57   </varlistentry>
  58
  59   <varlistentry id='capsule'>
  60     <term><option>-C</option></term>
  61     <term><option>--capsule=</option></term>
  62
  63     <listitem id='capsule-text'>
  64       <para>Execute operation on a capsule. Specify a capsule name to connect to. See
  65       <citerefentry><refentrytitle>capsule@.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
  66       details about capsules.</para>
  67     </listitem>
  68   </varlistentry>
  69 </variablelist>