systemd-path.xml revision 9a00f57a5ba7ed431e6bac8d8b36518708503b4e
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering<?xml version='1.0'?> <!--*-nxml-*-->
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering<!--
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering This file is part of systemd.
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering Copyright 2014 Lennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering systemd is free software; you can redistribute it and/or modify it
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering under the terms of the GNU Lesser General Public License as published by
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering the Free Software Foundation; either version 2.1 of the License, or
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering (at your option) any later version.
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering systemd is distributed in the hope that it will be useful, but
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering WITHOUT ANY WARRANTY; without even the implied warranty of
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering Lesser General Public License for more details.
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering You should have received a copy of the GNU Lesser General Public License
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering along with systemd; If not, see <http://www.gnu.org/licenses/>.
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering-->
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering<refentry id="systemd-path"
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering xmlns:xi="http://www.w3.org/2001/XInclude">
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <refentryinfo>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <title>systemd-path</title>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <productname>systemd</productname>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <authorgroup>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <author>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <contrib>Developer</contrib>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <firstname>Lennart</firstname>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <surname>Poettering</surname>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <email>lennart@poettering.net</email>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </author>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </authorgroup>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </refentryinfo>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <refmeta>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <refentrytitle>systemd-path</refentrytitle>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <manvolnum>1</manvolnum>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </refmeta>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <refnamediv>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <refname>systemd-path</refname>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <refpurpose>List and query system and user paths</refpurpose>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </refnamediv>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <refsynopsisdiv>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <cmdsynopsis>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <command>systemd-path <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </cmdsynopsis>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </refsynopsisdiv>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <refsect1>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <title>Description</title>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <para><command>systemd-path</command> may be used to
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering query system and user paths. The tool makes many of
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering the paths described in
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering queriable.</para>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <para>When invoked without arguments a list of known
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering paths and their current values is shown. When at least
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering one argument is passed the path with this is name is
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering queried and its value shown. The variables whose name
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering begins with <literal>search-</literal> don't refer to
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering individual paths, but instead a to a list of
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering colon-separated search paths, in their order of
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering precedence.</para>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </refsect1>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <refsect1>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <title>Options</title>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <para>The following options are understood:</para>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <variablelist>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <varlistentry>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <term><option>--suffix=</option></term>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <listitem><para>The printed paths are
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering suffixed by the specified
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering string.</para></listitem>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </varlistentry>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <xi:include href="standard-options.xml" xpointer="help" />
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <xi:include href="standard-options.xml" xpointer="version" />
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </variablelist>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </refsect1>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <refsect1>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <title>Exit status</title>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <para>On success, 0 is returned, a non-zero failure
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering code otherwise.</para>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </refsect1>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <refsect1>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <title>See Also</title>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <para>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering <citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </para>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering </refsect1>
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering
9a00f57a5ba7ed431e6bac8d8b36518708503b4eLennart Poettering</refentry>