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

EXAMPLES

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

TAG FORMAT

102       See https://xiph.org/vorbis/doc/v-comment.html for documentation on the
103       Ogg  Vorbis  tag  format,  including  a suggested list of canonical tag
104       names.
105
106

AUTHORS

108       Program Authors:
109              Michael Smith <msmith@xiph.org>
110              Ralph Giles <giles@xiph.org>
111
112
113       Manpage Author:
114              Christopher L Cheney <ccheney@debian.org>
115
116