File: pcd2html.1

package info (click to toggle)
pcd2html 0.5.1-3.1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 368 kB
  • ctags: 56
  • sloc: perl: 1,405; makefile: 120; sh: 69
file content (104 lines) | stat: -rw-r--r-- 3,481 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
.TH PCD2HTML 1 "01/20/1999" "" "Manual for pcd2html"
.SH NAME
\fBpcd2html\fR \- scripts to build HTML pages from Kodak Photo CD images
.SH SYNOPSIS
.B pcd2html
[options]
.SH "DESCRIPTION"
.B pcd2html

certain images will be included in HTML pages.  The user has to
ship "rules" files in some subdirectories to tell \fBpcd2html\fR how
to convert the images from the Kodak Photo CD to JPG images which
will be included in the pages.

.SH OPTIONS
.TP
none
\fBpcd2html\fR searches for a rules file which specifies in which
subdirectories \fBpcd2html\fR should work.  According to the rules files
in these subdirectories the JPG images and HTML pages with thumb-nails and
links are build.
.TP
.B data
store all files called rules and extra as well as files with the extensions
".eng", ".deu", ".tec" and "drf" into a tar.gz archive.
.TP
.B html
store all created HTML and JPG files into a tar.gz archive
.TP
.B clean
clean unnecessary data files used temporarily by \fBpcd2html\fR
.TP
.B distclean
clean all files which \fBpcd2html\fR has created

.SH SYNTAX OF THE rules FILE

# Comments start with a `#` in the first column of a row
<\fIkey:nnn\fR> <\fIimage_name\fR> [\fB[\fR<\fIconvert_options\fR>\fB]\fR] [\fB!\fR<\fIi\fR>] [\fBQ\fR<\fIq\fR>]
.P
To descibe an image a specifying <\fIkey\fR> for the Kodak Photo CD and
the number of the image <\fInnn\fR> is required.  Used are only the
last three digits (because they are significant). So you have to type
three valid digits specifying the file
.br
   photo_cd/images/img0<\fInnn\fR>.pcd
.br
on a Photo CD.
.br
The <\fIkey\fR>s of all used Kodak Photo CDs are stored in the file
\fI$(HOME)/.pcd2html\fR> for each user.  It is generated when a new
Kodak Photo CD is used and can be determined automatically from
internal data later.
.P
The \fIimage_name\fR is the second required value which tells \fBpcd2html\fR
how to name the JPG image.  This is build the following way:
.br
   <\fIkey_nnn\fR><\fIimage_name\fR>.jpg
.br
It is considered to be useful to save the original number for reasons
of sorting the images later and comparing with the Photo CD index.
The image name should be reasonable human readable.
.P
The optional \fIconvert_options\fR given in \fB[]\fR could contain
any valid option for the \fBconvert\fR program of the ImageMagick
package (see convert(1)).
.P
The optional argument \fB!\fR<\fIi\fR> specifies the magnification
of the Photo CD image that should be used.  \fIi\fR has to be a number
between 1 and 5.  By default \fIi\fR is 3 and can be left out.
.P
To change the Jpeg quality \fBQ\fR<\fIq\fR> the user has the possibility
to get the result more or less compressed.  By default a compression of
75% (convert -quality 75) is used.  The number \fIq\fR will be
used as quality argument of \fBconvert\fR and all values which are valid
in this case are valid here.

.SH CAVEATS
The system was tested very rarely.
Expect to get failures.
.P
Please send any comment about the style of the HTML pages
(which is defined in pcd.css) to <tille@debian.org>.
	
.SH DEPENDS

The package depends from convert which is contained in the ImageMagick
package available from
.TP
   ftp://ftp.wizards.dupont.com/pub/ImageMagick/
   
.SH SEE ALSO

perl(1p), make(1), bash(1), sed(1), grep(1)
   
.SH BUGS
Expect each kind of bugs.  Expect destroying your hard-disk, 
cdrom, the whole computer and the children of your cat.
Don't say you was not warned!

.SH AUTHOR
Andreas Tille <tille@debian.org>
.br
http://fam-tille.de/