Beautify the manual.
[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 Transitional//EN"
3     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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       <thead>
21         <tr>
22           <td>
23             <p class="previous"><a href="options_filtering.html">Previous</a>
24             </p>
25           </td>
26
27           <td>
28             <p class="navtop_title">Editors &ndash; Options Explained</p>
29           </td>
30
31           <td>
32             <p class="next"><a href="options_advanced.html">Next</a>
33             </p>
34           </td>
35         </tr>
36       </thead>
37     </table>
38   </div>
39
40   <hr />
41
42   <h1>Editor Commands</h1>
43
44   <p>This section describes the options presented under the Editors Tab of the preferences dialog.</p>
45
46   <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>
47
48   <dl class="dialog_desc">
49   <dt>Menu name</dt>
50   <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 <u>Command Line</u> field.</p></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           </tbody>
123           </table>
124   </div>
125   </dd>
126
127
128   <dt>Help button</dt>
129   <dd><p>Displays reference list of the supported command macros.</p></dd>
130
131   <dt>Defaults button</dt>
132   <dd><p>Resets all commands to the default settings, discarding any customizations made by the user.</p></dd>
133   
134   </dl>
135
136   <hr id="bottomseparator" />
137
138   <div class="navbottom">
139     <table width="100%" border="0" cellpadding="4" cellspacing="0">
140       <col id="navbottom_col1" width="33%"></col>
141       <col id="navbottom_col2" width="33%"></col>
142       <col id="navbottom_col3" width="33%"></col>
143
144       <thead>
145         <tr>
146           <td>
147             <p class="previous"><a href="options_filtering.html">Previous</a>
148             </p>
149           </td>
150
151           <td>
152             <p class="navbottom_title"><a href="index.html">Contents</a>
153             </p>
154           </td>
155
156           <td>
157             <p class="next"><a href="options_advanced.html">Next</a>
158             </p>
159           </td>
160         </tr>
161       </thead>
162
163     </table>
164   </div>
165
166   <div class="footer">Geeqie User Manual</div>
167   <div class="bottomspacer">&nbsp;</div>
168 </body>
169 </html>