18b7bf7e278784c055da0c63babcad3924503c33
[geeqie.git] / doc / options_editor_commands.html
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7   <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" />
8
9   <title>Editor Options - Geeqie User Manual</title>
10   <link rel="stylesheet" type="text/css" href="style.css" />
11 </head>
12
13 <body lang="en-US" dir="ltr" xml:lang="en-US">
14   <div class="navtop">
15     <table width="100%" border="0" cellpadding="4" cellspacing="0">
16       <col id="navtop_col1" width="33%"></col>
17       <col id="navtop_col2" width="33%"></col>
18       <col id="navtop_col3" width="33%"></col>
19
20         <tr>
21           <th>
22             <p class="previous"><a href="options_filtering.html">Previous</a>
23             </p>
24           </th>
25
26           <th>
27             <p class="navtop_title">Editors &ndash; Options Explained</p>
28           </th>
29
30           <th>
31             <p class="next"><a href="options_properties.html">Next</a>
32             </p>
33           </th>
34         </tr>
35     </table>
36   </div>
37
38   <hr />
39
40   <h1>Editor Commands</h1>
41
42   <p>This section describes the options presented under the Editors Tab of the preferences dialog.</p>
43
44   <p>Geeqie includes ten entries that can be used for executing other applications or shell commands with the selected image. These commands are accessible by menu and keyboard shortcuts. The keyboard shortcuts use [Control] + [1] through [Control] + [0], which correspond to lines one through ten in the preferences dialog.</p>
45
46   <dl class="dialog_desc">
47   <dt>Menu name</dt>
48   <dd><p>This field is used to represent the command in the menus of Geeqie, it is intended to describe the application or function that results from executing the command in the <em>Command Line</em> field.</p>
49   <p>External command Copy/Move/Rename/Delete/New Folder allows to specify commands to use for these operations. When set, internal operations will be disabled and these commands used instead.</p>
50   </dd>
51
52  
53   <dt>Command Line</dt>
54   <dd><p>This field is the command to execute. Several macros are available to position image file names within the command. If no macro is specified, the behavior will be to append the filenames onto the end of the command (the result will be the same as &ldquo;<i>command %f</i>&rdquo;).</p>
55   
56   <div class="macro_description">
57        <table width="80%" border="0" cellpadding="4" cellspacing="0" rules="rows">
58        <col id="macro_description_col1" width="20%"></col>
59        <col id="macro_description_col2" width="80%"></col>
60        
61        <thead>
62             <tr>
63               <td>
64                 <p>Macro</p>
65               </td>
66
67               <td>
68                 <p>Description</p>
69               </td>
70             </tr>
71        </thead>
72        <tbody>
73             <tr>
74               <td>
75                 <p>%f</p>
76               </td>
77
78               <td>
79                 <p>Inserts list of selected files, may occur only once.</p>
80               </td>
81             </tr>
82
83             <tr>
84               <td>
85                 <p>%p</p>
86               </td>
87
88               <td>
89                 <p>Command is executed once for each selected file, may occur multiple times.</p>
90               </td>
91             </tr>
92
93             <tr>
94               <td>
95                 <p>%v</p>
96               </td>
97
98               <td>
99                 <p>Display the result of the command in an output window. Must occur as the first two characters, or immediately after the &ldquo;%w&rdquo; macro.</p>
100               </td>
101             </tr>
102
103             <tr>
104               <td>
105                 <p>%V</p>
106               </td>
107
108               <td>
109                 <p>Like %v above, but when used with %p, only displays output window when multiple files are selected; The output of a single file is suppressed.</p>
110               </td>
111             </tr>
112
113             <tr>
114               <td>
115                 <p>%w</p>
116               </td>
117
118               <td>
119                 <p>Prevent full screen from deactivating when command is executed. Must occur as the first two characters.</p>
120               </td>
121             </tr>
122             <tr>
123               <td>
124                 <p>%%</p>
125               </td>
126
127               <td>
128                 <p>This will be replaced by one '%'. This is the way to escape '%'.</p>
129               </td>
130             </tr>
131             <tr>
132               <td>
133                 <p>%d</p>
134               </td>
135
136               <td>
137                 <p>This only makes sense for external commands like copy or move as this is replaced by the destination.</p>
138               </td>
139             </tr>
140
141           </tbody>
142           </table>
143   </div>
144   </dd>
145
146
147   <dt>Help button</dt>
148   <dd><p>Displays reference list of the supported command macros.</p></dd>
149
150   <dt>Defaults button</dt>
151   <dd><p>Resets all commands to the default settings, discarding any customizations made by the user.</p></dd>
152   
153   </dl>
154
155   <hr id="bottomseparator" />
156
157   <div class="navbottom">
158     <table width="100%" border="0" cellpadding="4" cellspacing="0">
159       <col id="navbottom_col1" width="33%"></col>
160       <col id="navbottom_col2" width="33%"></col>
161       <col id="navbottom_col3" width="33%"></col>
162
163         <tr>
164           <th>
165             <p class="previous"><a href="options_filtering.html">Previous</a>
166             </p>
167           </th>
168
169           <th>
170             <p class="navbottom_title"><a href="index.html">Contents</a>
171             </p>
172           </th>
173
174           <th>
175             <p class="next"><a href="options_properties.html">Next</a>
176             </p>
177           </th>
178         </tr>
179
180     </table>
181   </div>
182
183   <div class="footer">Geeqie User Manual</div>
184   <div class="bottomspacer">&nbsp;</div>
185 </body>
186 </html>