Update documentation for fc-match (SGML-ize it). (reported by Ilya

Konstantinov)
This commit is contained in:
Patrick Lam 2006-04-06 05:15:08 +00:00
parent 392fa276dc
commit 8b4e7628e1
5 changed files with 203 additions and 39 deletions

View File

@ -1,3 +1,11 @@
2006-04-06 Patrick Lam <plam@mit.edu>
* fc-match/.cvsignore:
* fc-match/Makefile.am:
* fc-match/fc-match.sgml:
Update documentation for fc-match (SGML-ize it).
(reported by Ilya Konstantinov)
2006-04-06 Diego Pettenò <flameeyes@gentoo.org>
reviewed by: plam
* src/fcdefault.c:

View File

@ -3,3 +3,4 @@
Makefile
Makefile.in
fc-match
fc-match.1

View File

@ -23,10 +23,33 @@
bin_PROGRAMS=fc-match
man_MANS=fc-match.1
DOC2MAN = docbook2man
FC_MATCH_SRC=${top_srcdir}/fc-match
SGML = ${FC_MATCH_SRC}/fc-match.sgml
INCLUDES=-I${top_srcdir} $(FREETYPE_CFLAGS) $(WARN_CFLAGS)
EXTRA_DIST=$(man_MANS)
EXTRA_DIST=fc-match.sgml
fc_match_LDADD = ${top_builddir}/src/libfontconfig.la
if USEDOCBOOK
man_MANS=fc-match.1
${man_MANS}: ${SGML}
$(RM) $@
$(DOC2MAN) ${SGML}
$(RM) manpage.refs manpage.links
all-local: $(man_MANS)
clean-local:
$(RM) $(man_MANS)
else
all-local:
clean-local:
endif

View File

@ -1,37 +0,0 @@
.\"
.\" 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 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-match/fc-match.man,v 1.3 2001/02/09 03:47:56 tsi Exp $
.\"
.TH FC-MATCH 1 __vendorversion__
.SH NAME
fc-match \- match available fonts
.SH SYNOPSIS
.B "fc-match"
.RI [-svV?] [--sort] [--verbose] [--version] [ font-pattern ]
.SH DESCRIPTION
.I fc-match
matches font-pattern (empty pattern by default) using the normal fontconfig
matching rules to find the best font available. If --sort is given, the
sorted list of best matching fonts is displayed. With --verbose, the whole
font pattern for each match is printed, otherwise only the file, family and
style are printed.

169
fc-match/fc-match.sgml Normal file
View File

@ -0,0 +1,169 @@
<!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>Patrick</firstname>">
<!ENTITY dhsurname "<surname>Lam</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>Apr 6, 2006</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>plam@csail.mit.edu</email>">
<!ENTITY dhusername "Patrick Lam">
<!ENTITY dhucpackage "<refentrytitle>fc-match</refentrytitle>">
<!ENTITY dhpackage "fc-match">
<!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>match available fonts</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>-svV?</option></arg>
<arg><option>--sort</option></arg>
<arg><option>--verbose</option></arg>
<arg><option>--version</option></arg>
<arg><option>--help</option></arg>
<arg><option><replaceable>font-pattern</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> matches font-pattern (empty
pattern by default) using the normal fontconfig matching rules to find
the best font available. If --sort is given, the sorted list of best
matching fonts is displayed. With --verbose, the whole font pattern
for each match is printed, otherwise only the file, family and style
are printed..</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>Print whole font pattern for each match.</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>-s</option>
<option>--sort</option>
</term>
<listitem>
<para>Displays sorted list of best matching fonts.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option><replaceable>font-pattern</replaceable></option>
</term>
<listitem>
<para>Displays fonts matching
<replaceable>font-pattern</replaceable> (uses empty pattern by default).</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 updated by &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:
-->