Imported Upstream version 2.13.1

[platform/upstream/fontconfig.git] / doc / fccache.sgml

diff --git a/doc/fccache.sgml b/doc/fccache.sgml
index f17dafd..e29738c 100644 (file)
--- a/doc/fccache.sgml
+++ b/doc/fccache.sgml
@@ -25,6 +25,7 @@
        <refmeta>
            <refentrytitle>FcCacheDir</refentrytitle>
            <manvolnum>3</manvolnum>
+           <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
        </refmeta>
        <refnamediv>
            <refname>FcCacheDir</refname>
@@ -33,7 +34,7 @@
        <refsynopsisdiv>
        <funcsynopsis>
        <funcsynopsisinfo>
-#include &lt;fontconfig.h&gt;
+#include &lt;fontconfig/fontconfig.h&gt;
        </funcsynopsisinfo>
        <funcprototype>
            <funcdef>const FcChar8 * <function>FcCacheDir</function></funcdef>
@@ -46,11 +47,6 @@
 This function returns the directory from which the cache was constructed.
            </para>
        </refsect1>
-       <refsect1><title>Version</title>
-           <para>
-Fontconfig version &version;
-           </para>
-       </refsect1>
     </refentry>
 <!--
    fontconfig/doc/func.sgml
@@ -79,6 +75,7 @@ Fontconfig version &version;
        <refmeta>
            <refentrytitle>FcCacheCopySet</refentrytitle>
            <manvolnum>3</manvolnum>
+           <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
        </refmeta>
        <refnamediv>
            <refname>FcCacheCopySet</refname>
@@ -87,7 +84,7 @@ Fontconfig version &version;
        <refsynopsisdiv>
        <funcsynopsis>
        <funcsynopsisinfo>
-#include &lt;fontconfig.h&gt;
+#include &lt;fontconfig/fontconfig.h&gt;
        </funcsynopsisinfo>
        <funcprototype>
            <funcdef>FcFontSet * <function>FcCacheCopySet</function></funcdef>
@@ -102,11 +99,6 @@ The returned fontset contains each of the font patterns from
 from the cache are read-only.
            </para>
        </refsect1>
-       <refsect1><title>Version</title>
-           <para>
-Fontconfig version &version;
-           </para>
-       </refsect1>
     </refentry>
 <!--
    fontconfig/doc/func.sgml
@@ -135,6 +127,7 @@ Fontconfig version &version;
        <refmeta>
            <refentrytitle>FcCacheSubdir</refentrytitle>
            <manvolnum>3</manvolnum>
+           <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
        </refmeta>
        <refnamediv>
            <refname>FcCacheSubdir</refname>
@@ -143,7 +136,7 @@ Fontconfig version &version;
        <refsynopsisdiv>
        <funcsynopsis>
        <funcsynopsisinfo>
-#include &lt;fontconfig.h&gt;
+#include &lt;fontconfig/fontconfig.h&gt;
        </funcsynopsisinfo>
        <funcprototype>
            <funcdef>const FcChar8 * <function>FcCacheSubdir</function></funcdef>
@@ -160,11 +153,6 @@ function, <parameter>i</parameter> should range from 0 to
 value from FcCacheNumSubdir.
            </para>
        </refsect1>
-       <refsect1><title>Version</title>
-           <para>
-Fontconfig version &version;
-           </para>
-       </refsect1>
     </refentry>
 <!--
    fontconfig/doc/func.sgml
@@ -193,6 +181,7 @@ Fontconfig version &version;
        <refmeta>
            <refentrytitle>FcCacheNumSubdir</refentrytitle>
            <manvolnum>3</manvolnum>
+           <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
        </refmeta>
        <refnamediv>
            <refname>FcCacheNumSubdir</refname>
@@ -201,7 +190,7 @@ Fontconfig version &version;
        <refsynopsisdiv>
        <funcsynopsis>
        <funcsynopsisinfo>
-#include &lt;fontconfig.h&gt;
+#include &lt;fontconfig/fontconfig.h&gt;
        </funcsynopsisinfo>
        <funcprototype>
            <funcdef>int <function>FcCacheNumSubdir</function></funcdef>
