|
0
|
1 .TH "BINS" "1" |
|
|
2 .SH "NAME" |
|
|
3 bins_edit \(em Set fields in XML picture description files for BINS |
|
|
4 .SH "SYNOPSIS" |
|
|
5 .PP |
|
|
6 \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 \&...] |
|
|
7 .SH "DESCRIPTION" |
|
|
8 .PP |
|
|
9 This manual page documents briefly the |
|
|
10 \fBbins_edit\fR command. |
|
|
11 .PP |
|
|
12 This manual page was written for the \fBDebian\fP distribution |
|
|
13 because the original program does not have a manual page. |
|
|
14 Instead, it has documentation in HTML in |
|
|
15 \fB/usr/share/doc/bins/index.html\fP as well as a |
|
|
16 \fB\-\-help\fP option. |
|
|
17 .PP |
|
|
18 \fBbins_edit\fR sets values in the XML |
|
|
19 picture description files that \fBbins\fR(1) uses |
|
|
20 to generate galleries. |
|
|
21 |
|
|
22 .SH "OPTIONS" |
|
|
23 .PP |
|
|
24 This program follows the usual GNU command line syntax, |
|
|
25 with long options starting with two dashes (`\-'). A summary of |
|
|
26 options is included below. |
|
|
27 .IP "\fIfile\fR" 10 |
|
|
28 By default, \fIfile\fR is the |
|
|
29 filename of the XML file with the image |
|
|
30 properties. If the argument has no |
|
|
31 \fB.xml\fP suffix, it is added, so you can directly give |
|
|
32 picture names on the command line. Spaces and other |
|
|
33 special characters (even newlines) can be used in values |
|
|
34 given as parameters as long as they are enclosed between |
|
|
35 quotes. |
|
|
36 .IP "" 10 |
|
|
37 If the \fB\-\-album\fP option is given, the |
|
|
38 filename refers to the directory of images, and the |
|
|
39 \fBalbum.xml\fP in that directory will be |
|
|
40 modified instead. |
|
|
41 .IP "\fB-a\fP" 10 |
|
|
42 .IP "\fB\-\-album\fP" 10 |
|
|
43 edit album description (instead of the default of |
|
|
44 editing the image description.) |
|
|
45 In this case, the file parameter must be the |
|
|
46 source directory of the album. |
|
|
47 Only the \fB\-\-title\fP, \fB\-\-longdesc\fP, \fB\-\-shortdesc\fP and \fB\-\-sample\fP switches make sense with this option. |
|
|
48 .IP "\fB-m\fP" 10 |
|
|
49 .IP "\fB\-\-html\fP" 10 |
|
|
50 input value will be interpreted as HTML code, thus, |
|
|
51 no HTML encoding or quoting will be done. |
|
|
52 .IP "\fB-t \fItitle\fR\fP" 10 |
|
|
53 .IP "\fB\-\-title \fItitle\fR\fP" 10 |
|
|
54 Set the title (of an image.) |
|
|
55 .IP "\fB-e \fIevent\fR\fP" 10 |
|
|
56 .IP "\fB\-\-event \fIevent\fR\fP" 10 |
|
|
57 Set the event name (of an album or image.) |
|
|
58 .IP "\fB-l \fIlocation\fR\fP" 10 |
|
|
59 .IP "\fB\-\-location \fIlocation\fR\fP" 10 |
|
|
60 Set the location (of an image.) |
|
|
61 .IP "\fB-p \fIpeople\fR\fP" 10 |
|
|
62 .IP "\fB\-\-people \fIpeople\fR\fP" 10 |
|
|
63 Set the list of people (of an image.) |
|
|
64 .IP "\fB-y \fIdate\fR\fP" 10 |
|
|
65 .IP "\fB\-\-date \fIdate\fR\fP" 10 |
|
|
66 Set the date (of an image.) |
|
|
67 .IP "\fB-d \fIdescription\fR\fP" 10 |
|
|
68 .IP "\fB\-\-description \fIdescription\fR\fP" 10 |
|
|
69 Set the description (of an image.) |
|
|
70 .IP "\fB\-\-longdesc \fIlongDescription\fR\fP" 10 |
|
|
71 Set the long description (of an album.) |
|
|
72 .IP "\fB\-\-shortdesc \fIshortDescription\fR\fP" 10 |
|
|
73 Set the short description (of an album.) |
|
|
74 .IP "\fB\-\-sample \fIpictureFileName\fR\fP" 10 |
|
|
75 Select the sample picture, within this album, to be |
|
|
76 used on the album list (template |
|
|
77 \fBsubalbum.html\fP.) Note that the |
|
|
78 filename is relative to the album directory, and thus |
|
|
79 doesn't have a directory component. |
|
|
80 .IP "\fB-g \fItag\fR=\fIvalue\fR\fP" 10 |
|
|
81 .IP "\fB\-\-generic \fItag\fR=\fIvalue\fR\fP" 10 |
|
|
82 This lets you set arbitrary fields in the relevant |
|
|
83 XML file (of the image or the album.) |
|
|
84 Generic tags appear inside \fBdescription\fP which appears inside \fBimage\fP; the |
|
|
85 \fItag\fR appears as the |
|
|
86 \fBname\fP attribute of a |
|
|
87 \fBfield\fP element, and the |
|
|
88 \fIvalue\fR appears as the content of |
|
|
89 the element. |
|
|
90 .IP "\fB-h\fP" 10 |
|
|
91 .IP "\fB\-\-help\fP" 10 |
|
|
92 Gives quick help (which this man page is based on.) |
|
|
93 .IP "\fB-v\fP" 10 |
|
|
94 .IP "\fB\-\-verbose\fP" 10 |
|
|
95 This switch can appear several times to increase |
|
|
96 verbosity level. |
|
|
97 .IP "\fB-q\fP" 10 |
|
|
98 .IP "\fB\-\-quiet\fP" 10 |
|
|
99 Suppress output. |
|
|
100 .SH "EXAMPLES" |
|
|
101 .PP |
|
|
102 Set the title of the \fBImage.jpg\fP file to "My picture": |
|
|
103 |
|
|
104 .PP |
|
|
105 \fBbins_edit \-t "My picture" Image.jpg\fR |
|
|
106 |
|
|
107 .PP |
|
|
108 Set the title and location of all JPEG pictures in the directory: |
|
|
109 |
|
|
110 .PP |
|
|
111 \fBbins_edit \-\-title Holiday \-\-location Paris *.jpg\fR |
|
|
112 |
|
|
113 .PP |
|
|
114 Use of HTML values: |
|
|
115 |
|
|
116 .PP |
|
|
117 \fBbins_edit \-\-html \-\-description '<b>BINS</b> is cool' file.jpg\fR |
|
|
118 |
|
|
119 .PP |
|
|
120 Set the title short description and sample image of the album |
|
|
121 in the current directory (note the dot as final parameter): |
|
|
122 |
|
|
123 .PP |
|
|
124 \fBbins_edit \-a \-t "My Album" \-\-sample image.jpg \-\-shortdesc "This is my album" .\fR |
|
|
125 |
|
|
126 .SH "SEE ALSO" |
|
|
127 .PP |
|
|
128 bins (1). |
|
|
129 .SH "AUTHOR" |
|
|
130 .PP |
|
|
131 This manual page was written by Mark W. Eichin eichin@thok.org for |
|
|
132 the \fBDebian\fP system (but may be used by others). As it is |
|
|
133 mostly derived from the \fBbins_edit\fP program |
|
|
134 itself, it is covered by the GNU General Public License. |
|
|
135 .\" created by instant / docbook-to-man, Mon 22 Aug 2005, 01:55 |
