chiark / gitweb /
use correct format types
[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
61                 query system and user paths. The tool makes many of
62                 the paths described in
63                 <citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry>
64                 queriable.</para>
65
66                 <para>When invoked without arguments a list of known
67                 paths and their current values is shown. When at least
68                 one argument is passed the path with this is name is
69                 queried and its value shown. The variables whose name
70                 begins with <literal>search-</literal> don't refer to
71                 individual paths, but instead a to a list of
72                 colon-separated search paths, in their order of
73                 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
86                                 suffixed by the specified
87                                 string.</para></listitem>
88                         </varlistentry>
89
90                         <xi:include href="standard-options.xml" xpointer="help" />
91                         <xi:include href="standard-options.xml" xpointer="version" />
92                 </variablelist>
93
94         </refsect1>
95
96         <refsect1>
97                 <title>Exit status</title>
98
99                 <para>On success, 0 is returned, a non-zero failure
100                 code otherwise.</para>
101         </refsect1>
102
103         <refsect1>
104                 <title>See Also</title>
105                 <para>
106                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
107                         <citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry>
108                 </para>
109         </refsect1>
110
111 </refentry>