root/trunk/man/pdfcube.1

Revision 73, 4.1 KB (checked in by mirko, 8 weeks ago)

Preparing for 0.0.5 release.

Line 
1.TH "\fBpdfcube\fR"  "1" "03/2012" "pdfcube 0.0.5" "pdfcube presentation viewer"
2.SH "NAME"
3\fBpdfcube\fP - a PDF presentation viewer with 3D effects.
4.SH "SYNOPSIS"
5.HP 24
6\fBpdfcube\fP [\fIFILE\fP] [\fB--help\fP] [\fB--bgcolor\fP \fIf:f:f\fP] \
7[\fB--top-color\fP \fIf:f:f\fP] [\fB--no-fullscreen\fP] [\fB--demo\fP] \
8[\fB--program\fP \fIn:x:n:x:...\fP]
9.SH "DESCRIPTION"
10.PP
11\fBpdfcube\fP(1) is a tiny (about 30KiB) viewer for Portable Document
12Format (PDF) files that adds spinning cube transition effect to your
13PDF presentation files. It can also zoom on 5 predefined areas with a
14smooth zooming effect. This program is suited only for landscape PDF
15files, mostly presentations done with LaTeX (Beamer, Prosper, etc.) or
16OpenOffice.org Impress.
17.PP
18If FILE is not given a file\-open dialog box is shown to the user.
19.PP
20\fBpdfcube\fP(1) is an open source, low-effort, spare-time, money-less
21project. Your help is welcome!
22.SH "OPTIONS"
23.TP
24\fB\-h\fR [ \fB\-\-help\fR ]
25This help message.
26.TP
27\fB\-v\fR [ \fB\-\-version\fR ]
28Version information
29.TP
30\fB\-b\fR [ \fB\-\-bgcolor\fR ] arg
31Background color is 'r:g:b' with real values between
320.0 and 1.0, no spaces.
33.TP
34\fB\-t\fR [ \fB\-\-top\-color\fR ] arg
35Cube top color in 'r:g:b' format again with reals in
36[0,1].
37.TP
38\fB\-n\fR [ \fB\-\-no\-fullscreen\fR ]
39Don't activate full\-screen mode by default.
40.TP
41\fB\-\-demo\fR Automatically auto-advance presentation based on the
42frame duration PDF attribute (\\transduration when using Latex Beamer)
43or the specified program (see the \-\-program option).
44.TP
45\fB\-\-program\fR A program in the form
46n:x:n:x:n:x... where n are durations in seconds and "x" can be either
47"c" for cube transition and "p" for plain
48transition. (e.g. \-\-program 5:c:3:p). The last program is used for
49all remaining slides.
50.PP
51.SS Notes
52The first (and only) non\-option string is treated as the input file.
53.SH "INTERACTIVE CONTROL"
54.TP
55\fBc, a\fP
56Will display the next/previous page with a cube transition effect.
57.TP
58\fBSPACE, PG-DOWN\fP
59Will switch to the next page with the programmed effect.
60.TP
61\fBh, j, k, l, z\fP
62Will zoom into the predefined areas.
63.TP
64\fBg\fP
65Will undo any zoom.
66.TP
67\fBESC, Ctrl-q\fP
68Will exit pdfcube immediately.
69.TP
70\fBPG-UP, Left-Arrow\fP
71Will quick-switch to the previous page.
72.TP
73\fBRight-Arrow\fP
74Will quick-switch to the next page.
75.TP
76\fBf\fP
77Will toggle full\-screen mode.
78.TP
79\fBt\fP
80Will toggle auto-advance (demo) mode.
81.TP
82\fBCtrl-l\fP
83Will redraw the screen.
84.TP
85\fBCtrl-1, Ctrl-2, ..., Ctrl-9\fP
86Will jump to the page corresponding to the n-th programmed transition (if any).
87.TP
88\fB1, 2, ..., 9\fP
89Will jump to page 5*(n-1).
90.SH "CONFIGURATION FILE"
91.PP
92If the \fI~/.pdfcuberc\fP file exists, it is used as a configuration
93file. The configuration file uses the same options as the command line
94(using the boost program options syntax). e.g.
95.PP
96.RS
97.br
98demo=true
99.br
100bgcolor=0:0:0
101.br
102program=5:p
103.RE
104.SH "EXAMPLES"
105.TP
106\fBpdfcube\fP foo.pdf
107Will display 'foo.pdf' in full-screen.
108.TP
109\fBpdfcube\fP --demo --program 5:c foo.pdf
110Will display 'foo.pdf' in full-screen and will do a cube transition
111every 5 seconds.
112.TP
113\fBpdfcube\fP foo.pdf \fB--bgcolor\fP 0:0:0 \fB--top-color\fP 0.6:0.2:0.2
114Will display 'foo.pdf' with custom background and cube color.
115.SH "BUGS"
116.PP
117On some systems color values are locale dependent (e.g. you may have
118to write 0,6 instead of 0.6)
119.PP
120See http://code.100allora.it/pdfcube/report/ for the bugtracker of
121\fBpdfcube\fP(1) (you should obtain an account contacting the author
122first). Or please report any bug to the author.
123.SH "AUTHORS"
124Written by Mirko Maischberger <mailto:mirko.maischberger@gmail.com>
125and Karol Sokolowsky <sokoow@gmail.com>
126.SH "RESOURCES"
127Main web site: http://code.100allora.it/pdfcube/
128.SH "THANKS"
129I'd like to thank the LILiK laboratory in Florence, Italy for having
130teached me the value of open-source and open-culture.
131.SH "COPYING"
132This manpage is available under the same GPL v2 or later license as
133the main program, the original manpage was written by Alexander Wirt
134<mailto:formorer@debian.org> for the Debian distribution. The 0.0.5
135version is Copyright (C) 2008-2012 Mirko Maischberger.
Note: See TracBrowser for help on using the browser.