view doc/options_editor_commands.html @ 1640:ab5945017b4a

Update documentation Now it holds a more verbose doxygen description as discussed in mailing list. - Doxygen style description - Small visibility changes - Commit message change
author mow
date Sat, 13 Jun 2009 22:19:57 +0000
parents 2562e0bc89a1
children
line wrap: on
line source

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" />

  <title>Editor Options - Geeqie User Manual</title>
  <link rel="stylesheet" type="text/css" href="style.css" media="all" />
  <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" />
  <link rel="stylesheet" type="text/css" href="style_print.css" media="print" />
</head>

<body lang="en-US" dir="ltr" xml:lang="en-US">
  <div class="navtop">
    <table width="100%" border="0" cellpadding="4" cellspacing="0">
      <col id="navtop_col1" width="33%"></col>
      <col id="navtop_col2" width="33%"></col>
      <col id="navtop_col3" width="33%"></col>

        <tr>
          <th>
            <p class="previous"><a href="options_filtering.html">Previous</a>
            </p>
          </th>

          <th>
            <p class="navtop_title">Editors &ndash; Options Explained</p>
          </th>

          <th>
            <p class="next"><a href="options_properties.html">Next</a>
            </p>
          </th>
        </tr>
    </table>
  </div>

  <hr />

  <h1>Editor Commands</h1>

  <p>This section describes the options presented under the Editors Tab of the preferences dialog.</p>

  <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 <span class="key">Ctrl</span> + <span class="key">1</span> through <span class="key">Ctrl</span> + <span class="key">0</span>, which correspond to lines one through ten in the preferences dialog.</p>

  <dl class="dialog_desc">
  <dt>Menu name</dt>
  <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>
  <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>
  </dd>

 
  <dt>Command Line</dt>
  <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>
  
  <div class="macro_description">
       <table width="80%" border="0" cellpadding="4" cellspacing="0" rules="rows">
       <col id="macro_description_col1" width="20%"></col>
       <col id="macro_description_col2" width="80%"></col>
       
       <thead>
            <tr>
              <td>
                <p>Macro</p>
              </td>

              <td>
                <p>Description</p>
              </td>
            </tr>
       </thead>
       <tbody>
            <tr>
              <td>
                <p>%f</p>
              </td>

              <td>
                <p>Inserts list of selected files, may occur only once.</p>
              </td>
            </tr>

            <tr>
              <td>
                <p>%p</p>
              </td>

              <td>
                <p>Command is executed once for each selected file, may occur multiple times.</p>
              </td>
            </tr>

            <tr>
              <td>
                <p>%v</p>
              </td>

              <td>
                <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>
              </td>
            </tr>

            <tr>
              <td>
                <p>%V</p>
              </td>

              <td>
                <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>
              </td>
            </tr>

            <tr>
              <td>
                <p>%w</p>
              </td>

              <td>
                <p>Prevent full screen from deactivating when command is executed. Must occur as the first two characters.</p>
              </td>
            </tr>
	    <tr>
              <td>
                <p>%%</p>
              </td>

              <td>
                <p>This will be replaced by one '%'. This is the way to escape '%'.</p>
              </td>
            </tr>
	    <tr>
              <td>
                <p>%d</p>
              </td>

              <td>
                <p>This only makes sense for external commands like copy or move as this is replaced by the destination.</p>
              </td>
            </tr>

	  </tbody>
          </table>
  </div>
  </dd>


  <dt>Help button</dt>
  <dd><p>Displays reference list of the supported command macros.</p></dd>

  <dt>Defaults button</dt>
  <dd><p>Resets all commands to the default settings, discarding any customizations made by the user.</p></dd>
  
  </dl>

  <hr id="bottomseparator" />

  <div class="navbottom">
    <table width="100%" border="0" cellpadding="4" cellspacing="0">
      <col id="navbottom_col1" width="33%"></col>
      <col id="navbottom_col2" width="33%"></col>
      <col id="navbottom_col3" width="33%"></col>

        <tr>
          <th>
            <p class="previous"><a href="options_filtering.html">Previous</a>
            </p>
          </th>

          <th>
            <p class="navbottom_title"><a href="index.html">Contents</a>
            </p>
          </th>

          <th>
            <p class="next"><a href="options_properties.html">Next</a>
            </p>
          </th>
        </tr>

    </table>
  </div>

  <div class="footer">Geeqie User Manual</div>
  <div class="bottomspacer">&nbsp;</div>
</body>
</html>