@@ -214,11 +203,6 @@ Fontconfig version &version;
 This returns the total number of subdirectories in the cache.
            </para>
        </refsect1>
-       <refsect1><title>Version</title>
-           <para>
-Fontconfig version &version;
-           </para>
-       </refsect1>
     </refentry>
 <!--
    fontconfig/doc/func.sgml
@@ -247,6 +231,7 @@ Fontconfig version &version;
        <refmeta>
            <refentrytitle>FcCacheNumFont</refentrytitle>
            <manvolnum>3</manvolnum>
+           <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
        </refmeta>
        <refnamediv>
            <refname>FcCacheNumFont</refname>
@@ -255,7 +240,7 @@ Fontconfig version &version;
        <refsynopsisdiv>
        <funcsynopsis>
        <funcsynopsisinfo>
-#include &lt;fontconfig.h&gt;
+#include &lt;fontconfig/fontconfig.h&gt;
        </funcsynopsisinfo>
        <funcprototype>
            <funcdef>int <function>FcCacheNumFont</function></funcdef>
@@ -269,11 +254,6 @@ This returns the number of fonts which would be included in the return from
 FcCacheCopySet.
            </para>
        </refsect1>
-       <refsect1><title>Version</title>
-           <para>
-Fontconfig version &version;
-           </para>
-       </refsect1>
     </refentry>
 <!--
    fontconfig/doc/func.sgml
@@ -302,16 +282,16 @@ Fontconfig version &version;
        <refmeta>
            <refentrytitle>FcDirCacheClean</refentrytitle>
            <manvolnum>3</manvolnum>
+           <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
        </refmeta>
        <refnamediv>
            <refname>FcDirCacheClean</refname>
-           <refpurpose>This tries to clean up the cache directory of <parameter>cache_dir</parameter>.
-This returns FcTrue if the operation is successfully complete. otherwise FcFalse.</refpurpose>
+           <refpurpose>Clean up a cache directory</refpurpose>
        </refnamediv>
        <refsynopsisdiv>
        <funcsynopsis>
        <funcsynopsisinfo>
-#include &lt;fontconfig.h&gt;
+#include &lt;fontconfig/fontconfig.h&gt;
        </funcsynopsisinfo>
        <funcprototype>
            <funcdef>FcBool <function>FcDirCacheClean</function></funcdef>
@@ -322,13 +302,12 @@ This returns FcTrue if the operation is successfully complete. otherwise FcFalse
        </refsynopsisdiv>
        <refsect1><title>Description</title>
            <para>
-
+This tries to clean up the cache directory of <parameter>cache_dir</parameter>.
+This returns FcTrue if the operation is successfully complete. otherwise FcFalse.
            </para>
        </refsect1>
-       <refsect1><title>Version</title>
-           <para>
-Fontconfig version &version;
-           </para>
+       <refsect1><title>Since</title>
+           <para>version 2.9.91</para>
        </refsect1>
     </refentry>
 <!--
@@ -358,6 +337,7 @@ Fontconfig version &version;
        <refmeta>
            <refentrytitle>FcCacheCreateTagFile</refentrytitle>
            <manvolnum>3</manvolnum>
+           <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
        </refmeta>
        <refnamediv>
            <refname>FcCacheCreateTagFile</refname>
@@ -366,7 +346,7 @@ Fontconfig version &version;
        <refsynopsisdiv>
        <funcsynopsis>
        <funcsynopsisinfo>
-#include &lt;fontconfig.h&gt;
+#include &lt;fontconfig/fontconfig.h&gt;
        </funcsynopsisinfo>
        <funcprototype>
            <funcdef>void <function>FcCacheCreateTagFile</function></funcdef>
@@ -380,9 +360,120 @@ This tries to create CACHEDIR.TAG file at the cache directory registered
 to <parameter>config</parameter>.
            </para>
        </refsect1>
