]> git.sur5r.net Git - glabels/blob - glabels1/README
2008-12-27 Jim Evins <evins@snaught.com>
[glabels] / glabels1 / README
1 Copyright
2 =========
3
4    gLabels - a GNOME-based label and business card creation program
5
6    Copyright (C) 2000 Jim Evins
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21
22    For more details see the file COPYING.
23
24
25
26 What is gLabels
27 ===============
28
29 gLabels is a small stand-alone program for creating labels and business
30 cards using a laser or ink-jet printer.
31
32 System Requirements
33 ===================
34
35 GNOME-LIBS-1.2.x
36 GTK+-1.2.x
37 LIBXML-1.8.x
38 GNOME-PRINT-0.25
39 GDK-PIXBUF-0.11
40
41 All of these libraries are available as part of Gnome 1.4.
42
43 NOTE:
44 -----
45 To compile gLabels on RPM based systems, you will need the development
46 RPMs (e.g. gnome-print-devel) installed for each of these libraries.  For
47 example, the following './configure' error would indicate that you may
48 need to install the development RPM for the gnome-print library.
49
50         checking for GNOME-PRINT >= 0.25... not found
51         configure: error:
52
53         You need GNOME-PRINT 0.25 or later to build gLabels
54         If you think you already have this installed, consult the README.
55
56 To verify this, do the following:
57
58         $ rpm -q -a | grep gnome-print
59
60 You should get something like this (your version numbers may be different):
61
62         gnome-print-0.31-ximian.1
63         gnome-print-devel-0.31-ximian.1
64
65 If you get no output, you will need to install both the library and
66 development RPMs.  If you only get the first of these lines, you still
67 need to install the development RPMs.  If you get the above error and
68 you get both of these lines, you probably have a fundamental configuration
69 problem.  These RPMs should be available from wherever you received
70 your gnome distribution.
71
72 NOTE:
73 -----
74 Special Note for Mandrake 8.1:  I recently installed Mandrake 8.1 on a
75 partition of a test machine.  I found that an rpm for gdk-pixbuf-devel
76 was on the 2nd CD, but it has a broken dependency (it's looking for
77 libgr-devel, which isn't on any of the CDs) so it did not show up in
78 Mandrake's package manager (at least that is what I suspect).  I manually
79 installed it with rpm using the --nodeps option, and was able to compile
80 with no problem.
81
82
83 Usage notes:
84 ============
85 gLabels is still in its early stages of development and thus lacks any
86 "real" documentation.  Most folks have found it fairly easy to use, at
87 least for its simple composition features.  Beginning with version 0.4.x,
88 gLabels has a document-merge capability that might not be as intuitive
89 as these other features.
90
91 The first step to performing a document merge is to prepare a source
92 document that contains your merge data. This data could be mailing
93 addresses or any other data that you wish to create unique labels or
94 cards for.  Currently only a simple back-end for text files exists --
95 others are planned.  The currently supported text-file format is very
96 simple:  each line is a record; fields are delimited by tabs,
97 commas, or colons; and newlines can be embedded into fields by using
98 the "\n" entity.  This file could be created using any text editor or
99 could be created by another program or script.
100
101 A label must then be configured to "point at" this data file.  This is
102 accomplished with the "merge properties" dialog.  This dialog is used
103 to select the exact data file format and file name (location).  Customized
104 field keys can also be defined (the default keys are the column numbers).
105
106 Finally, once the label has been configured for a data file, field keys
107 can be inserted into text and barcode objects in their property dialogs.
108
109 Now that your label is configured, gLabels will print a unique label for
110 each record in your source document -- substituting fields from each
111 record for field keys in the all text and barcode objects.
112
113 Beginning with 0.4.3, a simple CLI front-end called "glabels-batch" is
114 provided to print previously created glabels files from a shell,
115 other programs or scripts.  Do a "glabels-batch --help" for usage
116 information.
117
118 Author and Acknowledgments:
119 ===========================
120
121 See the AUTHORS file.