doc/manpages/man1/netatalk-config.1.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="netatalkconfig.1">
   3   <refmeta>
   4     <refentrytitle>netatalk-config</refentrytitle>
   5
   6     <manvolnum>1</manvolnum>
   7
   8     <refmiscinfo class="date">09 June 2001</refmiscinfo>
   9
  10     <refmiscinfo class="source">:NETATALK_VERSION:</refmiscinfo>
  11
  12     <refmiscinfo class="manual">The Netatalk Project</refmiscinfo>
  13   </refmeta>
  14
  15   <refnamediv>
  16     <refname>netatalk-config</refname>
  17
  18     <refpurpose>script to get information about the installed version of
  19     netatalk</refpurpose>
  20   </refnamediv>
  21
  22   <refsynopsisdiv>
  23     <cmdsynopsis>
  24       <command>netatalk-config<indexterm><primary>netatalk-config</primary></indexterm></command>
  25
  26       <arg choice="opt"><arg choice="plain">--prefix </arg><arg choice="opt"><replaceable>=DIR</replaceable></arg></arg>
  27
  28       <arg choice="opt"><arg choice="plain">--exec_prefix </arg><arg
  29       choice="opt"><replaceable>=DIR</replaceable></arg></arg>
  30
  31       <arg choice="opt">--help</arg>
  32
  33       <arg choice="opt">--version</arg>
  34
  35       <arg choice="opt">--libs</arg>
  36
  37       <arg choice="opt">--libs-dirs</arg>
  38
  39       <arg choice="opt">--libs-names</arg>
  40
  41       <arg choice="opt">--cflags</arg>
  42
  43       <arg choice="opt">--macros</arg>
  44     </cmdsynopsis>
  45   </refsynopsisdiv>
  46
  47   <refsect1>
  48     <title>DESCRIPTION</title>
  49
  50     <para><command>netatalk-config</command> is a tool that is used to
  51     determine the compiler and linker flags that should be used
  52     to compile and link programs that use the <emphasis remap="I">netatalk</emphasis>
  53     run-time libraries.</para>
  54   </refsect1>
  55
  56   <refsect1>
  57     <title>OPTIONS</title>
  58
  59     <para><command>netatalk-config</command> accepts the following options:</para>
  60
  61     <variablelist remap="TP">
  62       <varlistentry>
  63         <term><option>--help</option></term>
  64
  65         <listitem>
  66           <para>Print a short help for this command and exit.</para>
  67         </listitem>
  68       </varlistentry>
  69
  70       <varlistentry>
  71         <term><option>--version</option></term>
  72
  73         <listitem>
  74           <para>Print the currently installed version of <emphasis remap="I">netatalk</emphasis>
  75           on the standard output.</para>
  76         </listitem>
  77       </varlistentry>
  78
  79       <varlistentry>
  80         <term><option>--libs</option></term>
  81
  82         <listitem>
  83           <para>Print the linker flags that are necessary to link against the
  84           <emphasis remap="I">netatalk</emphasis> run-time libraries.</para>
  85         </listitem>
  86       </varlistentry>
  87
  88       <varlistentry>
  89         <term><option>--libs-dirs</option></term>
  90
  91         <listitem>
  92           <para>Print only the -l/-R part of --libs.</para>
  93         </listitem>
  94       </varlistentry>
  95
  96       <varlistentry>
  97         <term><option>--libs-names</option></term>
  98
  99         <listitem>
 100           <para>Print only the -l part of --libs.</para>
 101         </listitem>
 102       </varlistentry>
 103
 104       <varlistentry>
 105         <term><option>--cflags</option></term>
 106
 107         <listitem>
 108           <para>Print the compiler flags that are necessary to compile a
 109           program linked against the <emphasis remap="I">netatalk</emphasis>
 110           run-time libraries.</para>
 111         </listitem>
 112       </varlistentry>
 113
 114       <varlistentry>
 115         <term><option>--macros</option></term>
 116
 117         <listitem>
 118           <para>Print the <emphasis remap="I">netatalk</emphasis> m4
 119           directory.</para>
 120         </listitem>
 121       </varlistentry>
 122
 123       <varlistentry>
 124         <term><option>--prefix=PREFIX</option></term>
 125
 126         <listitem>
 127           <para>If specified, use PREFIX instead of the installation prefix
 128           that <emphasis remap="I">netatalk</emphasis> was built with when
 129           computing the output for the --cflags and --libs options. This
 130           option is also used for the exec prefix if --exec-prefix was not
 131           specified. This option must be specified before any --libs or
 132           --cflags options.</para>
 133         </listitem>
 134       </varlistentry>
 135
 136       <varlistentry>
 137         <term><option>--exec\_prefix=PREFIX</option></term>
 138
 139         <listitem>
 140           <para>If specified, use PREFIX instead of the installation exec
 141           prefix that <emphasis remap="I">netatalk</emphasis> was built with
 142           when computing the output for the --cflags and --libs options. This
 143           option must be specified before any --libs or --cflags options.</para>
 144         </listitem>
 145       </varlistentry>
 146     </variablelist>
 147   </refsect1>
 148
 149   <refsect1>
 150     <title>COPYRIGHT</title>
 151
 152     <para>Copyright © 1998 Owen Taylor</para>
 153
 154     <para>Permission to use, copy, modify, and distribute this software and
 155     its documentation for any purpose and without fee is hereby granted,
 156     provided that the above copyright notice appear in all copies and that
 157     both that copyright notice and this permission notice appear in supporting
 158     documentation.</para>
 159
 160     <para>Man page adapted for <command>netatalk-config</command> by Sebastian
 161     Rittau in 2001.</para>
 162   </refsect1>
 163 </refentry>