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 <!ENTITY % entities SYSTEM "custom-entities.ent" >
   5 %entities;
   6 ]>
   7
   8 <!--
   9   This file is part of systemd.
  10
  11   Copyright 2014 Lennart Poettering
  12
  13   systemd is free software; you can redistribute it and/or modify it
  14   under the terms of the GNU Lesser General Public License as published by
  15   the Free Software Foundation; either version 2.1 of the License, or
  16   (at your option) any later version.
  17
  18   systemd is distributed in the hope that it will be useful, but
  19   WITHOUT ANY WARRANTY; without even the implied warranty of
  20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21   Lesser General Public License for more details.
  22
  23   You should have received a copy of the GNU Lesser General Public License
  24   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  25 -->
  26
  27 <refentry id="systemd-path"
  28     xmlns:xi="http://www.w3.org/2001/XInclude">
  29
  30   <refentryinfo>
  31     <title>systemd-path</title>
  32     <productname>systemd</productname>
  33
  34     <authorgroup>
  35       <author>
  36         <contrib>Developer</contrib>
  37         <firstname>Lennart</firstname>
  38         <surname>Poettering</surname>
  39         <email>lennart@poettering.net</email>
  40       </author>
  41     </authorgroup>
  42   </refentryinfo>
  43
  44   <refmeta>
  45     <refentrytitle>systemd-path</refentrytitle>
  46     <manvolnum>1</manvolnum>
  47   </refmeta>
  48
  49   <refnamediv>
  50     <refname>systemd-path</refname>
  51     <refpurpose>List and query system and user paths</refpurpose>
  52   </refnamediv>
  53
  54   <refsynopsisdiv>
  55     <cmdsynopsis>
  56       <command>systemd-path <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
  57     </cmdsynopsis>
  58   </refsynopsisdiv>
  59
  60   <refsect1>
  61     <title>Description</title>
  62
  63     <para><command>systemd-path</command> may be used to query system
  64     and user paths. The tool makes many of the paths described in
  65     <citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  66     queriable.</para>
  67
  68     <para>When invoked without arguments a list of known paths and
  69     their current values is shown. When at least one argument is
  70     passed the path with this is name is queried and its value shown.
  71     The variables whose name begins with <literal>search-</literal>
  72     don't refer to individual paths, but instead a to a list of
  73     colon-separated search paths, in their order of precedence.</para>
  74   </refsect1>
  75
  76   <refsect1>
  77     <title>Options</title>
  78
  79     <para>The following options are understood:</para>
  80
  81     <variablelist>
  82       <varlistentry>
  83         <term><option>--suffix=</option></term>
  84
  85         <listitem><para>The printed paths are suffixed by the
  86         specified string.</para></listitem>
  87       </varlistentry>
  88
  89       <xi:include href="standard-options.xml" xpointer="help" />
  90       <xi:include href="standard-options.xml" xpointer="version" />
  91     </variablelist>
  92
  93   </refsect1>
  94
  95   <refsect1>
  96     <title>Exit status</title>
  97
  98     <para>On success, 0 is returned, a non-zero failure code
  99     otherwise.</para>
 100   </refsect1>
 101
 102   <refsect1>
 103     <title>See Also</title>
 104     <para>
 105       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 106       <citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 107     </para>
 108   </refsect1>
 109
 110 </refentry>