From: Josselin Mouette Date: Thu, 9 Oct 2003 18:21:49 +0000 (+0000) Subject: Replace fc-cache and fc-list manpages with more detailed, SGML versions. X-Git-Tag: fc-2_2_91~2 X-Git-Url: https://git.wh0rd.org/?a=commitdiff_plain;h=75839218d18a7fad2f7e84cb995724763f7cae11;p=fontconfig.git Replace fc-cache and fc-list manpages with more detailed, SGML versions. --- diff --git a/ChangeLog b/ChangeLog index cc86d87..ff11186 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2003-10-09 Josselin Mouette + + * 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 * 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 @@ + 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. + + --> + + + Josselin"> + Mouette"> + + Sep 16, 2003"> + + 1"> + joss@debian.org"> + + fc-cache"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2003 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + build font information cache files + + + + &dhpackage; + + + + + + + + + + + + + DESCRIPTION + + &dhpackage; scans the font directories on + the system and builds font information cache files for + applications using fontconfig for their font handling. + + If directory arguments are not given, + &dhpackage; 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. + + + + OPTIONS + + This program follows the usual &gnu; command line syntax, + with long options starting with two dashes (`-'). A summary of + options is included below. + + + + + + + + Force re-generation of apparently up-to-date cache files, + overriding the timestamp checking. + + + + + + + + Only scan system-wide directories, omitting the places + located in the user's home directory. + + + + + + + + Display status information while busy. + + + + + + + + Show summary of options. + + + + + + + + Show version of the program and exit. + + + + + + + A list of directories to scan for fonts. + + + + + + + FILES + + + fonts.cache-1 + + These files are generated by &dhpackage; + and contain maps from file names to font properties. They are + read by the fontconfig library at application startup to locate + appropriate fonts. + + + + + + + SEE ALSO + + fc-list (1). + + The fontconfig user's guide, in HTML format: + /usr/share/doc/fontconfig/fontconfig-user.html. + + + + AUTHOR + + This manual page was written by Keith Packard + keithp@keithp.com and &dhusername; &dhemail;. + + + + + 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 @@ + 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. + + --> + + + Josselin"> + Mouette"> + + Sep 16, 2003"> + + 1"> + joss@debian.org"> + + fc-list"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2003 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + list available fonts + + + + &dhpackage; + + + + + + + + + + + + DESCRIPTION + + &dhpackage; lists fonts and styles + available on the system for applications using fontconfig. + + + + OPTIONS + + This program follows the usual &gnu; command line syntax, + with long options starting with two dashes (`-'). A summary of + options is included below. + + + + + + + + Display status information while busy. + + + + + + + + Show summary of options. + + + + + + + + Show version of the program and exit. + + + + + + + If this argument is set, only fonts matching + pattern are displayed. + + + + + + + If set, the element property + is displayed for matching fonts. + + + + + + SEE ALSO + + fc-cache (1). + + The fontconfig user's guide, in HTML format: + /usr/share/doc/fontconfig/fontconfig-user.html. + + + + AUTHOR + + This manual page was written by Keith Packard + keithp@keithp.com and &dhusername; &dhemail;. + + + + +