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
|
.\" Process this file with
.\" groff -man -Tascii vorbiscomment.1
.\"
.TH VORBISCOMMENT 1 "December 30, 2008" "Xiph.Org Foundation" "Ogg Vorbis Tools"
.SH NAME
vorbiscomment \- List or edit comments in Ogg Vorbis files
.SH SYNOPSIS
.B vorbiscomment
.B [-l]
.RB [ -R ]
.RB [ -e ]
.I file.ogg
.br
.B vorbiscomment
.B -a
.B [ -c commentfile | -t \*(lqname=value\*(rq ]
.RB [ -q ]
.RB [ -R ]
.RB [ -e ]
.I in.ogg
.I [out.ogg]
.br
.B vorbiscomment
.B -w
.B [ -c commentfile | -t \*(lqname=value\*(rq ]
.RB [ -q ]
.RB [ -R ]
.RB [ -e ]
.I in.ogg
.I [out.ogg]
.SH DESCRIPTION
.B vorbiscomment
Reads, modifies, and appends Ogg Vorbis audio file metadata tags.
.SH OPTIONS
.IP "-a, --append"
Append comments.
.IP "-c file, --commentfile file"
Take comments from a file. The file is the same format as is output by the the -l option or given to the -t option: one element per line in 'tag=value' format. If the file is /dev/null and -w was passed, the existing comments will be removed.
.IP "-h, --help"
Show command help.
.IP "-l, --list"
List the comments in the Ogg Vorbis file.
.IP "-q, --quiet"
Quiet mode. No messages are displayed.
.IP "-t 'name=value', --tag 'name=value'"
Specify a new tag on the command line. Each tag is given as a single string. The part before the '=' is treated as the tag name and the part after as the value.
.IP "-w, --write"
Replace comments with the new set given either on the command line with -t or from a file with -c. If neither -c nor -t is given, the new set will be read from the standard input.
.IP "-R, --raw"
Read and write comments in UTF-8, rather than converting to the user's character set.
.IP "-e, --escapes"
Quote/unquote newlines and backslashes in the comments. This ensures every comment is exactly one line in the output (or input), allowing to filter and round-trip them. Without it, you can only write multi-line comments by using -t and you can't reliably distinguish them from multiple one-line comments.
Supported escapes are c-style "\en", "\er", "\e\e" and "\e0". A backslash followed by anything else is an error.
Note: currently, anything after the first "\e0" is thrown away while writing. This is a bug -- the Vorbis format can safely store null characters, but most other tools wouldn't handle them anyway.
.IP "-V, --version"
Display the version of vorbiscomment.
.\" Examples go here
.SH EXAMPLES
To just see what comment tags are in a file:
vorbiscomment -l file.ogg
To edit those comments:
vorbiscomment -l file.ogg > file.txt
[edit the comments in file.txt to your satisfaction]
vorbiscomment -w -c file.txt file.ogg newfile.ogg
To simply add a comment:
vorbiscomment -a -t 'ARTIST=No One You Know' file.ogg newfile.ogg
To add a set of comments from the standard input:
vorbiscomment -a file.ogg
ARTIST=No One You Know
ALBUM=The Famous Album
<ctrl-d>
.SH TAG FORMAT
See http://xiph.org/ogg/vorbis/doc/v-comment.html for documentation on the Ogg Vorbis tag format, including a suggested list of canonical tag names.
.SH AUTHORS
.TP
Program Authors:
.br
Michael Smith <msmith@xiph.org>
.br
Ralph Giles <giles@xiph.org>
.br
.TP
Manpage Author:
.br
Christopher L Cheney <ccheney@debian.org>
.SH "SEE ALSO"
.PP
\fBoggenc\fR(1), \fBoggdec\fR(1), \fBogg123\fR(1), \fBogginfo\fR(1)
|
