Mercurial > bins

view doc/bins_edit_man.html @ 6:3021deef1599

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Encoding related fixes * chomp encoding string * reformat else (seems someone hacked it in) * debug print encoding * do not use :utf8 binmode ("re-encode") on written file if the input is _already_ UTF-8
author Peter Gervai <grin@grin.hu>
date Thu, 16 Oct 2008 00:02:14 +0200
parents a84c32f131df
children
line wrap: on
line source

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>BINS</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="AEN1"
></A
>BINS</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN15"
></A
><H2
>Name</H2
>bins_edit&nbsp;--&nbsp;Set fields in XML picture description files for BINS</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN18"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>bins_edit</B
>  [<CODE
CLASS="OPTION"
>-a</CODE
> | <CODE
CLASS="OPTION"
>--album</CODE
>] [<CODE
CLASS="OPTION"
>-m</CODE
> | <CODE
CLASS="OPTION"
>--html</CODE
>] [<CODE
CLASS="OPTION"
>-t <TT
CLASS="REPLACEABLE"
><I
>title</I
></TT
></CODE
> | <CODE
CLASS="OPTION"
>--title <TT
CLASS="REPLACEABLE"
><I
>title</I
></TT
></CODE
>] [<CODE
CLASS="OPTION"
>-e <TT
CLASS="REPLACEABLE"
><I
>event</I
></TT
></CODE
> | <CODE
CLASS="OPTION"
>--event <TT
CLASS="REPLACEABLE"
><I
>event</I
></TT
></CODE
>] [<CODE
CLASS="OPTION"
>-l <TT
CLASS="REPLACEABLE"
><I
>location</I
></TT
></CODE
> | <CODE
CLASS="OPTION"
>--location <TT
CLASS="REPLACEABLE"
><I
>location</I
></TT
></CODE
>] [<CODE
CLASS="OPTION"
>-p <TT
CLASS="REPLACEABLE"
><I
>people</I
></TT
></CODE
> | <CODE
CLASS="OPTION"
>--people <TT
CLASS="REPLACEABLE"
><I
>people</I
></TT
></CODE
>] [<CODE
CLASS="OPTION"
>-y <TT
CLASS="REPLACEABLE"
><I
>date</I
></TT
></CODE
> | <CODE
CLASS="OPTION"
>--date <TT
CLASS="REPLACEABLE"
><I
>date</I
></TT
></CODE
>] [<CODE
CLASS="OPTION"
>-d <TT
CLASS="REPLACEABLE"
><I
>description</I
></TT
></CODE
> | <CODE
CLASS="OPTION"
>--description <TT
CLASS="REPLACEABLE"
><I
>description</I
></TT
></CODE
>] [<CODE
CLASS="OPTION"
>--longdesc <TT
CLASS="REPLACEABLE"
><I
>longDescription</I
></TT
></CODE
>] [<CODE
CLASS="OPTION"
>--shortdesc <TT
CLASS="REPLACEABLE"
><I
>shortDescription</I
></TT
></CODE
>] [<CODE
CLASS="OPTION"
>--sample <TT
CLASS="REPLACEABLE"
><I
>pictureFileName</I
></TT
></CODE
>] [<CODE
CLASS="OPTION"
>-g  <TT
CLASS="REPLACEABLE"
><I
>tag</I
></TT
>=<TT
CLASS="REPLACEABLE"
><I
>value</I
></TT
></CODE
> | <CODE
CLASS="OPTION"
>--generic <TT
CLASS="REPLACEABLE"
><I
>tag</I
></TT
>=<TT
CLASS="REPLACEABLE"
><I
>value</I
></TT
></CODE
>] [<CODE
CLASS="OPTION"
>-h</CODE
> | <CODE
CLASS="OPTION"
>--help</CODE
>] [<CODE
CLASS="OPTION"
>-v</CODE
> | <CODE
CLASS="OPTION"
>--verbose</CODE
>] [<CODE
CLASS="OPTION"
>-q</CODE
> | <CODE
CLASS="OPTION"
>--quiet</CODE
>] [<TT
CLASS="REPLACEABLE"
><I
>file</I
></TT
>] [<TT
CLASS="REPLACEABLE"
><I
>files</I
></TT
>...]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN110"
></A
><H2
>DESCRIPTION</H2
><P
>This manual page documents briefly the
      <B
CLASS="COMMAND"
>bins_edit</B
> command.</P
><P
>This manual page was written for the <SPAN
CLASS="PRODUCTNAME"
>Debian</SPAN
> distribution
      because the original program does not have a manual page.
      Instead, it has documentation in <ACRONYM
