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