man/systemd-path.xml

   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">
   4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
   5
   6 <refentry id="systemd-path"
   7     xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>systemd-path</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-path</refentrytitle>
  16     <manvolnum>1</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-path</refname>
  21     <refpurpose>List and query system and user paths</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>systemd-path</command>
  27       <arg choice="opt" rep="repeat">OPTIONS</arg>
  28       <arg choice="opt" rep="repeat">NAME</arg>
  29     </cmdsynopsis>
  30   </refsynopsisdiv>
  31
  32   <refsect1>
  33     <title>Description</title>
  34
  35     <para><command>systemd-path</command> may be used to query system
  36     and user paths. The tool makes many of the paths described in
  37     <citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  38     available for querying.</para>
  39
  40     <para>When invoked without arguments, a list of known paths and
  41     their current values is shown. When at least one argument is
  42     passed, the path with this name is queried and its value shown.
  43     The variables whose name begins with <literal>search-</literal>
  44     do not refer to individual paths, but instead to a list of
  45     colon-separated search paths, in their order of precedence.</para>
  46   </refsect1>
  47
  48   <refsect1>
  49     <title>Options</title>
  50
  51     <para>The following options are understood:</para>
  52
  53     <variablelist>
  54       <varlistentry>
  55         <term><option>--suffix=</option></term>
  56
  57         <listitem><para>Printed paths are suffixed by the specified string.</para></listitem>
  58       </varlistentry>
  59
  60       <xi:include href="standard-options.xml" xpointer="help" />
  61       <xi:include href="standard-options.xml" xpointer="version" />
  62     </variablelist>
  63
  64   </refsect1>
  65
  66   <refsect1>
  67     <title>Exit status</title>
  68
  69     <para>On success, 0 is returned, a non-zero failure code
  70     otherwise.</para>
  71   </refsect1>
  72
  73   <refsect1>
  74     <title>See Also</title>
  75     <para>
  76       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  77       <citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  78     </para>
  79   </refsect1>
  80
  81 </refentry>