CLASS="ACRONYM"
>HTML</ACRONYM
> in
      <TT
CLASS="FILENAME"
>/usr/share/doc/bins/index.html</TT
> as well as a
      <CODE
CLASS="OPTION"
>--help</CODE
> option.</P
><P
><B
CLASS="COMMAND"
>bins_edit</B
> sets values in the XML
      picture description files that <B
CLASS="COMMAND"
>bins</B
>(1) uses
      to generate galleries.
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN122"
></A
><H2
>OPTIONS</H2
><P
>This program follows the usual GNU command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="REPLACEABLE"
><I
>file</I
></TT
></DT
><DD
><P
>By default, <TT
CLASS="REPLACEABLE"
><I
>file</I
></TT
> is the
	    filename of the <ACRONYM
CLASS="ACRONYM"
>XML</ACRONYM
> file with the image
	    properties.  If the argument has no
	    <TT
CLASS="FILENAME"
>.xml</TT
> suffix, it is added, so you can directly give
	    picture names on the command line.  Spaces and other
	    special characters (even newlines) can be used in values
	    given as parameters as long as they are enclosed between
	    quotes.</P
><P
>If the <CODE
CLASS="OPTION"
>--album</CODE
> option is given, the
	    filename refers to the directory of images, and the
	    <TT
CLASS="FILENAME"
>album.xml</TT
> in that directory will be
	    modified instead.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-a</CODE
>, <CODE
CLASS="OPTION"
>--album</CODE
></DT
><DD
><P
>edit album description (instead of the default of
                   editing the image description.)
                   In this case, the file parameter must be the
                   source directory of the album.
                   Only the <CODE
CLASS="OPTION"
>--title</CODE
>, <CODE
CLASS="OPTION"
>--longdesc</CODE
>, <CODE
CLASS="OPTION"
>--shortdesc</CODE
> and <CODE
CLASS="OPTION"
>--sample</CODE
>
                   switches make sense with this option.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-m</CODE
>, <CODE
CLASS="OPTION"
>--html</CODE
></DT
><DD
><P
>input value will be interpreted as <ACRONYM
CLASS="ACRONYM"
>HTML</ACRONYM
> code, thus,
                   no HTML encoding or quoting will be done.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-t <TT
CLASS="REPLACEABLE"
><I
>title</I
></TT
></CODE
>, <CODE
CLASS="OPTION"
>--title <TT
CLASS="REPLACEABLE"
><I
>title</I
></TT
></CODE
></DT
><DD
><P
>Set the title (of an image.)</P
></DD
><DT
><CODE
CLASS="OPTION"
>-e <TT
CLASS="REPLACEABLE"
><I
>event</I
></TT
></CODE
>, <CODE
CLASS="OPTION"
>--event <TT
CLASS="REPLACEABLE"
><I
>event</I
></TT
></CODE
></DT
><DD
><P
>Set the event name (of an album or image.)</P
></DD
><DT
><CODE
CLASS="OPTION"
>-l <TT
CLASS="REPLACEABLE"
><I
>location</I
></TT
></CODE
>, <CODE
CLASS="OPTION"
>--location <TT
CLASS="REPLACEABLE"
><I
>location</I
></TT
></CODE
></DT
><DD
><P
>Set the location (of an image.)</P
></DD
><DT
><CODE
CLASS="OPTION"
>-p <TT
CLASS="REPLACEABLE"
><I
>people</I
></TT
></CODE
>, <CODE
CLASS="OPTION"
>--people <TT
CLASS="REPLACEABLE"
><I
>people</I
></TT
></CODE
></DT
><DD
><P
>Set the list of people (of an image.)</P
></DD
><DT
><CODE
CLASS="OPTION"
>-y <TT
CLASS="REPLACEABLE"
><I
>date</I
></TT
></CODE
>, <CODE
CLASS="OPTION"
>--date <TT
CLASS="REPLACEABLE"
><I
>date</I
></TT
></CODE
></DT
><DD
><P
>Set the date (of an image.)</P
></DD
><DT
><CODE
CLASS="OPTION"
>-d <TT
CLASS="REPLACEABLE"
><I
>description</I
></TT
></CODE
>, <CODE
CLASS="OPTION"
>--description <TT
CLASS="REPLACEABLE"
><I
>description</I
></TT
></CODE
></DT
><DD
><P
>Set the description (of an image.)</P
></DD
><DT
><CODE
CLASS="OPTION"
>--longdesc <TT
CLASS="REPLACEABLE"
><I
>longDescription</I
></TT
></CODE
></DT
><DD
><P
>Set the long description (of an album.)</P
></DD
><DT
><CODE
CLASS="OPTION"
>--shortdesc <TT
CLASS="REPLACEABLE"
><I
>shortDescription</I
></TT
></CODE
></DT
><DD
><P
>Set the short description (of an album.)</P
></DD
><DT
><CODE
CLASS="OPTION"
>--sample <TT
CLASS="REPLACEABLE"
><I
>pictureFileName</I
></TT
></CODE
></DT
><DD
><P
>Select the sample picture, within this album, to be
	    used on the album list (template
	    <TT
CLASS="FILENAME"
>subalbum.html</TT
>.) Note that the
	    filename is relative to the album directory, and thus
	    doesn't have a directory component.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-g  <TT
