vorbiscomment(1)

1VORBISCOMMENT(1)               Ogg Vorbis Tools               VORBISCOMMENT(1)
2
3
4

NAME

6       vorbiscomment - List or edit comments in Ogg Vorbis files
7
8

SYNOPSIS

10       vorbiscomment [-l] [-R] [-e] file.ogg
11       vorbiscomment  -a  [  -c commentfile | -t “name=value” ] [-q] [-R] [-e]
12       in.ogg [out.ogg]
13       vorbiscomment -w [ -c commentfile | -t “name=value” ]  [-q]  [-R]  [-e]
14       in.ogg [out.ogg]
15
16

DESCRIPTION

18       vorbiscomment  Reads, modifies, and appends Ogg Vorbis audio file meta‐
19       data tags.
20
21

OPTIONS

23       -a, --append
24              Append comments.
25
26       -c file, --commentfile file
27              Take comments from a file. The file is the  same  format  as  is
28              output  by  the -l option or given to the -t option: one element
29              per line in 'tag=value' format. If the file is /dev/null and  -w
30              was passed, the existing comments will be removed.
31
32       -h, --help
33              Show command help.
34
35       -l, --list
36              List the comments in the Ogg Vorbis file.
37
38       -t 'name=value', --tag 'name=value'
39              Specify  a  new  tag on the command line. Each tag is given as a
40              single string. The part before the '=' is  treated  as  the  tag
41              name and the part after as the value.
42
43       -w, --write
44              Replace  comments  with  the new set given either on the command
45              line with -t or from a file with -c. If neither  -c  nor  -t  is
46              given, the new set will be read from the standard input.
47
48       -R, --raw
49              Read  and write comments in UTF-8, rather than converting to the
50              user's character set.
51
52       -e, --escapes
53              Quote/unquote newlines and backslashes  in  the  comments.  This
54              ensures  every  comment  is  exactly  one line in the output (or
55              input), allowing to filter and round-trip them. Without it,  you
56              can  only  write  multi-line  comments by using -t and you can't
57              reliably distinguish them from multiple one-line comments.
58
59              Supported escapes are c-style "\n", "\r", "\\" and "\0". A back‐
60              slash followed by anything else is an error.
61
62              Note:  currently,  anything  after the first "\0" is thrown away
63              while writing.  This is a bug -- the Vorbis  format  can  safely
64              store null characters, but most other tools wouldn't handle them
65              anyway.
66
67       -V, --version
68              Display the version of vorbiscomment.
69
70

EXAMPLES

72       To just see what comment tags are in a file:
73
74           vorbiscomment -l file.ogg
75
76       To edit those comments:
77
78           vorbiscomment -l file.ogg > file.txt
79           [edit the comments in file.txt to your satisfaction]
80           vorbiscomment -w -c file.txt file.ogg newfile.ogg
81
82       To simply add a comment:
83
84           vorbiscomment -a -t 'ARTIST=No One You Know' file.ogg newfile.ogg
85
86       To add a set of comments from the standard input:
87
88           vorbiscomment -a file.ogg
89           ARTIST=No One You Know
90           ALBUM=The Famous Album
91           <ctrl-d>
92
93

TAG FORMAT

95       See http://xiph.org/vorbis/doc/v-comment.html for documentation on  the
96       Ogg  Vorbis  tag  format,  including  a suggested list of canonical tag
97       names.
98
99

AUTHORS

101       Program Authors:
102              Michael Smith <msmith@xiph.org>
103              Ralph Giles <giles@xiph.org>
104
105
106       Manpage Author:
107              Christopher L Cheney <ccheney@debian.org>
108
109