Mercurial > bins

comparison doc/bins_edit.sgml @ 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 refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3 <!-- This man page is Copyright 2002 Mark Eichin and released under -->
4 <!-- the GNU General Public License, Version 2. -->
5
6 <!-- Process this file with docbook-to-man to generate an nroff manual
7 page: `docbook-to-man manpage.sgml > manpage.1'. You may view
8 the manual page with: `docbook-to-man manpage.sgml | nroff -man |
9 less'. A typical entry in a Makefile or Makefile.am is:
10
11 manpage.1: manpage.sgml
12 docbook-to-man $< > $@
13
14
15 The docbook-to-man binary is found in the docbook-to-man package.
16 Please remember that if you create the nroff version in one of the
17 debian/rules file targets (such as build), you will need to include
18 docbook-to-man in your Build-Depends control field.
19
20 -->
21
22 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
23 <!ENTITY dhfirstname "<firstname>Mark</firstname>">
24 <!ENTITY dhsurname "<surname>Eichin</surname>">
25 <!-- Please adjust the date whenever revising the manpage. -->
26 <!ENTITY dhdate "<date>April 22, 2002</date>">
27 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
28 allowed: see man(7), man(1). -->
29 <!ENTITY dhsection "<manvolnum>1</manvolnum>">
30 <!ENTITY dhemail "<email>eichin@thok.org</email>">
31 <!ENTITY dhusername "Mark W. Eichin">
32 <!ENTITY dhucpackage "<refentrytitle>BINS</refentrytitle>">
33 <!ENTITY dhpackage "bins_edit">
34
35 <!ENTITY debian "<productname>Debian</productname>">
36 <!ENTITY gnu "<acronym>GNU</acronym>">
37 <!ENTITY gpl "&gnu; General Public License">
38 ]>
39
40 <refentry>
41 <refentryinfo>
42 <address>
43 &dhemail;
44 </address>
45 <author>
46 &dhfirstname;
47 &dhsurname;
48 </author>
49 <copyright>
50 <year>2002</year>
51 <holder>&dhusername;</holder>
52 </copyright>
53 &dhdate;
54 </refentryinfo>
55 <refmeta>
56 &dhucpackage;
57
58 &dhsection;
59 </refmeta>
60 <refnamediv>
61 <refname>&dhpackage;</refname>
62
63 <refpurpose>Set fields in XML picture description files for BINS</refpurpose>
64 </refnamediv>
65 <refsynopsisdiv>
66 <cmdsynopsis>
67 <command>&dhpackage;</command>
68 <group><arg><option>-a</option></arg><arg><option>--album</option></arg></group>
69 <group><arg><option>-m</option></arg><arg><option>--html</option></arg></group>
70 <group><arg><option>-t <replaceable>title</replaceable></option></arg><arg><option>--title <replaceable>title</replaceable></option></arg></group>
71 <group><arg><option>-e <replaceable>event</replaceable></option></arg><arg><option>--event <replaceable>event</replaceable></option></arg></group>
72 <group><arg><option>-l <replaceable>location</replaceable></option></arg><arg><option>--location <replaceable>location</replaceable></option></arg></group>
73 <group><arg><option>-p <replaceable>people</replaceable></option></arg><arg><option>--people <replaceable>people</replaceable></option></arg></group>
74 <group><arg><option>-y <replaceable>date</replaceable></option></arg><arg><option>--date <replaceable>date</replaceable></option></arg></group>
75 <group><arg><option>-d <replaceable>description</replaceable></option></arg><arg><option>--description <replaceable>description</replaceable></option></arg></group>
76 <arg><option>--longdesc <replaceable>longDescription</replaceable></option></arg>
77 <arg><option>--shortdesc <replaceable>shortDescription</replaceable></option></arg>
78 <arg><option>--sample <replaceable>pictureFileName</replaceable></option></arg>
79 <group>
80 <arg><option>-g <replaceable>tag</replaceable>=<replaceable>value</replaceable></option></arg>
81 <arg><option>--generic <replaceable>tag</replaceable>=<replaceable>value</replaceable></option></arg>
82 </group>
83 <group><arg><option>-h</option></arg><arg><option>--help</option></arg></group>
84 <group><arg><option>-v</option></arg><arg><option>--verbose</option></arg></group>
85 <group><arg><option>-q</option></arg><arg><option>--quiet</option></arg></group>
86
87 <arg><replaceable>file</replaceable></arg>
88 <arg rep="repeat"><replaceable>files</replaceable></arg>
89
90
91 </cmdsynopsis>
92 </refsynopsisdiv>
93 <refsect1>
94 <title>DESCRIPTION</title>
95
96 <para>This manual page documents briefly the
97 <command>&dhpackage;</command> command.</para>
98
99 <para>This manual page was written for the &debian; distribution
100 because the original program does not have a manual page.
101 Instead, it has documentation in <acronym>HTML</acronym> in
102 <filename>/usr/share/doc/bins/index.html</filename> as well as a
103 <option>--help</option> option.</para>
104
105 <para><command>&dhpackage;</command> sets values in the XML
106 picture description files that <command>bins</command>(1) uses
107 to generate galleries.
108 </para>
109 </refsect1>
110 <refsect1>
111 <title>OPTIONS</title>
112
113 <para>This program follows the usual GNU command line syntax,
114 with long options starting with two dashes (`-'). A summary of
115 options is included below.</para>
116
117 <variablelist>
118 <varlistentry>
119 <term><replaceable>file</replaceable></term>
120 <listitem>
121 <para>By default, <replaceable>file</replaceable> is the
122 filename of the <acronym>XML</acronym> file with the image
123 properties. If the argument has no
124 <filename>.xml</filename> suffix, it is added, so you can directly give
125 picture names on the command line. Spaces and other
126 special characters (even newlines) can be used in values
127 given as parameters as long as they are enclosed between
128 quotes.</para>
129 <para>If the <option>--album</option> option is given, the
130 filename refers to the directory of images, and the
131 <filename>album.xml</filename> in that directory will be
132 modified instead.</para>
133 </listitem>
134 </varlistentry>
135 <varlistentry>
136 <term><option>-a</option></term>
137 <term><option>--album</option></term> <!-- needs a cleaner alternate/synonym specifier -->
138 <listitem>
139 <para>edit album description (instead of the default of
140 editing the image description.)
141 In this case, the file parameter must be the
142 source directory of the album.
143 Only the <option>--title</option>, <option>--longdesc</option>, <option>--shortdesc</option> and <option>--sample</option>
144 switches make sense with this option.</para>
145 </listitem>
146 </varlistentry>
147 <varlistentry><term><option>-m</option></term><term><option>--html</option></term> <listitem>
148 <para>input value will be interpreted as <acronym>HTML</acronym> code, thus,
149 no HTML encoding or quoting will be done.</para>
150 </listitem>
151 </varlistentry>
152
153 <varlistentry><term><option>-t <replaceable>title</replaceable></option></term><term><option>--title <replaceable>title</replaceable></option></term> <listitem>
154 <para>Set the title (of an image.)</para>
155 </listitem>
156 </varlistentry>
157
158 <varlistentry><term><option>-e <replaceable>event</replaceable></option></term><term><option>--event <replaceable>event</replaceable></option></term> <listitem>
159 <para>Set the event name (of an album or image.)</para>
160 </listitem>
161 </varlistentry>
162
163 <varlistentry><term><option>-l <replaceable>location</replaceable></option></term><term><option>--location <replaceable>location</replaceable></option></term> <listitem>
164 <para>Set the location (of an image.)</para>
165 </listitem>
166 </varlistentry>
167
168 <varlistentry><term><option>-p <replaceable>people</replaceable></option></term><term><option>--people <replaceable>people</replaceable></option></term> <listitem>
169 <para>Set the list of people (of an image.)</para>
170 </listitem>
171 </varlistentry>
172
173 <varlistentry><term><option>-y <replaceable>date</replaceable></option></term><term><option>--date <replaceable>date</replaceable></option></term> <listitem>
174 <para>Set the date (of an image.)</para>
175 </listitem>
176 </varlistentry>
177
178 <varlistentry><term><option>-d <replaceable>description</replaceable></option></term><term><option>--description <replaceable>description</replaceable></option></term> <listitem>
179 <para>Set the description (of an image.)</para>
180 </listitem>
181 </varlistentry>
182
183 <varlistentry><term><option>--longdesc <replaceable>longDescription</replaceable></option></term> <listitem>
184 <para>Set the long description (of an album.)</para>
185 </listitem>
186 </varlistentry>
187
188 <varlistentry><term><option>--shortdesc <replaceable>shortDescription</replaceable></option></term> <listitem>
189 <para>Set the short description (of an album.)</para>
190 </listitem>
191 </varlistentry>
192
193 <varlistentry><term><option>--sample <replaceable>pictureFileName</replaceable></option></term> <listitem>
194 <para>Select the sample picture, within this album, to be
195 used on the album list (template
196 <filename>subalbum.html</filename>.) Note that the
197 filename is relative to the album directory, and thus
198 doesn't have a directory component.</para>
199 </listitem>
200 </varlistentry>
201
202 <varlistentry>
203 <term><option>-g <replaceable>tag</replaceable>=<replaceable>value</replaceable></option></term>
204 <term><option>--generic <replaceable>tag</replaceable>=<replaceable>value</replaceable></option></term>
205 <listitem>
206 <para>This lets you set arbitrary fields in the relevant
207 <acronym>XML</acronym> file (of the image or the album.)
208 Generic tags appear inside <sgmltag>description</sgmltag>
209 which appears inside <sgmltag>image</sgmltag>; the
210 <replaceable>tag</replaceable> appears as the
211 <sgmltag>name</sgmltag> attribute of a
212 <sgmltag>field</sgmltag> element, and the
213 <replaceable>value</replaceable> appears as the content of
214 the element.</para>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry><term><option>-h</option></term><term><option>--help</option></term> <listitem>
219 <para>Gives quick help (which this man page is based on.)</para>
220 </listitem>
221 </varlistentry>
222
223 <varlistentry><term><option>-v</option></term><term><option>--verbose</option></term> <listitem>
224 <para>This switch can appear several times to increase
225 verbosity level.</para>
226 </listitem>
227 </varlistentry>
228
229 <varlistentry><term><option>-q</option></term><term><option>--quiet</option></term> <listitem>
230 <para>Suppress output.</para>
231 </listitem>
232 </varlistentry>
233 </variablelist>
234 </refsect1>
235 <refsect1>
236 <title>EXAMPLES</title>
237 <para>Set the title of the <filename>Image.jpg</filename> file to "My picture":
238 <cmdsynopsis><command>bins_edit -t "My picture" Image.jpg</command></cmdsynopsis>
239 </para>
240 <para>Set the title and location of all <acronym>JPEG</acronym> pictures in the directory:
241 <cmdsynopsis><command>bins_edit --title Holiday --location Paris *.jpg</command></cmdsynopsis>
242 </para>
243 <para>Use of <acronym>HTML</acronym> values:
244 <cmdsynopsis><command>bins_edit --html --description '&lt;b&gt;BINS&lt;/b&gt; is cool' file.jpg</command></cmdsynopsis>
245 </para>
246 <para>Set the title short description and sample image of the album
247 in the current directory (note the dot as final parameter):
248 <cmdsynopsis><command>bins_edit -a -t "My Album" --sample image.jpg --shortdesc "This is my album" .</command></cmdsynopsis>
249 </para>
250 </refsect1>
251 <refsect1>
252 <title>SEE ALSO</title>
253
254 <para>bins (1).</para>
255
256 </refsect1>
257 <refsect1>
258 <title>AUTHOR</title>
259
260 <para>This manual page was written by &dhusername; &dhemail; for
261 the &debian; system (but may be used by others). As it is
262 mostly derived from the <filename>&dhpackage;</filename> program
263 itself, it is covered by the &gpl;.</para>
264
265 </refsect1>
266 </refentry>
267
268 <!-- Keep this comment at the end of the file
269 Local variables:
270 mode: sgml
271 sgml-omittag:t
272 sgml-shorttag:t
273 sgml-minimize-attributes:nil
274 sgml-always-quote-attributes:t
275 sgml-indent-step:2
276 sgml-indent-data:t
277 sgml-parent-document:nil
278 sgml-default-dtd-file:nil
279 sgml-exposed-tags:nil
280 sgml-local-catalogs:nil
281 sgml-local-ecat-files:nil
282 End:
283 -->
284
285
286