CLASS="REPLACEABLE"
><I
>tag</I
></TT
>=<TT
CLASS="REPLACEABLE"
><I
>value</I
></TT
></CODE
>, <CODE
CLASS="OPTION"
>--generic <TT
CLASS="REPLACEABLE"
><I
>tag</I
></TT
>=<TT
CLASS="REPLACEABLE"
><I
>value</I
></TT
></CODE
></DT
><DD
><P
>This lets you set arbitrary fields in the relevant
	    <ACRONYM
CLASS="ACRONYM"
>XML</ACRONYM
> file (of the image or the album.)
	    Generic tags appear inside <CODE
CLASS="SGMLTAG"
>description</CODE
>
	    which appears inside <CODE
CLASS="SGMLTAG"
>image</CODE
>; the
	    <TT
CLASS="REPLACEABLE"
><I
>tag</I
></TT
> appears as the
	    <CODE
CLASS="SGMLTAG"
>name</CODE
> attribute of a
	    <CODE
CLASS="SGMLTAG"
>field</CODE
> element, and the
	    <TT
CLASS="REPLACEABLE"
><I
>value</I
></TT
> appears as the content of
	    the element.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-h</CODE
>, <CODE
CLASS="OPTION"
>--help</CODE
></DT
><DD
><P
>Gives quick help (which this man page is based on.)</P
></DD
><DT
><CODE
CLASS="OPTION"
>-v</CODE
>, <CODE
CLASS="OPTION"
>--verbose</CODE
></DT
><DD
><P
>This switch can appear several times to increase
                   verbosity level.</P
></DD
><DT
><CODE
CLASS="OPTION"
>-q</CODE
>, <CODE
CLASS="OPTION"
>--quiet</CODE
></DT
><DD
><P
>Suppress output.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN268"
></A
><H2
>EXAMPLES</H2
><P
>Set the title of the <TT
CLASS="FILENAME"
>Image.jpg</TT
> file to "My picture":
      <P
><B
CLASS="COMMAND"
>bins_edit -t "My picture" Image.jpg</B
> </P
>
    </P
><P
>Set the title and location of all <ACRONYM
CLASS="ACRONYM"
>JPEG</ACRONYM
> pictures in the directory:
      <P
><B
CLASS="COMMAND"
>bins_edit --title Holiday --location Paris *.jpg</B
> </P
>
    </P
><P
>Use of <ACRONYM
CLASS="ACRONYM"
>HTML</ACRONYM
> values:
      <P
><B
CLASS="COMMAND"
>bins_edit --html --description '&#60;b&#62;BINS&#60;/b&#62; is cool' file.jpg</B
> </P
>
    </P
><P
>Set the title short description and sample image of the album 
      in the current directory (note the dot as final parameter):
      <P
><B
CLASS="COMMAND"
>bins_edit -a -t "My Album" --sample image.jpg --shortdesc "This is my album" .</B
> </P
>
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN285"
></A
><H2
>SEE ALSO</H2
><P
>bins (1).</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN288"
></A
><H2
>AUTHOR</H2
><P
>This manual page was written by Mark W. Eichin <CODE
CLASS="EMAIL"
>&#60;<A
HREF="mailto:eichin@thok.org"
>eichin@thok.org</A
>&#62;</CODE
> for
      the <SPAN
CLASS="PRODUCTNAME"
>Debian</SPAN
> system (but may be used by others).  As it is
      mostly derived from the <TT
CLASS="FILENAME"
>bins_edit</TT
> program
      itself, it is covered by the <ACRONYM
CLASS="ACRONYM"
>GNU</ACRONYM
> General Public License.</P
></DIV
></BODY
></HTML
>