vorbiscomment.1 1.77 KB
Newer Older
1 2 3
.\" Process this file with
.\" groff -man -Tascii vorbiscomment.1
.\"
4
.TH VORBISCOMMENT 1 "December 24, 2001" Xiphophorus "Vorbis Tools"
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

.SH NAME
vorbiscomment \- edits Ogg Vorbis comments

.SH SYNOPSIS
.B vorbiscomment
.RB [ -l ]
.I file.ogg
.br
.B vorbiscomment
.B -a
.B [ -t \*(lqtag=value\*(rq ]
.I in.ogg
.I out.ogg
.br
.B vorbiscomment
.B -w
.I in.ogg
.I out.ogg

.SH DESCRIPTION
.B vorbiscomment
27
reads, modifies, and appends Ogg Vorbis audio file metadata tags.
28 29 30

.SH OPTIONS
.IP "-a"
31
Append comments.
32 33
.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.
34 35 36
.IP "-h"
Show command help.
.IP "-l"
37
List the comments in the ogg vorbis file.
38
.IP "-q"
39
Quiet mode.  No messages are displayed.
40 41
.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.
42
.IP "-w"
43
Replace comments with the new set given either on the command line with -t or from a file with -c.
44 45

.\" Examples go here
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
.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 statisfaction]
    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
63
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.
64 65 66 67 68 69 70 71

.SH AUTHORS

.TP
Program Authors:
.br
Michael Smith <msmith@labyrinth.net.au>
.br
72
Ralph Giles <giles@xiph.org>
73 74 75 76 77 78
.br

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