Commit 0fbeeda3 authored by Ralph Giles's avatar Ralph Giles

Flesh out the manpage a bit. Could still use more work.

svn path=/trunk/vorbis-tools/; revision=2906
parent 4bafa71c
.\" Process this file with .\" Process this file with
.\" groff -man -Tascii vorbiscomment.1 .\" groff -man -Tascii vorbiscomment.1
.\" .\"
.TH VORBISCOMMENT 1 "December 21, 2001" Xiphophorus "Vorbis Tools" .TH VORBISCOMMENT 1 "December 24, 2001" Xiphophorus "Vorbis Tools"
.SH NAME .SH NAME
vorbiscomment \- edits Ogg Vorbis comments vorbiscomment \- edits Ogg Vorbis comments
...@@ -24,25 +24,43 @@ vorbiscomment \- edits Ogg Vorbis comments ...@@ -24,25 +24,43 @@ vorbiscomment \- edits Ogg Vorbis comments
.SH DESCRIPTION .SH DESCRIPTION
.B vorbiscomment .B vorbiscomment
reads, modifies, and appends Ogg Vorbis audio files tags. reads, modifies, and appends Ogg Vorbis audio file metadata tags.
.SH OPTIONS .SH OPTIONS
.IP "-a" .IP "-a"
Append comments. Append comments.
.IP "-c" .IP "-c commentfile"
Take comments from a file. 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.
.IP "-h" .IP "-h"
Show command help. Show command help.
.IP "-l" .IP "-l"
List the comments. List the comments in the ogg vorbis file.
.IP "-q" .IP "-q"
Quiet mode. No messages are displayed. Quiet mode. No messages are displayed.
.IP "-t tag=value" .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.
.IP "-w" .IP "-w"
Modify comments. Replace comments with the new set given either on the command line with -t or from a file with -c.
.\" .SH EXAMPLES
.\" Examples go here .\" 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 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
See http://xiph.org/ogg/vorbis/doc/vcomment.html for documentation on the Ogg Vorbis tag format, including a suggested list of canonical tag names.
.SH AUTHORS .SH AUTHORS
...@@ -51,7 +69,7 @@ Program Authors: ...@@ -51,7 +69,7 @@ Program Authors:
.br .br
Michael Smith <msmith@labyrinth.net.au> Michael Smith <msmith@labyrinth.net.au>
.br .br
Ralph Giles <giles@ashlu.bc.ca> Ralph Giles <giles@xiph.org>
.br .br
.TP .TP
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment