summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosselin Mouette <joss@debian.org>2003-10-09 18:21:49 +0000
committerJosselin Mouette <joss@debian.org>2003-10-09 18:21:49 +0000
commit75839218d18a7fad2f7e84cb995724763f7cae11 (patch)
tree11b340dee230d9b270b8e64066d3b287b251d747
parentf077d662c001468eb2aa1261549accd9ff3de401 (diff)
Replace fc-cache and fc-list manpages with more detailed, SGML versions.
-rw-r--r--ChangeLog7
-rw-r--r--fc-cache/.cvsignore1
-rw-r--r--fc-cache/Makefile.am24
-rw-r--r--fc-cache/fc-cache.151
-rw-r--r--fc-cache/fc-cache.sgml200
-rw-r--r--fc-list/.cvsignore1
-rw-r--r--fc-list/Makefile.am24
-rw-r--r--fc-list/fc-list.137
-rw-r--r--fc-list/fc-list.sgml165
9 files changed, 420 insertions, 90 deletions
diff --git a/ChangeLog b/ChangeLog
index cc86d87..ff11186 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2003-10-09 Josselin Mouette <joss@debian.org>
+
+ * fc-cache/fc-cache.sgml fc-cache/Makefile.am:
+ * fc-list/fc-list.sgml fc-list/Makefile.am:
+ Replace fc-cache and fc-list manpages with more detailed, SGML
+ versions.
+
2003-09-23 Owen Taylor <otaylor@redhat.com>
* fontconfig/fontconfig.h src/fcdefault.c (FcDefaultSubstitute)
diff --git a/fc-cache/.cvsignore b/fc-cache/.cvsignore
index 535140b..09b6835 100644
--- a/fc-cache/.cvsignore
+++ b/fc-cache/.cvsignore
@@ -3,3 +3,4 @@
Makefile
Makefile.in
fc-cache
+fc-cache.1
diff --git a/fc-cache/Makefile.am b/fc-cache/Makefile.am
index a0504b4..eede777 100644
--- a/fc-cache/Makefile.am
+++ b/fc-cache/Makefile.am
@@ -21,12 +21,34 @@
# TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
# PERFORMANCE OF THIS SOFTWARE.
+DOC2MAN = docbook2man
+
+SGML = fc-cache.sgml
+
INCLUDES=$(FREETYPE_CFLAGS)
man_MANS=fc-cache.1
bin_PROGRAMS=fc-cache
-EXTRA_DIST=$(man_MANS)
+EXTRA_DIST=$(SGML)
fc_cache_LDADD = ../src/libfontconfig.la
+
+
+if USEDOCBOOK
+
+.sgml.1:
+ $(RM) $@
+ $(DOC2MAN) $*.sgml
+ $(RM) manpage.refs manpage.links
+
+all-local: $(man_MANS)
+
+clean-local:
+ $(RM) $(man_MANS)
+
+else
+all-local:
+clean-local:
+endif
diff --git a/fc-cache/fc-cache.1 b/fc-cache/fc-cache.1
deleted file mode 100644
index 1844b3d..0000000
--- a/fc-cache/fc-cache.1
+++ /dev/null
@@ -1,51 +0,0 @@
-.\"
-.\" Copyright 2002 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 Keith Packard not be used in
-.\" advertising or publicity pertaining to distribution of the software without
-.\" specific, written prior permission. Keith Packard makes no
-.\" representations about the suitability of this software for any purpose. It
-.\" is provided "as is" without express or implied warranty.
-.\"
-.\" KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
-.\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
-.\" EVENT SHALL KEITH PACKARD 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.
-.\"
-.\"
-.\" $RCSId: xc/programs/fc-cache/fc-cache.man,v 1.3 2001/02/09 03:47:56 tsi Exp $
-.\"
-.TH FC-CACHE 1 __vendorversion__
-.SH NAME
-fc-cache, fonts.cache \- create an index of FreeType font files in a directory
-.SH SYNOPSIS
-.B "fc-cache"
-.RI [-fsvV?] [--force] [--system-only] [--verbose] [--version] [--help] [ directory-name
-\|.\|.\|. ]
-.SH DESCRIPTION
-If directory arguments are not given,
-.I fc-cache
-uses each directory in the current font configuration. Each directory is
-scanned for font files readable by FreeType. A cache is created which
-contains properties of each font and the associated filename. This cache is
-used to speed application startup when using the fontconfig library.
-.P
-Use -f (or --force on systems supporting long arguments) to override the
-usual timestamp checking and ensure that new cache files are built.
-.P
-Use -s (or --system-only on systems supporting long arguments) to restrict
-the updates to fonts not located in the current users home directory.
-.SH FILES
-.TP 15
-.B fonts.cache
-Maps file names to font properties. Read by the fontconfig library at
-application startup to locate appropriate fonts.
-.SH "SEE ALSO"
-fontconfig(3)
diff --git a/fc-cache/fc-cache.sgml b/fc-cache/fc-cache.sgml
new file mode 100644
index 0000000..acc31ec
--- /dev/null
+++ b/fc-cache/fc-cache.sgml
@@ -0,0 +1,200 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+
+<!-- Process this file with docbook-to-man to generate an nroff manual
+ page: `docbook-to-man manpage.sgml > manpage.1'. You may view
+ the manual page with: `docbook-to-man manpage.sgml | nroff -man |
+ less'. A typical entry in a Makefile or Makefile.am is:
+
+manpage.1: manpage.sgml
+ docbook-to-man $< > $@
+
+
+ The docbook-to-man binary is found in the docbook-to-man package.
+ Please remember that if you create the nroff version in one of the
+ debian/rules file targets (such as build), you will need to include
+ docbook-to-man in your Build-Depends control field.
+
+ -->
+
+ <!-- Fill in your name for FIRSTNAME and SURNAME. -->
+ <!ENTITY dhfirstname "<firstname>Josselin</firstname>">
+ <!ENTITY dhsurname "<surname>Mouette</surname>">
+ <!-- Please adjust the date whenever revising the manpage. -->
+ <!ENTITY dhdate "<date>Sep 16, 2003</date>">
+ <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
+ allowed: see man(7), man(1). -->
+ <!ENTITY dhsection "<manvolnum>1</manvolnum>">
+ <!ENTITY dhemail "<email>joss@debian.org</email>">
+ <!ENTITY dhusername "Josselin Mouette">
+ <!ENTITY dhucpackage "<refentrytitle>fc-cache</refentrytitle>">
+ <!ENTITY dhpackage "fc-cache">
+
+ <!ENTITY debian "<productname>Debian</productname>">
+ <!ENTITY gnu "<acronym>GNU</acronym>">
+ <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
+]>
+
+<refentry>
+ <refentryinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ <copyright>
+ <year>2003</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ &dhdate;
+ </refentryinfo>
+ <refmeta>
+ &dhucpackage;
+
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&dhpackage;</refname>
+
+ <refpurpose>build font information cache files</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>&dhpackage;</command>
+
+ <arg><option>-fsvV?</option></arg>
+ <arg><option>--force</option></arg>
+ <arg><option>--system-only</option></arg>
+ <arg><option>--verbose</option></arg>
+ <arg><option>--version</option></arg>
+ <arg><option>--help</option></arg>
+ <arg><option><replaceable>dirs</replaceable></option></arg>
+
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+
+ <para><command>&dhpackage;</command> scans the font directories on
+ the system and builds font information cache files for
+ applications using fontconfig for their font handling.</para>
+
+ <para>If directory arguments are not given,
+ <command>&dhpackage;</command> uses each directory in the
+ current font configuration. Each directory is scanned for
+ font files readable by FreeType. A cache is created which
+ contains properties of each font and the associated filename.
+ This cache is used to speed up application startup when using
+ the fontconfig library.</para>
+
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+
+ <para>This program follows the usual &gnu; command line syntax,
+ with long options starting with two dashes (`-'). A summary of
+ options is included below.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-f</option>
+ <option>--force</option>
+ </term>
+ <listitem>
+ <para>Force re-generation of apparently up-to-date cache files,
+ overriding the timestamp checking.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-s</option>
+ <option>--system-only</option>
+ </term>
+ <listitem>
+ <para>Only scan system-wide directories, omitting the places
+ located in the user's home directory.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-v</option>
+ <option>--verbose</option>
+ </term>
+ <listitem>
+ <para>Display status information while busy.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-?</option>
+ <option>--help</option>
+ </term>
+ <listitem>
+ <para>Show summary of options.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-V</option>
+ <option>--version</option>
+ </term>
+ <listitem>
+ <para>Show version of the program and exit.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option><replaceable>dirs</replaceable></option>
+ </term>
+ <listitem>
+ <para>A list of directories to scan for fonts.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>FILES</title>
+ <variablelist>
+ <varlistentry>
+ <term><filename>fonts.cache-1</filename></term>
+ <listitem>
+ <para>These files are generated by <command>&dhpackage;</command>
+ and contain maps from file names to font properties. They are
+ read by the fontconfig library at application startup to locate
+ appropriate fonts.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para><command>fc-list</command> (1).</para>
+
+ <para>The fontconfig user's guide, in HTML format:
+ <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
+
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+
+ <para>This manual page was written by Keith Packard
+ <email>keithp@keithp.com</email> and &dhusername; &dhemail;.</para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
diff --git a/fc-list/.cvsignore b/fc-list/.cvsignore
index 7073c7a..ed422b7 100644
--- a/fc-list/.cvsignore
+++ b/fc-list/.cvsignore
@@ -3,3 +3,4 @@
Makefile
Makefile.in
fc-list
+fc-list.1
diff --git a/fc-list/Makefile.am b/fc-list/Makefile.am
index b050a3f..6975361 100644
--- a/fc-list/Makefile.am
+++ b/fc-list/Makefile.am
@@ -21,12 +21,34 @@
# TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
# PERFORMANCE OF THIS SOFTWARE.
+DOC2MAN = docbook2man
+
+SGML = fc-list.sgml
+
bin_PROGRAMS=fc-list
man_MANS=fc-list.1
INCLUDES=$(FREETYPE_CFLAGS)
-EXTRA_DIST=$(man_MANS)
+EXTRA_DIST=$(SGML)
fc_list_LDADD = ../src/libfontconfig.la
+
+
+if USEDOCBOOK
+
+.sgml.1:
+ $(RM) $@
+ $(DOC2MAN) $*.sgml
+ $(RM) manpage.refs manpage.links
+
+all-local: $(man_MANS)
+
+clean-local:
+ $(RM) $(man_MANS)
+
+else
+all-local:
+clean-local:
+endif
diff --git a/fc-list/fc-list.1 b/fc-list/fc-list.1
deleted file mode 100644
index 4efa37c..0000000
--- a/fc-list/fc-list.1
+++ /dev/null
@@ -1,37 +0,0 @@
-.\"
-.\" Copyright 2002 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 Keith Packard not be used in
-.\" advertising or publicity pertaining to distribution of the software without
-.\" specific, written prior permission. Keith Packard makes no
-.\" representations about the suitability of this software for any purpose. It
-.\" is provided "as is" without express or implied warranty.
-.\"
-.\" KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
-.\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
-.\" EVENT SHALL KEITH PACKARD 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.
-.\"
-.\"
-.\" $RCSId: xc/programs/fc-list/fc-list.man,v 1.3 2001/02/09 03:47:56 tsi Exp $
-.\"
-.TH FC-LIST 1 __vendorversion__
-.SH NAME
-fc-list \- list available fonts
-.SH SYNOPSIS
-.B "fc-list"
-.RI [-vV?] [--verbose] [--version] [ font-pattern ] { element ... }
-.SH DESCRIPTION
-If font pattern is not given,
-.I fc-list
-lists all available faces and styles in the current font configuration.
-If elements are provided, list only those elements of each matching pattern.
-.SH "SEE ALSO"
-fontconfig(3)
diff --git a/fc-list/fc-list.sgml b/fc-list/fc-list.sgml
new file mode 100644
index 0000000..9162e24
--- /dev/null
+++ b/fc-list/fc-list.sgml
@@ -0,0 +1,165 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+
+<!-- Process this file with docbook-to-man to generate an nroff manual
+ page: `docbook-to-man manpage.sgml > manpage.1'. You may view
+ the manual page with: `docbook-to-man manpage.sgml | nroff -man |
+ less'. A typical entry in a Makefile or Makefile.am is:
+
+manpage.1: manpage.sgml
+ docbook-to-man $< > $@
+
+
+ The docbook-to-man binary is found in the docbook-to-man package.
+ Please remember that if you create the nroff version in one of the
+ debian/rules file targets (such as build), you will need to include
+ docbook-to-man in your Build-Depends control field.
+
+ -->
+
+ <!-- Fill in your name for FIRSTNAME and SURNAME. -->
+ <!ENTITY dhfirstname "<firstname>Josselin</firstname>">
+ <!ENTITY dhsurname "<surname>Mouette</surname>">
+ <!-- Please adjust the date whenever revising the manpage. -->
+ <!ENTITY dhdate "<date>Sep 16, 2003</date>">
+ <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
+ allowed: see man(7), man(1). -->
+ <!ENTITY dhsection "<manvolnum>1</manvolnum>">
+ <!ENTITY dhemail "<email>joss@debian.org</email>">
+ <!ENTITY dhusername "Josselin Mouette">
+ <!ENTITY dhucpackage "<refentrytitle>fc-list</refentrytitle>">
+ <!ENTITY dhpackage "fc-list">
+
+ <!ENTITY debian "<productname>Debian</productname>">
+ <!ENTITY gnu "<acronym>GNU</acronym>">
+ <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
+]>
+
+<refentry>
+ <refentryinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ <copyright>
+ <year>2003</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ &dhdate;
+ </refentryinfo>
+ <refmeta>
+ &dhucpackage;
+
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&dhpackage;</refname>
+
+ <refpurpose>list available fonts</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>&dhpackage;</command>
+
+ <arg><option>-vV?</option></arg>
+ <arg><option>--verbose</option></arg>
+ <arg><option>--version</option></arg>
+ <arg><option>--help</option></arg>
+ <arg><option><replaceable>pattern</replaceable></option></arg>
+ <arg><option><replaceable>element</replaceable></option></arg>
+
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+
+ <para><command>&dhpackage;</command> lists fonts and styles
+ available on the system for applications using fontconfig.</para>
+
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+
+ <para>This program follows the usual &gnu; command line syntax,
+ with long options starting with two dashes (`-'). A summary of
+ options is included below.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-v</option>
+ <option>--verbose</option>
+ </term>
+ <listitem>
+ <para>Display status information while busy.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-?</option>
+ <option>--help</option>
+ </term>
+ <listitem>
+ <para>Show summary of options.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-V</option>
+ <option>--version</option>
+ </term>
+ <listitem>
+ <para>Show version of the program and exit.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option><replaceable>pattern</replaceable></option>
+ </term>
+ <listitem>
+ <para>If this argument is set, only fonts matching
+ <replaceable>pattern</replaceable> are displayed.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option><replaceable>element</replaceable></option>
+ </term>
+ <listitem>
+ <para>If set, the <replaceable>element</replaceable> property
+ is displayed for matching fonts.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para><command>fc-cache</command> (1).</para>
+
+ <para>The fontconfig user's guide, in HTML format:
+ <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
+
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+
+ <para>This manual page was written by Keith Packard
+ <email>keithp@keithp.com</email> and &dhusername; &dhemail;.</para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->