Standardize on Unix LF line terminators
[geeqie.git] / doc / docbook / GuideReferenceStandardPlugins.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideReferenceStandardPlugins">
3   <title id="titleGuideReferenceStandardPlugins">Standard Plugins</title>
4   <para>The following plugins are supplied as standard with Geeqie.</para>
5   <section id="EditUFRawIDfile">
6     <title>Edit UFRaw ID file</title>
7     <para>Creates a UFRaw ID file for each of the selected files.</para>
8     <para>
9       This item is displayed in the
10       <emphasis role="strong">Edit</emphasis>
11       menu.
12     </para>
13   </section>
14   <section id="UFRawBatch">
15     <title>UFRaw Batch</title>
16     <para>
17       Searches for new RAW files or for modified UFRaw 
18       ID files and processes them with
19       <code>ufraw-batch</code>
20       .
21     </para>
22     <para>
23       This item is displayed in the
24       <emphasis role="strong">Edit</emphasis>
25       menu.
26     </para>
27   </section>
28   <section id="UFRawBatchrecursive">
29     <title>UFRaw Batch recursive</title>
30     <para>As above, with a recursive search.</para>
31     <para>
32       This item is displayed in the
33       <emphasis role="strong">Edit</emphasis>
34       menu.
35     </para>
36   </section>
37   <section id="Symlink">
38     <title>Symlink</title>
39     <para>Creates a symbolic link on the selected files. If a file has sidecars, they will also be symlinked.</para>
40     <para>
41       This item is displayed in the
42       <emphasis role="strong">File</emphasis>
43       menu.
44     </para>
45   </section>
46   <section id="Applytheorientationtoimagecontent">
47     <title>Apply the orientation to image content</title>
48     <para>This command affects only jpeg, tiff and png files. The image file on disk is rotated to the orientation as specified by its Exif Orientation tag.</para>
49     <warning>
50       <para>External commands exiftran, exiv2 and mogrify, are used to implement this command.</para>
51     </warning>
52     <para>
53       This item is displayed in the
54       <emphasis role="strong">Edit/Orientation</emphasis>
55       menu.
56     </para>
57   </section>
58   <section id="Cameraimport">
59     <title>Camera import</title>
60     <para>Imports images from an attached camera to the current folder. If a file with the same name already exists it will not be overwritten, and the new image will not be downloaded.</para>
61     <para>File names on digital cameras are not necessarily unique. In some cases the same file name can exist in more than one sub-folder on the camera. As existing images will not be overwritten, subsequent files of the same name will not be downloaded. In this case a dialog will be shown to warn you of this.</para>
62     <para>
63       You may use the gphoto2 option
64       <code>--filename</code>
65       option to ensure that all filenames are unique when downloading. Refer to the
66       <ulink url="http://www.gphoto.org/doc/manual/ref-gphoto2-cli.html">gphoto2 documentation.</ulink>
67     </para>
68     <para>
69       This item is displayed in the
70       <emphasis role="strong">Plugins</emphasis>
71       menu.
72     </para>
73   </section>
74   <section id="Exportjpeg">
75     <title>Export jpeg</title>
76     <para>
77       Extracts an embedded jpeg from a raw image to a file in the
78       <code>/tmp</code>
79       folder. If you wish to to keep this image, it must be copied or moved.
80       <para />
81       If
82       <code>jpgicc</code>
83       is installed, the image will be colour-corrected for the currently selected rendering intent.
84     </para>
85     <para>
86       This item is displayed in the
87       <emphasis role="strong">Plugins</emphasis>
88       menu.
89     </para>
90   </section>
91   <section id="Imagecrop">
92     <title>Image crop</title>
93     <para>
94       If rectangle coordinates have been set by
95       <emphasis role="strong">Edit/Draw Rectangle</emphasis>
96       , a cropped image will be stored in the
97       <code>/tmp</code>
98       folder. If you wish to to keep this image, it must be copied or moved.
99     </para>
100     <para>
101       This item is displayed in the
102       <emphasis role="strong">Plugins</emphasis>
103       menu.
104     </para>
105   </section>
106   <section id="Randomimage">
107     <title>Random image</title>
108     <para>Selects and displays a random image from a list of all images in Collections and the currently displayed folder.</para>
109     <para>
110       This item is displayed in the
111       <emphasis role="strong">Plugins</emphasis>
112       menu.
113     </para>
114   </section>
115   <section id="Tetheredphotography">
116     <title>Tethered photography</title>
117     <para>
118       If a camera is connected to the computer via USB, photos taken are immediately downloaded to the current folder and displayed on the computer.
119       <para />
120       If a file already exists with the same name, it is not overwritten but the download will not take place.
121       <para />
122       Auto-rename can be achieved with the --filename option of gphoto2.
123       <para />
124       In file
125       <code>$HOME/.config/gphoto2/settings</code>
126       , set the option:
127       <code>gphoto2=filename=&lt;see the gphoto2 manual&gt;</code>
128     </para>
129     <para>
130       This item is displayed in the
131       <emphasis role="strong">Plugins</emphasis>
132       menu.
133     </para>
134   </section>
135 </section>