-       <refsect1><title>Version</title>
+       <refsect1><title>Since</title>
+           <para>version 2.9.91</para>
+       </refsect1>
+    </refentry>
+<!--
+   fontconfig/doc/func.sgml
+  
+   Copyright © 2003 Keith Packard
+  
+   Permission to use, copy, modify, distribute, and sell this software and its
+   documentation for any purpose is hereby granted without fee, provided that
+   the above copyright notice appear in all copies and that both that
+   copyright notice and this permission notice appear in supporting
+   documentation, and that the name of the author(s) not be used in
+   advertising or publicity pertaining to distribution of the software without
+   specific, written prior permission.  The authors make no
+   representations about the suitability of this software for any purpose.  It
+   is provided "as is" without express or implied warranty.
+  
+   THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+   INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
+   EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+   CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
+   DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+   TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+   PERFORMANCE OF THIS SOFTWARE.
+ -->
+    <refentry id="FcDirCacheCreateUUID">
+       <refmeta>
+           <refentrytitle>FcDirCacheCreateUUID</refentrytitle>
+           <manvolnum>3</manvolnum>
+           <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
+       </refmeta>
+       <refnamediv>
+           <refname>FcDirCacheCreateUUID</refname>
+           <refpurpose>Create .uuid file at a directory</refpurpose>
+       </refnamediv>
+       <refsynopsisdiv>
+       <funcsynopsis>
+       <funcsynopsisinfo>
+#include &lt;fontconfig/fontconfig.h&gt;
+       </funcsynopsisinfo>
+       <funcprototype>
+           <funcdef>FcBool <function>FcDirCacheCreateUUID</function></funcdef>
+               <paramdef>FcChar8 *<parameter>dir</parameter></paramdef>
+               <paramdef>FcBool<parameter>force</parameter></paramdef>
+               <paramdef>FcConfig *<parameter>config</parameter></paramdef>
+       </funcprototype>
+       </funcsynopsis>
+       </refsynopsisdiv>
+       <refsect1><title>Description</title>
            <para>
-Fontconfig version &version;
+This is to create .uuid file containing an UUID at a font directory of
+<parameter>dir</parameter>.
+The UUID will be used to identify the font directory and is used to determine
+the cache filename if available.
            </para>
        </refsect1>
+       <refsect1><title>Since</title>
+           <para>version 2.12.92</para>
+       </refsect1>
+    </refentry>
+<!--
+   fontconfig/doc/func.sgml
+  
+   Copyright © 2003 Keith Packard
+  
+   Permission to use, copy, modify, distribute, and sell this software and its
+   documentation for any purpose is hereby granted without fee, provided that
+   the above copyright notice appear in all copies and that both that
+   copyright notice and this permission notice appear in supporting
+   documentation, and that the name of the author(s) not be used in
+   advertising or publicity pertaining to distribution of the software without
+   specific, written prior permission.  The authors make no
+   representations about the suitability of this software for any purpose.  It
+   is provided "as is" without express or implied warranty.
+  
+   THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+   INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
+   EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+   CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
+   DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+   TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+   PERFORMANCE OF THIS SOFTWARE.
+ -->
+    <refentry id="FcDirCacheDeleteUUID">
+       <refmeta>
+           <refentrytitle>FcDirCacheDeleteUUID</refentrytitle>
+           <manvolnum>3</manvolnum>
+           <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
+       </refmeta>
+       <refnamediv>
+           <refname>FcDirCacheDeleteUUID</refname>
+           <refpurpose>Delete .uuid file</refpurpose>
+       </refnamediv>
+       <refsynopsisdiv>
+       <funcsynopsis>
+       <funcsynopsisinfo>
+#include &lt;fontconfig/fontconfig.h&gt;
+       </funcsynopsisinfo>
+       <funcprototype>
+           <funcdef>FcBool <function>FcDirCacheDeleteUUID</function></funcdef>
+               <paramdef>const FcChar8 *<parameter>dir</parameter></paramdef>
+               <paramdef>FcConfig *<parameter>config</parameter></paramdef>
+       </funcprototype>
+       </funcsynopsis>
+       </refsynopsisdiv>
+       <refsect1><title>Description</title>
+           <para>
+This is to delete .uuid file containing an UUID at a font directory of
+<parameter>dir</parameter>.
+           </para>
+       </refsect1>
+       <refsect1><title>Since</title>
+           <para>version 2.13.1</para>
+       </refsect1>
     </refentry>