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 the -l option or given to the -t option: one ele‐
29              ment per line in 'tag=value' format. If the  file  is  /dev/null
30              and -w 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       -q, --quiet
39              Quiet mode.  No messages are displayed.
40
41       -t 'name=value', --tag 'name=value'
42              Specify  a  new  tag on the command line. Each tag is given as a
43              single string. The part before the '=' is  treated  as  the  tag
44              name and the part after as the value.
45
46       -w, --write
47              Replace  comments  with  the new set given either on the command
48              line with -t or from a file with -c. If neither  -c  nor  -t  is
49              given, the new set will be read from the standard input.
50
51       -R, --raw
52              Read  and write comments in UTF-8, rather than converting to the
53              user's character set.
54
55       -e, --escapes
56              Quote/unquote newlines and backslashes  in  the  comments.  This
57              ensures  every  comment  is  exactly  one line in the output (or
58              input), allowing to filter and round-trip them. Without it,  you
59              can  only  write  multi-line  comments by using -t and you can't
60              reliably distinguish them from multiple one-line comments.
61
62              Supported escapes are c-style "\n", "\r", "\\" and "\0". A back‐
63              slash followed by anything else is an error.
64
65              Note:  currently,  anything  after the first "\0" is thrown away
66              while writing.  This is a bug -- the Vorbis  format  can  safely
67              store null characters, but most other tools wouldn't handle them
68              anyway.
69
70       -V, --version
71              Display the version of vorbiscomment.
72
73

EXAMPLES

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

TAG FORMAT

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

AUTHORS

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