vorbiscomment.1 1.95 KB
Newer Older
1 2 3
.\" Process this file with
.\" groff -man -Tascii vorbiscomment.1
.\"
4
.TH VORBISCOMMENT 1 "December 24, 2001" "Xiph.org Foundation" "Vorbis Tools"
5 6 7 8 9 10 11 12 13 14 15

.SH NAME
vorbiscomment \- edits Ogg Vorbis comments

.SH SYNOPSIS
.B vorbiscomment
.RB [ -l ]
.I file.ogg
.br
.B vorbiscomment
.B -a
16 17
.B [ -c commentfile | -t \*(lqtag=value\*(rq ]
.RB [ -q ]
18
.I in.ogg
19
.I [out.ogg]
20 21 22
.br
.B vorbiscomment
.B -w
23 24
.B [ -c commentfile | -t \*(lqtag=value\*(rq ]
.RB [ -q ]
25
.I in.ogg
26
.I [out.ogg]
27 28 29

.SH DESCRIPTION
.B vorbiscomment
30
reads, modifies, and appends Ogg Vorbis audio file metadata tags.
31 32 33

.SH OPTIONS
.IP "-a"
34
Append comments.
35 36
.IP "-c commentfile"
Take comments from a file. The file is the same format as is output by the the -l option: one element per line in 'tag=value' format.
37 38 39
.IP "-h"
Show command help.
.IP "-l"
40
List the comments in the ogg vorbis file.
41
.IP "-q"
42
Quiet mode.  No messages are displayed.
43 44
.IP "-t 'tag=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.
45
.IP "-w"
46
Replace comments with the new set given either on the command line with -t or from a file with -c.
Conrad Parker's avatar
Conrad Parker committed
47 48
.IP "-R"
Read and write comments in utf8, rather than converting to the user's character set.
49 50

.\" Examples go here
51 52 53 54 55 56 57 58 59
.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
Conrad Parker's avatar
Conrad Parker committed
60
    [edit the comments in file.txt to your satisfaction]
61 62 63 64 65 66 67
    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

.SH SEE ALSO
68
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.
69 70 71 72 73 74

.SH AUTHORS

.TP
Program Authors:
.br
75
Michael Smith <msmith@xiph.org>
76
.br
77
Ralph Giles <giles@xiph.org>
78 79 80 81 82 83
.br

.TP
Manpage Author:
.br
Christopher L Cheney <ccheney@debian.org>