1<?xml version='1.0' encoding='ISO-8859-1'?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4
5  <!ENTITY dhfirstname "<firstname>Chris</firstname>">
6  <!ENTITY dhsurname   "<surname>Vanden Berghe</surname>">
7  <!ENTITY dhdate      "<date>May  5, 2004</date>">
8  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
9  <!ENTITY dhemail     "<email>Chris@VandenBerghe.org</email>">
10  <!ENTITY dhusername  "Chris Vanden Berghe">
11  <!ENTITY dhucpackage "<refentrytitle>METAPIXEL</refentrytitle>">
12  <!ENTITY dhpackage   "metapixel">
13
14  <!ENTITY debian      "<productname>Debian</productname>">
15  <!ENTITY gnu         "<acronym>GNU</acronym>">
16  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
17]>
18
19<refentry>
20  <refentryinfo>
21    <address>
22      &dhemail;
23    </address>
24    <author>
25      &dhfirstname;
26      &dhsurname;
27    </author>
28    <copyright>
29      <year>2004</year>
30      <holder>&dhusername;</holder>
31    </copyright>
32    &dhdate;
33  </refentryinfo>
34  <refmeta>
35    &dhucpackage;
36
37    &dhsection;
38  </refmeta>
39  <refnamediv>
40    <refname>&dhpackage;</refname>
41
42    <refpurpose>generator for photomosaics</refpurpose>
43  </refnamediv>
44  <refsynopsisdiv>
45    <cmdsynopsis>
46      <command>metapixel-prepare</command>
47      <arg><option><replaceable>options</replaceable></option></arg>
48      <arg><filename>srcdir</filename></arg>
49      <arg><filename>destdir</filename></arg>
50    </cmdsynopsis>
51    <funcsynopsisinfo>prepares the pictures in <filename>srcdir</filename> by creating resized images and a table file in <filename>destdir</filename></funcsynopsisinfo>
52    <cmdsynopsis>
53      <command>&dhpackage;</command>
54      <arg><option><replaceable>options</replaceable></option></arg>
55      <arg>--metapixel <filename>input.jpg</filename>
56      <filename>output.png</filename> --library
57      <filename>destdir</filename></arg>
58    </cmdsynopsis>
59    <funcsynopsisinfo>creates a photomosaic <filename>output.png</filename> using <filename>input.jpg</filename> as the input image and <filename>destdir/tables.mxt</filename> as table file</funcsynopsisinfo>
60  </refsynopsisdiv>
61  <refsect1>
62    <title>DESCRIPTION</title>
63
64    <para>This manual page documents briefly the
65    <command>&dhpackage;</command> and
66    <command>&dhpackage;-prepare</command> commands.  For more
67    information check the README file included in the
68    distribution.</para>
69
70    <para><command>&dhpackage;</command> is a program for generating
71    photomosaics. It can generate classical photomosaics, in which the
72    source image is viewed as a matrix of equally sized rectangles for
73    each of which a matching image is substitued, as well as
74    collage-style photomosaics, in which rectangular parts of the
75    source image at arbitrary positions (i.e. not aligned to a matrix)
76    are substituted by matching images.</para>
77
78    <para><command>&dhpackage;-prepare</command> is a utility that
79    needs to be run before metapixel can be used.  It prepares your
80    source images so that they can be used by
81    <command>&dhpackage;</command> to create the actual
82    photomosaic.</para>
83
84  </refsect1>
85  <refsect1>
86    <title>USAGE</title>
87
88    <para><command>&dhpackage;-prepare <filename>srcdir</filename>
89    <filename>destdir</filename></command> has to be run first.
90    <filename>srcdir</filename> is the path to the directory
91    containing the source images,
92    e.g. <filename>~/Pictures/Holidays</filename>.
93    <filename>destdir</filename>,
94    e.g. <filename>~/.metapixel</filename>, is the path to the
95    directory where you want to store the rescaled images and the
96    <filename>tables.mxt</filename> index file.  This directory should
97    be created manually before running
98    <command>&dhpackage;-prepare</command>.</para>
99
100    <para><command>&dhpackage; --metapixel
101    <filename>input.jpg</filename> <filename>output.png</filename>
102    --library <filename>destdir</filename></command> is then used
103    to transform an image (<filename>input.jpg</filename>) into a
104    mosaic (<filename>output.png</filename>) using the source images
105    (described by <filename>destdir/tables.mxt</filename>).
106    </para>
107  </refsect1>
108  <refsect1>
109    <title>OPTIONS</title>
110
111    <para>The options are described in the README file or by running
112    <command>&dhpackage;</command> or
113    <command>&dhpackage;-prepare</command> with the --help
114    option.</para>
115  </refsect1>
116
117  <refsect1>
118    <title>SEE ALSO</title>
119
120    <para>The README file is included in the Metapixel
121    distribution.</para>
122
123  </refsect1>
124  <refsect1>
125    <title>AUTHOR</title>
126
127    <para>This manual page was written by &dhusername; &dhemail; for
128    the &debian; system (but may be used by others).  Permission is
129    granted to copy, distribute and/or modify this document under the
130    terms of the &gnu; General Public License, Version 2 any later
131    version published by the Free Software Foundation.
132    </para>
133    <para>
134      On Debian systems, the complete text of the GNU General Public
135      License can be found in /usr/share/common-licenses/GPL.
136    </para>
137
138  </refsect1>
139</refentry>
140