~ubuntu-branches/ubuntu/saucy/darktable/saucy

« back to all changes in this revision

Viewing changes to doc/darktable.pod

  • Committer: Bazaar Package Importer
  • Author(s): David Bremner
  • Date: 2011-04-14 23:42:12 UTC
  • Revision ID: james.westby@ubuntu.com-20110414234212-kuffcz5wiu18v6ra
Tags: upstream-0.8
ImportĀ upstreamĀ versionĀ 0.8

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
=head1 NAME
 
3
 
 
4
darktable - a digital photography workflow application
 
5
 
 
6
=head1 SYNOPSIS
 
7
 
 
8
C<darktable [options] [{IMG_1234.RAW,/path/to/load/}]>
 
9
 
 
10
Options:
 
11
 
 
12
    --help        
 
13
    --version
 
14
    -d {cache,control,dev,fswatch,perf,all}
 
15
    --library override.db
 
16
    --disable-opencl
 
17
 
 
18
=head1 DESCRIPTION
 
19
 
 
20
B<darktable> is a digital photography workflow application for B<Linux> 
 
21
and B<Mac OS X> in the lines of B<Adobe Lightroom> and B<Apple Aperture>.
 
22
 
 
23
The application is designed to ease editing and consistent processing of large 
 
24
photo sessions and provides a easy to use digital light-table and a set 
 
25
of sophisticated postprocessing tools.
 
26
 
 
27
Most processing is done in 32-bit floating point per channel mode in device independent 
 
28
B<CIE L*a*b*> color space. B<darktable> is also fully color managed, which gives 
 
29
you full control over the look of the photos.
 
30
 
 
31
The application relies on a modern plug-in architecture thus making it easy for 
 
32
3rd party developers to extend the existing capabilities of the application. 
 
33
All light-table and darkroom features are implemented as plug-ins, so you can 
 
34
create your plug-ins reusing existing code.
 
35
 
 
36
=head1 COMMAND LINE ARGUMENTS
 
37
 
 
38
=over
 
39
 
 
40
=item B<IMG_1234.CR2 or /path/to/load/>
 
41
 
 
42
Loads the given image in darkroom mode, or imports the given folder.
 
43
 
 
44
=item B<-d control>
 
45
 
 
46
Enable job queue debugging. If you redirect darktables output to B<control.log> and
 
47
call B<./tools/create_control_svg.sh control.log>, you will get a nice B<control.svg>
 
48
with a visualization of the threads' work.
 
49
 
 
50
=item B<-d cache>
 
51
 
 
52
This will give you a lot of debugging info about the mipmap cache for light table mode. If
 
53
compiled in debug mode, this will also tell you where in the code a certain buffer has
 
54
last been locked.
 
55
 
 
56
=item B<-d perf>
 
57
 
 
58
Use this for performance tweaking your darkroom modules. It will rdtsc-measure the
 
59
runtimes of all plugins and print them to stdout.
 
60
 
 
61
=item B<-d all>
 
62
 
 
63
Enable all debugging output.
 
64
 
 
65
=item B<--library override.db>
 
66
 
 
67
Uses override.db instead of the gconf/darktablerc specified library file. Should be an absolute path.
 
68
 
 
69
=item B<--disable-opencl>
 
70
 
 
71
For opencl builds only. Disables GPU computing at runtime. Useful to check
 
72
for bugs in our opencl code and to avoid buggy drivers on certain machines.
 
73
 
 
74
=back
 
75
 
 
76
=head1 OTHER INFO
 
77
 
 
78
Please visit B<darktable>'s website for news, bug tracker and forum: L<http://darktable.sourceforge.net>
 
79
 
 
80
=head1 KEYBINDINGS
 
81
 
 
82
All modes:
 
83
 
 
84
=over
 
85
 
 
86
=item B<F11>
 
87
 
 
88
Switch between fullscreen and normal modes of the application's window
 
89
 
 
90
=item B<Tab>
 
91
 
 
92
Show/hide sidebars
 
93
 
 
94
=item B<e>
 
95
 
 
96
Switch between light-table and darkroom modes
 
97
 
 
98
=item B<F7>
 
99
 
 
100
Decrease contrast
 
101
 
 
102
=item B<F8>
 
103
 
 
104
Increase contrast
 
105
 
 
106
=back
 
107
 
 
108
Lighttable mode:
 
109
 
 
110
=over
 
111
 
 
112
=item B<alt-1>
 
113
 
 
114
Zoom in on image under cursor
 
115
 
 
116
=item B<alt-2, 3>
 
117
 
 
118
Adjust zoom
 
119
 
 
120
=item B<alt-4>
 
121
 
 
122
Zoom out completely
 
123
 
 
124
=item B<q>
 
125
 
 
126
Zoom out to fit all images in one row inside viewport, center on image under cursor
 
127
 
 
128
=item B<a, s, d, w>
 
129
 
 
130
Move around (arrows also work)
 
131
 
 
132
=item B<1, 2, 3, 4>
 
133
 
 
134
Star rating
 
135
 
 
136
=item B<ctrl-backspace>
 
137
 
 
138
Strip all stars (reject image)
 
139
 
 
140
=item B<F1, F2, F3>
 
141
 
 
142
Color labels: toggle red, yellow, green
 
143
 
 
144
=item B<ctrl-g, ctrl-shift-g> 
 
145
 
 
146
Move to top, bottom, respectively
 
147
 
 
148
=item B<ctrl-e>
 
149
 
 
150
Export selected images
 
151
 
 
152
=back
 
153
 
 
154
Darkroom mode:
 
155
 
 
156
=over
 
157
 
 
158
=item B<alt-1, 2, 3>
 
159
 
 
160
Zoom to 1:1, fill, and fit, respectively
 
161
 
 
162
=item B<ctrl-f>
 
163
 
 
164
show/hide film strip
 
165
 
 
166
=item while cropping: B<Enter/Backspace>
 
167
 
 
168
apply/revert currently selected cropping frame
 
169
 
 
170
=back
 
171
 
 
172
=head1 BUGS
 
173
 
 
174
Please use the mailing list to report all the bugs you run into.
 
175
 
 
176
=head1 AUTHORS
 
177
 
 
178
The principal developer of darktable is Johannes Hanika. The (hopefully)
 
179
complete list of contributors to the project is:
 
180
 
 
181
DREGGNAUTHORS
 
182
 
 
183
This man page was written by Alexandre Prokoudine 
 
184
E<lt>alexandre.prokoudine@gmail.comE<gt>.
 
185
 
 
186
=head1 HISTORY
 
187
 
 
188
The project was started by Johannes Hanika in early 2009 to fill the gap 
 
189
(or, rather, a black hole) of a digital photography workflow tool on Linux.
 
190
 
 
191
=head1 COPYRIGHT AND LICENSE
 
192
 
 
193
B<Copyright (C)> 2009-2010 by Authors.
 
194
 
 
195
B<darktable> is free software; you can redistribute it and/or modify it
 
196
under the terms of the GPL v3 or (at your option) any later version.
 
197
 
 
198
=for comment
 
199
$Date$