view doc/bins-edit-gui.sgml @ 2:c44d020e5f8a 1.1.29-extended

Importing extended patched version from http://www.uli-eckhardt.de/bins/index.en.html
author Peter Gervai <grin@grin.hu>
date Wed, 15 Oct 2008 23:31:54 +0200 (2008-10-15)
parents a84c32f131df
children
line wrap: on
line source
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- This man page is Copyright 2002 Mark Eichin and released under -->
<!-- the GNU General Public License, Version 2. -->

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Mark</firstname>">
  <!ENTITY dhsurname   "<surname>Eichin</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>June 7, 2002</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>eichin@thok.org</email>">
  <!ENTITY dhusername  "Mark W. Eichin">
  <!ENTITY dhucpackage "<refentrytitle>BINS</refentrytitle>">
  <!ENTITY dhpackage   "bins-edit-gui">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; General Public License">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2002</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>Set fields in XML picture description files for BINS
      (using a GNOME-based GUI)</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg rep="repeat"><replaceable>files</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para><command>&dhpackage;</command> sets values in the XML
      picture description files that <command>bins</command>(1) uses
      to generate galleries.  It displays the image (scaled down to
      fit the window) and allows you to fill in the predefined fields
      (or add new ones.)  For command-line editing of the same data,
      see <command>bins_edit</command>(1).
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
    <para>This program follows the usual GNU command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.</para>

    <variablelist>
      <varlistentry>
	<term><replaceable>file</replaceable></term>
	<listitem>
	  <para><replaceable>file</replaceable> is the
	    filename of the image itself.</para>
	</listitem>
      </varlistentry>
      <varlistentry><term><option>-v</option></term><term><option>--version</option></term>        <listitem>
	  <para>Displays program version.</para>
	</listitem>
      </varlistentry>
      <varlistentry><term><option>-v</option></term><term><option>--version</option></term>        <listitem>
	  <para>Displays program version.</para>
	</listitem>
      </varlistentry>
      <varlistentry><term><option>-h</option></term><term><option>--help</option></term>        <listitem>
	  <para>Displays command-line options.</para>
	</listitem>
      </varlistentry>
      <varlistentry><term><option>--debug</option></term>        <listitem>
	  <para>Enables random developer debugging messages.</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>COMMANDS</title>
    <variablelist>
      <varlistentry>
	<term><keycode>C-n</keycode> <command>Next file</command></term>
	<listitem>
	  <para>Save current tags set (if any changes have been made)
	    and move on to the next image.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>M-Page Down</keycode> <command>Forward 10</command></term>
	<listitem>
	  <para>Save current tags set (if any changes have been made)
	    and skip forward by 10 files.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>C-p</keycode> <command>Previous file</command></term>
	<listitem>
	  <para>Save current tags set (if any changes have been made)
	    and move back to the previous image.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>M-Page Up</keycode> <command>Back 10</command></term>
	<listitem>
	  <para>Save current tags set (if any changes have been made)
	    and skip backwards by 10 files.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>M-Home</keycode> <command>Start of List</command></term>
	<listitem>
	  <para>Save current tags set (if any changes have been made)
	    and jump to the first file.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>M-End</keycode> <command>End of List</command></term>
	<listitem>
	  <para>Save current tags set (if any changes have been made)
	    and jump to the last file.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>M-a</keycode> <command>Auto-fill</command></term>
	<listitem>
	  <para>Fill in any blank fields with the values from the most
	    recently seen image.  Particularly useful for copying a
	    location or event across a set of images.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><command>Revert</command></term>
	<listitem>
	  <para>Reload tags from the <acronym>XML</acronym> file,
	    wiping unsaved changes.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>C-s</keycode> <command>Save</command></term>
	<listitem>
	  <para>Save changes, if any.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>F2</keycode> <command>Album</command></term>
	<listitem>
	  <para>Edit the album this picture is in.  (Under
	    construction, but functional.)</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>F3</keycode> <command>Open</command></term>
	<listitem>
	  <para>Not yet implemented.  Should provide a file browser later.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>&gt;</keycode> <command>Rotate Right</command></term>
	<listitem>
	  <para>Rotate image to the Right (Clockwise.)  Actually sets
	    the <sgmltag>Orientation</sgmltag> tag with
	    <sgmltag>priority</sgmltag> 1 so that it overrides the
	    corresponding <acronym>EXIF</acronym> tag; it does not
	    modify the image file itself.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><command>Cancel rotation</command></term>
	<listitem>
	  <para>Cancels any current changes to the rotation tags
	    (effectively, this is a "revert" function for the
	    rotation, it doesn't to back to the original
	    <acronym>EXIF</acronym> tags in the
	    <acronym>JPEG</acronym> file.)</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>&lt;</keycode> <command>Rotate Left</command></term>
	<listitem>
	  <para>Rotate image to the Left (Counter Clockwise.)  Actually sets
	    the <sgmltag>Orientation</sgmltag> tag with
	    <sgmltag>priority</sgmltag> 1 so that it overrides the
	    corresponding <acronym>EXIF</acronym> tag; it does not
	    modify the image file itself.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><keycode>C-q</keycode> <command>Quit</command></term>
	<listitem>
	  <para>Quit program, saving current changes (if any.)</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><command>About</command></term>
	<listitem>
	  <para>Display About box.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><command>License</command></term>
	<listitem>
	  <para>Display License box.</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>EXAMPLES</title>
    <para>Edit all the images in a directory:
      <cmdsynopsis>
	<command>bins-edit-gui $(find bins-picture-dir -name '*.jpg')</command>
      </cmdsynopsis>
    </para>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>bins (1), bins_edit (1).</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail;.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->