File: imdb-get.sgml

package info (click to toggle)
imdb-tools 0.7-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 144 kB
  • ctags: 12
  • sloc: sh: 561; makefile: 89
file content (288 lines) | stat: -rw-r--r-- 8,557 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Matthew</firstname>">
  <!ENTITY dhsurname   "<surname>Johnson</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>November  19, 2006</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>&lt;debian@matthew.ath.cx&gt;</email>">
  <!ENTITY dhusername  "Matthew Johnson">
  <!ENTITY dhucpackage "<refentrytitle>IMDB-TOOLS</refentrytitle>">
  <!ENTITY dhpackage   "imdb-get">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  ]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2006</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>Looks up IMDB data for a film.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
         <arg><option>options</option></arg>
         <arg><option>--imdb-id <replaceable>id</replaceable></option></arg>
         <arg><option>-l <replaceable>id</replaceable></option></arg>
         <arg><option>--search <replaceable>search string</replaceable></option></arg>
         <arg><option>-s <replaceable>search string</replaceable></option></arg>
         <arg><option>--filename <replaceable>filename</replaceable></option></arg>
         <arg><option>-f <replaceable>filename</replaceable></option></arg>
         <arg><option>-h </option></arg>
         <arg><option>--help</option></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para><command>&dhpackage;</command> has three modes. It can be called with
    imdb ID and a set of details to print, in which case it will retrieve those
    details either from the cache or IMDB. Secondly, it can be called with a
    filename in which case it will look the file up in the cache (resolving
          symlinks as appropriate and checking for multiple disks from the same
          film) and if that fails it will use the filename to search IMDB.
    Alternatively it may be used with just a search string, which will always
    search IMDB.
    </para>


  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>These programs follow the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below. 
    </para>

    <variablelist>
      <varlistentry>
        <term><option>-h</option>
          <option>--help</option>
        </term>
        <listitem>
          <para>Print syntax and options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-l</option>
          <option>--imdb-id</option>
        </term>
        <listitem>
          <para>Specify IMDBID to use in queries.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option>
          <option>--search</option>
        </term>
        <listitem>
          <para>Specify search string to use in queries.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-f</option>
          <option>--filename</option>
        </term>
        <listitem>
          <para>Specify filename. Will be used to form search queries
          if no ID or search string is specified.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-i</option>
          <option>--id</option>
        </term>
        <listitem>
          <para>Print IMDB ID (default if nothing else is selected).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-t</option>
          <option>--title</option>
        </term>
        <listitem>
          <para>Print film title.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-g</option>
          <option>--genre</option>
        </term>
        <listitem>
          <para>Print film genres.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--tag</option>
        </term>
        <listitem>
          <para>Print film tag line.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-y</option>
          <option>--year</option>
        </term>
        <listitem>
          <para>Print film year.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-c</option>
          <option>--cover</option>
        </term>
        <listitem>
          <para>Print cover art URI.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-m</option>
          <option>--print-filename</option>
        </term>
        <listitem>
          <para>Print film genres.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-a</option>
          <option>--all</option>
        </term>
        <listitem>
          <para>Print all film details.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-e</option>
          <option>--cachedir</option>
        </term>
        <listitem>
          <para>Set cache directory.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d</option>
          <option>--download-cover</option>
        </term>
        <listitem>
          <para>Download cover art locally.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-r</option>
          <option>--refresh</option>
        </term>
        <listitem>
          <para>Force an update from IMDB not the cache.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-n</option>
          <option>--rename</option>
        </term>
        <listitem>
          <para>Rename file based on IMDB title.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-u</option>
          <option>--update-filename</option>
        </term>
        <listitem>
          <para>Update the filename in a stored record</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--prune-duplicates</option>
        </term>
        <listitem>
          <para>Removes cache files with duplicate filename entries.
          (Removes all but the most recently modified cache file)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--refresh-cache</option>
        </term>
        <listitem>
          <para>Refresh all the details in the cache from IMDB
          (may be slow).</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
     <title>FILES</title>

     <para>Config options are read from /etc/imdbgetrc or $HOME/.imdbgetrc</para>
  </refsect1>
  <refsect1>
     <title>SEE ALSO</title>

     <para>imdb(1) imdb-rename(1) imdb-link(1) imdb-update-cache(1) imdbgetrc(5) imdb-fxd(1)</para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail;. Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 as
      published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL-2.
	</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->