docs/kf5-config/man-kf5-config.1.docbook

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003 <!ENTITY % English "INCLUDE">
0004 ]>
0005
0006 <refentry lang="&language;">
0007 <refentryinfo>
0008 <title>kf5-config User's Manual</title>
0009 <author>
0010 <firstname>Stephan</firstname>
0011 <surname>Kulow</surname>
0012 <affiliation><address><email>coolo@kde.org</email></address></affiliation>
0013 </author>
0014 <date>2015-07-31</date>
0015 <releaseinfo>Frameworks 5.13</releaseinfo>
0016 <productname>KDE Frameworks</productname>
0017 </refentryinfo>
0018
0019 <refmeta>
0020 <refentrytitle><command>kf5-config</command></refentrytitle>
0021 <manvolnum>1</manvolnum>
0022 </refmeta>
0023
0024 <refnamediv>
0025 <refname><command>kf5-config</command></refname>
0026 <refpurpose>Prints &Qt; and &frameworks; installation paths</refpurpose>
0027 </refnamediv>
0028
0029 <refsynopsisdiv>
0030 <cmdsynopsis>
0031 <command>kf5-config</command>
0032 <arg>--expandvars</arg>
0033 <arg>--prefix</arg>
0034 <arg>--exec-prefix</arg>
0035 <arg>--libsuffix</arg>
0036 <arg>--localprefix</arg>
0037 <arg>--version</arg>
0038 <arg>--kde-version</arg>
0039 <arg>--types</arg>
0040 <arg>--path <replaceable>type</replaceable></arg>
0041 <arg>--userpath <replaceable>type</replaceable></arg>
0042 <arg>--install <replaceable>type</replaceable></arg>
0043 <arg>--qt-prefix</arg>
0044 <arg>--qt-binaries</arg>
0045 <arg>--qt-libraries</arg>
0046 <arg>--qt-plugins</arg>
0047
0048 </cmdsynopsis>
0049 </refsynopsisdiv>
0050
0051 <refsect1>
0052 <title>Description</title>
0053 <para><command>kf5-config</command> is a command line program used to retrieve information
0054 about &frameworks; installation or user paths.</para>
0055
0056 <para>Use this program to determine where the various aspects of the &frameworks;
0057 installation reside on your system.
0058 </para>
0059
0060 <note><para><command>kf5-config</command> is mostly a deprecated replacement for kde4-config, while the
0061 recommended tool to use instead is <command>qtpaths</command> (which is shipped with &Qt;).
0062 </para></note>
0063 </refsect1>
0064
0065 <refsect1>
0066 <title>Options</title>
0067 <variablelist>
0068
0069 <varlistentry>
0070 <term><option>--expandvars</option></term>
0071 <listitem>
0072 <para>Expand ${prefix} and ${exec_prefix} in output.</para>
0073 </listitem>
0074 </varlistentry>
0075
0076 <varlistentry>
0077 <term><option>--prefix</option></term>
0078 <listitem>
0079 <para>Compiled in prefix for &frameworks; libraries.</para>
0080 </listitem>
0081 </varlistentry>
0082
0083 <varlistentry>
0084 <term><option>--exec-prefix</option></term>
0085 <listitem>
0086 <para>Compiled in exec_prefix for &frameworks; libraries.</para>
0087 </listitem>
0088 </varlistentry>
0089
0090 <varlistentry>
0091 <term><option>--libsuffix</option></term>
0092 <listitem>
0093 <para>Compiled in library path suffix.</para>
0094 </listitem>
0095 </varlistentry>
0096
0097 <varlistentry>
0098 <term><option>--localprefix</option></term>
0099 <listitem>
0100 <para>Prefix in $<envar>HOME</envar> used to write files.</para>
0101 </listitem>
0102 </varlistentry>
0103
0104 <varlistentry>
0105 <term><option>--version</option></term>
0106 <listitem>
0107 <para>Version of &Qt; and compiled in version string for &frameworks; libraries and <command>kf5-config</command>.</para>
0108 </listitem>
0109 </varlistentry>
0110
0111 <varlistentry>
0112 <term><option>--kde-version</option></term>
0113 <listitem>
0114 <para>Compiled in version string for &frameworks; libraries.</para>
0115 </listitem>
0116 </varlistentry>
0117
0118 <varlistentry>
0119 <term><option>--types</option></term>
0120 <listitem>
0121 <para>Print a list of all available &kde; resource types.</para>
0122 </listitem>
0123 </varlistentry>
0124
0125 <varlistentry>
0126 <term><option>--path <replaceable>type</replaceable></option></term>
0127 <listitem>
0128 <para>Search path for the specified <replaceable>type</replaceable>.</para>
0129 </listitem>
0130 </varlistentry>
0131
0132 <varlistentry>
0133 <term><option>--userpath <replaceable>type</replaceable></option></term>
0134 <listitem>
0135 <para>User paths for the types: desktop|document</para>
0136 </listitem>
0137 </varlistentry>
0138
0139 <varlistentry>
0140 <term><option>--install <replaceable>type</replaceable></option></term>
0141 <listitem>
0142 <para>Prefix to install resource files to.</para>
0143 </listitem>
0144 </varlistentry>
0145
0146 <varlistentry>
0147 <term><option>--qt-prefix</option></term>
0148 <listitem>
0149 <para>Installation prefix for &Qt;.</para>
0150 </listitem>
0151 </varlistentry>
0152
0153 <varlistentry>
0154 <term><option>--qt-binaries</option></term>
0155 <listitem>
0156 <para>Location of installed &Qt; binaries.</para>
0157 </listitem>
0158 </varlistentry>
0159
0160 <varlistentry>
0161 <term><option>--qt-libraries</option></term>
0162 <listitem>
0163 <para>Location of installed &Qt; libraries.</para>
0164 </listitem>
0165 </varlistentry>
0166
0167 <varlistentry>
0168 <term><option>--qt-plugins</option></term>
0169 <listitem>
0170 <para>Location of installed &Qt; plugins.</para>
0171 </listitem>
0172 </varlistentry>
0173
0174 </variablelist>
0175 </refsect1>
0176
0177 <refsect1>
0178 <title>Examples</title>
0179
0180 <para>Print the top-level &frameworks; installation directory:</para>
0181 <para>
0182 <prompt>&percnt;</prompt><userinput> <command>kf5-config --prefix</command>
0183 </userinput>
0184 </para>
0185
0186 <para>Print a list of all resource types:</para>
0187
0188 <para>
0189 <prompt>&percnt;</prompt><userinput> <command>kf5-config --types</command>
0190 </userinput>
0191 </para>
0192
0193 <para>Print the installed wallpaper path:</para>
0194
0195 <para>
0196 <prompt>&percnt;</prompt><userinput> <command>kf5-config --path wallpaper</command>
0197 </userinput>
0198 </para>
0199
0200 </refsect1>
0201
0202 <refsect1>
0203 <title>See Also</title>
0204 <para>kf5options(7)</para>
0205 </refsect1>
0206
0207 <refsect1>
0208 <title>Bugs</title>
0209 <para>None known.</para>
0210 </refsect1>
0211
0212 </refentry>