File: pytags.xml

package info (click to toggle)
pytagsfs 0.9.2-6
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch, wheezy
  • size: 984 kB
  • ctags: 1,858
  • sloc: python: 10,656; xml: 543; makefile: 47
file content (172 lines) | stat: -rw-r--r-- 5,632 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
<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
  <!ENTITY pytags "<command>pytags</command>">
]>

<refentry>

  <refentryinfo>
    <author><firstname>Forest</firstname><surname>Bond</surname></author>
    <address>forest@alittletooquiet.net</address>
    <copyright>
      <year>2007</year>
      <year>2008</year>
      <year>2009</year>
    </copyright>
    <date>2009-12-04</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>pytags</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>pytags</refname>
    <refpurpose>
      set and remove tags on media files from filename and options
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      &pytags;
      <group choice="opt">OPTIONS</group>
      <arg choice="plain"><replaceable>file</replaceable></arg>
      <arg choice="opt"><replaceable>file</replaceable>...</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>
      &pytags; is a simple, general-purpose tool for setting and removing media
      file tags.  With no options, &pytags; prints a tag summary for all files
      specified on the command line.  Options can be used to set and remove tags
      on files.
    </para>

    <para>
      Using <option>--format</option>, it is easy to change or create tags on
      by parsing metadata from filenames according to an arbitrary format
      string.  This makes it simple to tag files that are consistently
      named.
    </para>

    <para>
      Additionally, tags can be manipulated directly with the
      <option>--add</option>, <option>--set</option>, and
      <option>--remove</option> options.  These options are processed in order,
      so options specified later on the command-line may cause values set by
      earlier options to be overwritten.  These options must appear after the
      <option>--format</option>, if it is used.
    </para>
  </refsect1>

  <refsect1>
    <title>Options</title>
    <variablelist>
      <varlistentry>
        <term><option>--add</option>=EXPR</term>
        <listitem><para>
          Append a tag value all files according to EXPR.  EXPR should be an
          expression like “artist=Foo”.  May be specified multiple times to add
          multiple values.
        </para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--format</option>=FORMAT</term>
        <listitem><para>
          Tag files with metadata extrapolated from filenames using format
          string FORMAT; see <xref linkend="refsect1_format_strings"/>.  This
          option must be specified before <option>--add</option>,
          <option>--set</option>, or <option>--remove</option>.
        </para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--set</option>=EXPR</term>
        <listitem><para>
          Set a single tag on all files according to EXPR.  EXPR should be an
          expression like “artist=Foo”.  May be specified multiple times to set
          multiple tags.  <option>--set</option> cannot be used to specify
          multiple values for a single tag.  To do that, use
          <option>--remove</option> followed by multiple <option>--add</option>
          options.
        </para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--remove</option>=TAG</term>
        <listitem><para>
          Remove tags named TAG.  May be specified more than once to remove
          multiple tags.
        </para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option>, <option>--help</option></term>
        <listitem><para>Show summary of options and exit.</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>, <option>--version</option></term>
        <listitem><para>Show version of program and exit.</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="refsect1_format_strings">
    <title>Format Strings</title>

    <para>
      The format string expected by <option>--format</option> is the same as
      that for <command>pytagsfs</command>.  See the <command>pytagsfs</command>
      manual page for more information.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>

    <para>
      Remove the genre tag from all .ogg files in the current directory.
    </para>
    <screen>$ pytags --remove genre *.ogg</screen>

    <para>
      Set the artist and album tag on all .mp3 files, and remove the genre tag.
    </para>
    <screen>$ pytags --set artist=Foo --set album=Bar --remove genre *.mp3</screen>

    <para>
      Tag all of the .flac files in the current directory.  All such files are
      assumed to be in the format "tracknum artist - trackname [album].flac".
    </para>
    <screen>$ pytags --format '%n %a - %t [%l].flac' *.flac</screen>
  </refsect1>

  <refsect1>
    <title>Bugs</title>
    <para>
      Please report bugs on launchpad at
      http://launchpad.net/products/pytagsfs/+bugs.
    </para>

    <para>
      pytags relies on mutagen (the underlying Python tags library)
      to choose an appropriate tag format for the files being tagged.  This
      cannot currently be overridden.
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry>
        <refentrytitle>pytagsfs</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>
    </para>
  </refsect1>

</refentry>