view doc/bins_edit.1 @ 6:3021deef1599

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

.TH "BINS" "1" 
.SH "NAME" 
bins_edit \(em Set fields in XML picture description files for BINS 
.SH "SYNOPSIS" 
.PP 
\fBbins_edit\fR [\fB-a\fP  | \fB\-\-album\fP ]  [\fB-m\fP  | \fB\-\-html\fP ]  [\fB-t \fItitle\fR\fP  | \fB\-\-title \fItitle\fR\fP ]  [\fB-e \fIevent\fR\fP  | \fB\-\-event \fIevent\fR\fP ]  [\fB-l \fIlocation\fR\fP  | \fB\-\-location \fIlocation\fR\fP ]  [\fB-p \fIpeople\fR\fP  | \fB\-\-people \fIpeople\fR\fP ]  [\fB-y \fIdate\fR\fP  | \fB\-\-date \fIdate\fR\fP ]  [\fB-d \fIdescription\fR\fP  | \fB\-\-description \fIdescription\fR\fP ]  [\fB\-\-longdesc \fIlongDescription\fR\fP]  [\fB\-\-shortdesc \fIshortDescription\fR\fP]  [\fB\-\-sample \fIpictureFileName\fR\fP]  [\fB-g  \fItag\fR=\fIvalue\fR\fP  | \fB\-\-generic \fItag\fR=\fIvalue\fR\fP ]  [\fB-h\fP  | \fB\-\-help\fP ]  [\fB-v\fP  | \fB\-\-verbose\fP ]  [\fB-q\fP  | \fB\-\-quiet\fP ]  [\fIfile\fR]  [\fIfiles\fR \&...]  
.SH "DESCRIPTION" 
.PP 
This manual page documents briefly the 
\fBbins_edit\fR command. 
.PP 
This manual page was written for the \fBDebian\fP distribution 
because the original program does not have a manual page. 
Instead, it has documentation in HTML in 
\fB/usr/share/doc/bins/index.html\fP as well as a 
\fB\-\-help\fP option. 
.PP 
\fBbins_edit\fR sets values in the XML 
picture description files that \fBbins\fR(1) uses 
to generate galleries. 
 
.SH "OPTIONS" 
.PP 
This program follows the usual GNU command line syntax, 
with long options starting with two dashes (`\-').  A summary of 
options is included below. 
.IP "\fIfile\fR" 10 
By default, \fIfile\fR is the 
filename of the XML file with the image 
properties.  If the argument has no 
\fB.xml\fP 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. 
.IP "" 10 
If the \fB\-\-album\fP option is given, the 
filename refers to the directory of images, and the 
\fBalbum.xml\fP in that directory will be 
modified instead. 
.IP "\fB-a\fP" 10 
.IP "\fB\-\-album\fP" 10 
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 \fB\-\-title\fP, \fB\-\-longdesc\fP, \fB\-\-shortdesc\fP and \fB\-\-sample\fP                    switches make sense with this option. 
.IP "\fB-m\fP" 10 
.IP "\fB\-\-html\fP" 10 
input value will be interpreted as HTML code, thus, 
no HTML encoding or quoting will be done. 
.IP "\fB-t \fItitle\fR\fP" 10 
.IP "\fB\-\-title \fItitle\fR\fP" 10 
Set the title (of an image.) 
.IP "\fB-e \fIevent\fR\fP" 10 
.IP "\fB\-\-event \fIevent\fR\fP" 10 
Set the event name (of an album or image.) 
.IP "\fB-l \fIlocation\fR\fP" 10 
.IP "\fB\-\-location \fIlocation\fR\fP" 10 
Set the location (of an image.) 
.IP "\fB-p \fIpeople\fR\fP" 10 
.IP "\fB\-\-people \fIpeople\fR\fP" 10 
Set the list of people (of an image.) 
.IP "\fB-y \fIdate\fR\fP" 10 
.IP "\fB\-\-date \fIdate\fR\fP" 10 
Set the date (of an image.) 
.IP "\fB-d \fIdescription\fR\fP" 10 
.IP "\fB\-\-description \fIdescription\fR\fP" 10 
Set the description (of an image.) 
.IP "\fB\-\-longdesc \fIlongDescription\fR\fP" 10 
Set the long description (of an album.) 
.IP "\fB\-\-shortdesc \fIshortDescription\fR\fP" 10 
Set the short description (of an album.) 
.IP "\fB\-\-sample \fIpictureFileName\fR\fP" 10 
Select the sample picture, within this album, to be 
used on the album list (template 
\fBsubalbum.html\fP.) Note that the 
filename is relative to the album directory, and thus 
doesn't have a directory component. 
.IP "\fB-g  \fItag\fR=\fIvalue\fR\fP" 10 
.IP "\fB\-\-generic \fItag\fR=\fIvalue\fR\fP" 10 
This lets you set arbitrary fields in the relevant 
XML file (of the image or the album.) 
Generic tags appear inside \fBdescription\fP 	    which appears inside \fBimage\fP; the 
\fItag\fR appears as the 
\fBname\fP attribute of a 
\fBfield\fP element, and the 
\fIvalue\fR appears as the content of 
the element. 
.IP "\fB-h\fP" 10 
.IP "\fB\-\-help\fP" 10 
Gives quick help (which this man page is based on.) 
.IP "\fB-v\fP" 10 
.IP "\fB\-\-verbose\fP" 10 
This switch can appear several times to increase 
verbosity level. 
.IP "\fB-q\fP" 10 
.IP "\fB\-\-quiet\fP" 10 
Suppress output. 
.SH "EXAMPLES" 
.PP 
Set the title of the \fBImage.jpg\fP file to "My picture": 
 
.PP 
\fBbins_edit \-t "My picture" Image.jpg\fR 
 
.PP 
Set the title and location of all JPEG pictures in the directory: 
 
.PP 
\fBbins_edit \-\-title Holiday \-\-location Paris *.jpg\fR 
 
.PP 
Use of HTML values: 
 
.PP 
\fBbins_edit \-\-html \-\-description '<b>BINS</b> is cool' file.jpg\fR 
 
.PP 
Set the title short description and sample image of the album  
in the current directory (note the dot as final parameter): 
 
.PP 
\fBbins_edit \-a \-t "My Album" \-\-sample image.jpg \-\-shortdesc "This is my album" .\fR 
 
.SH "SEE ALSO" 
.PP 
bins (1). 
.SH "AUTHOR" 
.PP 
This manual page was written by Mark W. Eichin eichin@thok.org for 
the \fBDebian\fP system (but may be used by others).  As it is 
mostly derived from the \fBbins_edit\fP program 
itself, it is covered by the GNU General Public License. 
.\" created by instant / docbook-to-man, Mon 22 Aug 2005, 01:55