Mercurial > bins

comparison doc/bins_edit_man.html @ 0:a84c32f131df 1.1.29

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import vendor version
author Peter Gervai <grin@grin.hu>
date Wed, 15 Oct 2008 23:28:56 +0200
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:a84c32f131df
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >BINS</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD
9 ><BODY
10 CLASS="REFENTRY"
11 BGCOLOR="#FFFFFF"
12 TEXT="#000000"
13 LINK="#0000FF"
14 VLINK="#840084"
15 ALINK="#0000FF"
16 ><H1
17 ><A
18 NAME="AEN1"
19 ></A
20 >BINS</H1
21 ><DIV
22 CLASS="REFNAMEDIV"
23 ><A
24 NAME="AEN15"
25 ></A
26 ><H2
27 >Name</H2
28 >bins_edit&nbsp;--&nbsp;Set fields in XML picture description files for BINS</DIV
29 ><DIV
30 CLASS="REFSYNOPSISDIV"
31 ><A
32 NAME="AEN18"
33 ></A
34 ><H2
35 >Synopsis</H2
36 ><P
37 ><B
38 CLASS="COMMAND"
39 >bins_edit</B
40 > [<CODE
41 CLASS="OPTION"
42 >-a</CODE
43 > | <CODE
44 CLASS="OPTION"
45 >--album</CODE
46 >] [<CODE
47 CLASS="OPTION"
48 >-m</CODE
49 > | <CODE
50 CLASS="OPTION"
51 >--html</CODE
52 >] [<CODE
53 CLASS="OPTION"
54 >-t <TT
55 CLASS="REPLACEABLE"
56 ><I
57 >title</I
58 ></TT
59 ></CODE
60 > | <CODE
61 CLASS="OPTION"
62 >--title <TT
63 CLASS="REPLACEABLE"
64 ><I
65 >title</I
66 ></TT
67 ></CODE
68 >] [<CODE
69 CLASS="OPTION"
70 >-e <TT
71 CLASS="REPLACEABLE"
72 ><I
73 >event</I
74 ></TT
75 ></CODE
76 > | <CODE
77 CLASS="OPTION"
78 >--event <TT
79 CLASS="REPLACEABLE"
80 ><I
81 >event</I
82 ></TT
83 ></CODE
84 >] [<CODE
85 CLASS="OPTION"
86 >-l <TT
87 CLASS="REPLACEABLE"
88 ><I
89 >location</I
90 ></TT
91 ></CODE
92 > | <CODE
93 CLASS="OPTION"
94 >--location <TT
95 CLASS="REPLACEABLE"
96 ><I
97 >location</I
98 ></TT
99 ></CODE
100 >] [<CODE
101 CLASS="OPTION"
102 >-p <TT
103 CLASS="REPLACEABLE"
104 ><I
105 >people</I
106 ></TT
107 ></CODE
108 > | <CODE
109 CLASS="OPTION"
110 >--people <TT
111 CLASS="REPLACEABLE"
112 ><I
113 >people</I
114 ></TT
115 ></CODE
116 >] [<CODE
117 CLASS="OPTION"
118 >-y <TT
119 CLASS="REPLACEABLE"
120 ><I
121 >date</I
122 ></TT
123 ></CODE
124 > | <CODE
125 CLASS="OPTION"
126 >--date <TT
127 CLASS="REPLACEABLE"
128 ><I
129 >date</I
130 ></TT
131 ></CODE
132 >] [<CODE
133 CLASS="OPTION"
134 >-d <TT
135 CLASS="REPLACEABLE"
136 ><I
137 >description</I
138 ></TT
139 ></CODE
140 > | <CODE
141 CLASS="OPTION"
142 >--description <TT
143 CLASS="REPLACEABLE"
144 ><I
145 >description</I
146 ></TT
147 ></CODE
148 >] [<CODE
149 CLASS="OPTION"
150 >--longdesc <TT
151 CLASS="REPLACEABLE"
152 ><I
153 >longDescription</I
154 ></TT
155 ></CODE
156 >] [<CODE
157 CLASS="OPTION"
158 >--shortdesc <TT
159 CLASS="REPLACEABLE"
160 ><I
161 >shortDescription</I
162 ></TT
163 ></CODE
164 >] [<CODE
165 CLASS="OPTION"
166 >--sample <TT
167 CLASS="REPLACEABLE"
168 ><I
169 >pictureFileName</I
170 ></TT
171 ></CODE
172 >] [<CODE
173 CLASS="OPTION"
174 >-g <TT
175 CLASS="REPLACEABLE"
176 ><I
177 >tag</I
178 ></TT
179 >=<TT
180 CLASS="REPLACEABLE"
181 ><I
182 >value</I
183 ></TT
184 ></CODE
185 > | <CODE
186 CLASS="OPTION"
187 >--generic <TT
188 CLASS="REPLACEABLE"
189 ><I
190 >tag</I
191 ></TT
192 >=<TT
193 CLASS="REPLACEABLE"
194 ><I
195 >value</I
196 ></TT
197 ></CODE
198 >] [<CODE
199 CLASS="OPTION"
200 >-h</CODE
201 > | <CODE
202 CLASS="OPTION"
203 >--help</CODE
204 >] [<CODE
205 CLASS="OPTION"
206 >-v</CODE
207 > | <CODE
208 CLASS="OPTION"
209 >--verbose</CODE
210 >] [<CODE
211 CLASS="OPTION"
212 >-q</CODE
213 > | <CODE
214 CLASS="OPTION"
215 >--quiet</CODE
216 >] [<TT
217 CLASS="REPLACEABLE"
218 ><I
219 >file</I
220 ></TT
221 >] [<TT
222 CLASS="REPLACEABLE"
223 ><I
224 >files</I
225 ></TT
226 >...]</P
227 ></DIV
228 ><DIV
229 CLASS="REFSECT1"
230 ><A
231 NAME="AEN110"
232 ></A
233 ><H2
234 >DESCRIPTION</H2
235 ><P
236 >This manual page documents briefly the
237 <B
238 CLASS="COMMAND"
239 >bins_edit</B
240 > command.</P
241 ><P
242 >This manual page was written for the <SPAN
243 CLASS="PRODUCTNAME"
244 >Debian</SPAN
245 > distribution
246 because the original program does not have a manual page.
247 Instead, it has documentation in <ACRONYM
248 CLASS="ACRONYM"
249 >HTML</ACRONYM
250 > in
251 <TT
252 CLASS="FILENAME"
253 >/usr/share/doc/bins/index.html</TT
254 > as well as a
255 <CODE
256 CLASS="OPTION"
257 >--help</CODE
258 > option.</P
259 ><P
260 ><B
261 CLASS="COMMAND"
262 >bins_edit</B
263 > sets values in the XML
264 picture description files that <B
265 CLASS="COMMAND"
266 >bins</B
267 >(1) uses
268 to generate galleries.
269 </P
270 ></DIV
271 ><DIV
272 CLASS="REFSECT1"
273 ><A
274 NAME="AEN122"
275 ></A
276 ><H2
277 >OPTIONS</H2
278 ><P
279 >This program follows the usual GNU command line syntax,
280 with long options starting with two dashes (`-'). A summary of
281 options is included below.</P
282 ><P
283 ></P
284 ><DIV
285 CLASS="VARIABLELIST"
286 ><DL
287 ><DT
288 ><TT
289 CLASS="REPLACEABLE"
290 ><I
291 >file</I
292 ></TT
293 ></DT
294 ><DD
295 ><P
296 >By default, <TT
297 CLASS="REPLACEABLE"
298 ><I
299 >file</I
300 ></TT
301 > is the
302 filename of the <ACRONYM
303 CLASS="ACRONYM"
304 >XML</ACRONYM
305 > file with the image
306 properties. If the argument has no
307 <TT
308 CLASS="FILENAME"
309 >.xml</TT
310 > suffix, it is added, so you can directly give
311 picture names on the command line. Spaces and other
312 special characters (even newlines) can be used in values
313 given as parameters as long as they are enclosed between
314 quotes.</P
315 ><P
316 >If the <CODE
317 CLASS="OPTION"
318 >--album</CODE
319 > option is given, the
320 filename refers to the directory of images, and the
321 <TT
322 CLASS="FILENAME"
323 >album.xml</TT
324 > in that directory will be
325 modified instead.</P
326 ></DD
327 ><DT
328 ><CODE
329 CLASS="OPTION"
330 >-a</CODE
331 >, <CODE
332 CLASS="OPTION"
333 >--album</CODE
334 ></DT
335 ><DD
336 ><P
337 >edit album description (instead of the default of
338 editing the image description.)
339 In this case, the file parameter must be the
340 source directory of the album.
341 Only the <CODE
342 CLASS="OPTION"
343 >--title</CODE
344 >, <CODE
345 CLASS="OPTION"
346 >--longdesc</CODE
347 >, <CODE
348 CLASS="OPTION"
349 >--shortdesc</CODE
350 > and <CODE
351 CLASS="OPTION"
352 >--sample</CODE
353 >
354 switches make sense with this option.</P
355 ></DD
356 ><DT
357 ><CODE
358 CLASS="OPTION"
359 >-m</CODE
360 >, <CODE
361 CLASS="OPTION"
362 >--html</CODE
363 ></DT
364 ><DD
365 ><P
366 >input value will be interpreted as <ACRONYM
367 CLASS="ACRONYM"
368 >HTML</ACRONYM
369 > code, thus,
370 no HTML encoding or quoting will be done.</P
371 ></DD
372 ><DT
373 ><CODE
374 CLASS="OPTION"
375 >-t <TT
376 CLASS="REPLACEABLE"
377 ><I
378 >title</I
379 ></TT
380 ></CODE
381 >, <CODE
382 CLASS="OPTION"
383 >--title <TT
384 CLASS="REPLACEABLE"
385 ><I
386 >title</I
387 ></TT
388 ></CODE
389 ></DT
390 ><DD
391 ><P
392 >Set the title (of an image.)</P
393 ></DD
394 ><DT
395 ><CODE
396 CLASS="OPTION"
397 >-e <TT
398 CLASS="REPLACEABLE"
399 ><I
400 >event</I
401 ></TT
402 ></CODE
403 >, <CODE
404 CLASS="OPTION"
405 >--event <TT
406 CLASS="REPLACEABLE"
407 ><I
408 >event</I
409 ></TT
410 ></CODE
411 ></DT
412 ><DD
413 ><P
414 >Set the event name (of an album or image.)</P
415 ></DD
416 ><DT
417 ><CODE
418 CLASS="OPTION"
419 >-l <TT
420 CLASS="REPLACEABLE"
421 ><I
422 >location</I
423 ></TT
424 ></CODE
425 >, <CODE
426 CLASS="OPTION"
427 >--location <TT
428 CLASS="REPLACEABLE"
429 ><I
430 >location</I
431 ></TT
432 ></CODE
433 ></DT
434 ><DD
435 ><P
436 >Set the location (of an image.)</P
437 ></DD
438 ><DT
439 ><CODE
440 CLASS="OPTION"
441 >-p <TT
442 CLASS="REPLACEABLE"
443 ><I
444 >people</I
445 ></TT
446 ></CODE
447 >, <CODE
448 CLASS="OPTION"
449 >--people <TT
450 CLASS="REPLACEABLE"
451 ><I
452 >people</I
453 ></TT
454 ></CODE
455 ></DT
456 ><DD
457 ><P
458 >Set the list of people (of an image.)</P
459 ></DD
460 ><DT
461 ><CODE
462 CLASS="OPTION"
463 >-y <TT
464 CLASS="REPLACEABLE"
465 ><I
466 >date</I
467 ></TT
468 ></CODE
469 >, <CODE
470 CLASS="OPTION"
471 >--date <TT
472 CLASS="REPLACEABLE"
473 ><I
474 >date</I
475 ></TT
476 ></CODE
477 ></DT
478 ><DD
479 ><P
480 >Set the date (of an image.)</P
481 ></DD
482 ><DT
483 ><CODE
484 CLASS="OPTION"
485 >-d <TT
486 CLASS="REPLACEABLE"
487 ><I
488 >description</I
489 ></TT
490 ></CODE
491 >, <CODE
492 CLASS="OPTION"
493 >--description <TT
494 CLASS="REPLACEABLE"
495 ><I
496 >description</I
497 ></TT
498 ></CODE
499 ></DT
500 ><DD
501 ><P
502 >Set the description (of an image.)</P
503 ></DD
504 ><DT
505 ><CODE
506 CLASS="OPTION"
507 >--longdesc <TT
508 CLASS="REPLACEABLE"
509 ><I
510 >longDescription</I
511 ></TT
512 ></CODE
513 ></DT
514 ><DD
515 ><P
516 >Set the long description (of an album.)</P
517 ></DD
518 ><DT
519 ><CODE
520 CLASS="OPTION"
521 >--shortdesc <TT
522 CLASS="REPLACEABLE"
523 ><I
524 >shortDescription</I
525 ></TT
526 ></CODE
527 ></DT
528 ><DD
529 ><P
530 >Set the short description (of an album.)</P
531 ></DD
532 ><DT
533 ><CODE
534 CLASS="OPTION"
535 >--sample <TT
536 CLASS="REPLACEABLE"
537 ><I
538 >pictureFileName</I
539 ></TT
540 ></CODE
541 ></DT
542 ><DD
543 ><P
544 >Select the sample picture, within this album, to be
545 used on the album list (template
546 <TT
547 CLASS="FILENAME"
548 >subalbum.html</TT
549 >.) Note that the
550 filename is relative to the album directory, and thus
551 doesn't have a directory component.</P
552 ></DD
553 ><DT
554 ><CODE
555 CLASS="OPTION"
556 >-g <TT
557 CLASS="REPLACEABLE"
558 ><I
559 >tag</I
560 ></TT
561 >=<TT
562 CLASS="REPLACEABLE"
563 ><I
564 >value</I
565 ></TT
566 ></CODE
567 >, <CODE
568 CLASS="OPTION"
569 >--generic <TT
570 CLASS="REPLACEABLE"
571 ><I
572 >tag</I
573 ></TT
574 >=<TT
575 CLASS="REPLACEABLE"
576 ><I
577 >value</I
578 ></TT
579 ></CODE
580 ></DT
581 ><DD
582 ><P
583 >This lets you set arbitrary fields in the relevant
584 <ACRONYM
585 CLASS="ACRONYM"
586 >XML</ACRONYM
587 > file (of the image or the album.)
588 Generic tags appear inside <CODE
589 CLASS="SGMLTAG"
590 >description</CODE
591 >
592 which appears inside <CODE
593 CLASS="SGMLTAG"
594 >image</CODE
595 >; the
596 <TT
597 CLASS="REPLACEABLE"
598 ><I
599 >tag</I
600 ></TT
601 > appears as the
602 <CODE
603 CLASS="SGMLTAG"
604 >name</CODE
605 > attribute of a
606 <CODE
607 CLASS="SGMLTAG"
608 >field</CODE
609 > element, and the
610 <TT
611 CLASS="REPLACEABLE"
612 ><I
613 >value</I
614 ></TT
615 > appears as the content of
616 the element.</P
617 ></DD
618 ><DT
619 ><CODE
620 CLASS="OPTION"
621 >-h</CODE
622 >, <CODE
623 CLASS="OPTION"
624 >--help</CODE
625 ></DT
626 ><DD
627 ><P
628 >Gives quick help (which this man page is based on.)</P
629 ></DD
630 ><DT
631 ><CODE
632 CLASS="OPTION"
633 >-v</CODE
634 >, <CODE
635 CLASS="OPTION"
636 >--verbose</CODE
637 ></DT
638 ><DD
639 ><P
640 >This switch can appear several times to increase
641 verbosity level.</P
642 ></DD
643 ><DT
644 ><CODE
645 CLASS="OPTION"
646 >-q</CODE
647 >, <CODE
648 CLASS="OPTION"
649 >--quiet</CODE
650 ></DT
651 ><DD
652 ><P
653 >Suppress output.</P
654 ></DD
655 ></DL
656 ></DIV
657 ></DIV
658 ><DIV
659 CLASS="REFSECT1"
660 ><A
661 NAME="AEN268"
662 ></A
663 ><H2
664 >EXAMPLES</H2
665 ><P
666 >Set the title of the <TT
667 CLASS="FILENAME"
668 >Image.jpg</TT
669 > file to "My picture":
670 <P
671 ><B
672 CLASS="COMMAND"
673 >bins_edit -t "My picture" Image.jpg</B
674 > </P
675 >
676 </P
677 ><P
678 >Set the title and location of all <ACRONYM
679 CLASS="ACRONYM"
680 >JPEG</ACRONYM
681 > pictures in the directory:
682 <P
683 ><B
684 CLASS="COMMAND"
685 >bins_edit --title Holiday --location Paris *.jpg</B
686 > </P
687 >
688 </P
689 ><P
690 >Use of <ACRONYM
691 CLASS="ACRONYM"
692 >HTML</ACRONYM
693 > values:
694 <P
695 ><B
696 CLASS="COMMAND"
697 >bins_edit --html --description '&#60;b&#62;BINS&#60;/b&#62; is cool' file.jpg</B
698 > </P
699 >
700 </P
701 ><P
702 >Set the title short description and sample image of the album
703 in the current directory (note the dot as final parameter):
704 <P
705 ><B
706 CLASS="COMMAND"
707 >bins_edit -a -t "My Album" --sample image.jpg --shortdesc "This is my album" .</B
708 > </P
709 >
710 </P
711 ></DIV
712 ><DIV
713 CLASS="REFSECT1"
714 ><A
715 NAME="AEN285"
716 ></A
717 ><H2
718 >SEE ALSO</H2
719 ><P
720 >bins (1).</P
721 ></DIV
722 ><DIV
723 CLASS="REFSECT1"
724 ><A
725 NAME="AEN288"
726 ></A
727 ><H2
728 >AUTHOR</H2
729 ><P
730 >This manual page was written by Mark W. Eichin <CODE
731 CLASS="EMAIL"
732 >&#60;<A
733 HREF="mailto:eichin@thok.org"
734 >eichin@thok.org</A
735 >&#62;</CODE
736 > for
737 the <SPAN
738 CLASS="PRODUCTNAME"
739 >Debian</SPAN
740 > system (but may be used by others). As it is
741 mostly derived from the <TT
742 CLASS="FILENAME"
743 >bins_edit</TT
744 > program
745 itself, it is covered by the <ACRONYM
746 CLASS="ACRONYM"
747 >GNU</ACRONYM
748 > General Public License.</P
749 ></DIV
750 ></BODY
751 ></HTML
752 >