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